From 68d13ba25eca02ddb15b4af501d1c0848cc147b4 Mon Sep 17 00:00:00 2001 From: allegroai <> Date: Fri, 14 Jun 2019 01:27:25 +0300 Subject: [PATCH] Documentation --- README.md | 10 ++++++---- docs/trains_examples.md | 4 ++++ 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 1662d85b..89efebca 100644 --- a/README.md +++ b/README.md @@ -101,7 +101,7 @@ TRAINS is composed of the following: * [TRAINS-server](https://github.com/allegroai/trains-server) * [Web-App](https://github.com/allegroai/trains-web) (web user interface) -* Python SDK (auto-magically connects your code, see [Using TRAINS](#using-trains-example)) +* Python SDK (auto-magically connects your code, see [Using TRAINS](#using-trains)) The following diagram illustrates the interaction of the [trains-server](https://github.com/allegroai/trains-server) and a GPU training machine using TRAINS @@ -122,8 +122,9 @@ and a GPU training machine using TRAINS trains-init -After installing and configuring, you can access your configuration file at `~/trains.conf`. -View a sample configuration file [here](https://github.com/allegroai/trains/blob/master/docs/trains.conf). +After installing and configuring, you can access your configuration file at `~/trains.conf` + +Sample configuration file available [here](https://github.com/allegroai/trains/blob/master/docs/trains.conf). ## Using TRAINS @@ -143,9 +144,10 @@ TRAINS Results page: https://demoapp.trainsai.io/projects/76e5e2d45e914f52880621fe64601e85/experiments/241f06ae0f5c4b27b8ce8b64890ce152/output/log ``` +*For more examples and use cases*, see [examples](https://github.com/allegroai/trains/blob/master/docs/trains_examples.md). + ![Alt Text](https://github.com/allegroai/trains/blob/master/docs/results_screenshots.gif?raw=true) -For more examples and use cases, see [examples](https://github.com/allegroai/trains/blob/master/docs/trains_examples.md). ## Who Supports TRAINS? diff --git a/docs/trains_examples.md b/docs/trains_examples.md index ce34ff64..c500c6d7 100644 --- a/docs/trains_examples.md +++ b/docs/trains_examples.md @@ -7,6 +7,10 @@ You can run these examples and view their results on the TRAINS Web-App. The examples are described below, including a link for the source code and expected results for each run. +* For each example, only two lines of TRAINS integration code, were added + + from trains import Task + task = Task.init(project_name=”examples”, task_name=”description”) ## Viewing experiment results