ClearML/clearml-server
1
0
Fork 0
mirror of https://github.com/clearml/clearml-server synced 2025-02-07 13:33:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Documentation

Browse Source
This commit is contained in:
allegroai 2019-08-08 11:58:19 +03:00
parent 0aa5694b58
commit 68c7f307a2
3 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -22,9 +22,9 @@ In order to host your own server, you will need to install **trains-server** and
* Querying experiments history, logs and results * Querying experiments history, logs and results
* Locally-hosted file server for storing images and models making them easily accessible using the Web-App * Locally-hosted file server for storing images and models making them easily accessible using the Web-App
You can quickly setup your **trains-server** using a pre-built Docker image (see [Installation](#installation)). You can quickly setup your **trains-server** using a pre-built Docker image (see [Installation](#installation)) or pre-installed machine image [AMI](#ami).
When new releases are available, you can upgrade your pre-built Docker image (see [Upgrade](#upgrade)). When new releases are available, you can upgrade your pre-built Docker image (see [Upgrade](#upgrade)) or simply restart the machine with the [auto-update AMI](docs/install_aws.md#autoupdate).
## System diagram ## System diagram
@ -42,7 +42,7 @@ For details and instructions, see [TRAINS-server: AWS pre-installed images](docs
Use our pre-built Docker image for easy deployment in Linux and Mac OS X. Use our pre-built Docker image for easy deployment in Linux and Mac OS X.
For Windows, we recommend installing our pre-built Docker image on a Linux virtual machine. For Windows, we recommend installing our pre-built Docker image on a Linux virtual machine.
1. Setup Docker (Full details [Setup Docker Service](docs/docker_setup.md)) 1. Setup Docker (Full details [Setup Docker Service Manually](docs/docker_setup.md))
Make sure port 8080/8081/8008 are available for the `trains-server` services Make sure port 8080/8081/8008 are available for the `trains-server` services
@ -91,7 +91,7 @@ For Windows, we recommend installing our pre-built Docker image on a Linux virtu
``` ```
* Manually * Manually
See [TRAINS-server: Launching Docker Containers Manually](docs/manual_docker.md)) for instructions. See [TRAINS-server: Launching Docker Containers Manually](docs/docker_setup.md#launch) for instructions.
1. Your server is now running on [http://localhost:8080](http://localhost:8080) and the following ports are available: 1. Your server is now running on [http://localhost:8080](http://localhost:8080) and the following ports are available:
@ -167,7 +167,7 @@ To restart the **trains-server**, you must first stop and remove the containers,
$ docker-compose down $ docker-compose down
$ docker-compose up $ docker-compose up
1. Manually restarting dockers [instructions](docs/manual_docker.md). 1. Manually restarting dockers [instructions](docs/docker_setup.md#launch).
## Configuring **TRAINS** client ## Configuring **TRAINS** client
@ -189,7 +189,7 @@ to use your locally installed server (and not the demo server).
files_server: "http://localhost:8081" files_server: "http://localhost:8081"
} }
See [Installing and Configuring TRAINS](https://github.com/allegroai/trains#installing-and-configuring-trains) for more details. See [Installing and Configuring TRAINS](https://github.com/allegroai/trains#configuration) for more details.
## What next? ## What next?

2
docs/docker_setup.md
View File

@ -108,7 +108,7 @@ For example, if your data directory is `/opt/trains`, then use the following com
sudo chown -R 1000:1000 /opt/trains sudo chown -R 1000:1000 /opt/trains
``` ```
## TRAINS-server: Manually Launching Docker Containers ## TRAINS-server: Manually Launching Docker Containers <a name="launch"></a>
You can manually launch the Docker containers using the following commands. You can manually launch the Docker containers using the following commands.

2
docs/install_aws.md
View File

@ -25,7 +25,7 @@ In order to upgrade **trains-server** on an existing EC2 instance based on one o
The following sections provide a list containing AMI Image ID per region for each released **trains-server** version. The following sections provide a list containing AMI Image ID per region for each released **trains-server** version.
### Latest Version AMI ### Latest Version AMI <a name="autoupdate"></a>
**For easier upgrades: The following AMI automatically update to the latest release every reboot** **For easier upgrades: The following AMI automatically update to the latest release every reboot**
* **eu-north-1** : ami-0a8e95b10d114f76c * **eu-north-1** : ami-0a8e95b10d114f76c