From 4f8cb35f9a8b0e939bbf28b9d101188d84995532 Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Fri, 14 Jun 2019 02:14:14 +0300
Subject: [PATCH 1/5] Documentation

---
 README.md | 39 +++------------------------------------
 1 file changed, 3 insertions(+), 36 deletions(-)

diff --git a/README.md b/README.md
index 599355c..61d3803 100644
--- a/README.md
+++ b/README.md
@@ -27,42 +27,9 @@ The **trains-server's** code is freely available [here](https://github.com/alleg
 
 ## System diagram
 
-<pre>
- TRAINS-server
- +--------------------------------------------------------------------+
- |                                                                    |
- |   Server Docker                   Elastic Docker     Mongo Docker  |
- |  +-------------------------+     +---------------+  +------------+ |
- |  |     Pythonic Server     |     |               |  |            | |
- |  |   +-----------------+   |     | ElasticSearch |  |  MongoDB   | |
- |  |   |   WEB server    |   |     |               |  |            | |
- |  |   |   Port 8080     |   |     |               |  |            | |
- |  |   +--------+--------+   |     |               |  |            | |
- |  |            |            |     |               |  |            | |
- |  |   +--------+--------+   |     |               |  |            | |
- |  |   |   API server    +----------------------------+            | |
- |  |   |   Port 8008     +---------+               |  |            | |
- |  |   +-----------------+   |     +-------+-------+  +-----+------+ |
- |  |                         |             |                |        |
- |  |   +-----------------+   |         +---+----------------+------+ |
- |  |   |   File Server   +-------+     |    Host Storage           | |
- |  |   |   Port 8081     |   |   +-----+                           | |
- |  |   +-----------------+   |         +---------------------------+ |
- |  +------------+------------+                                       |
- +---------------|----------------------------------------------------+
-                 |HTTP
-                 +--------+
- GPU Machine              |
- +------------------------|-------------------------------------------+
- |     +------------------|--------------+                            |
- |     |  Training        |              |    +---------------------+ |
- |     |  Code        +---+------------+ |    | TRAINS configuration| |
- |     |              | TRAINS         | |    | ~/trains.conf       | |
- |     |              |                +------+                     | |
- |     |              +----------------+ |    +---------------------+ |
- |     +---------------------------------+                            |
- +--------------------------------------------------------------------+
-</pre>
+
+![Alt Text](https://github.com/allegroai/trains/blob/master/docs/system_diagram.png?raw=true)
+
 
 ## Installation
 

From 022fa7ba19af5e51cbe6ef6242083eb2be6e9972 Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Fri, 14 Jun 2019 02:17:46 +0300
Subject: [PATCH 2/5] Documentation

---
 README.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 61d3803..508ca24 100644
--- a/README.md
+++ b/README.md
@@ -1,6 +1,6 @@
 # TRAINS Server
 
-##  Automagical Version Control & Experiment Manager for AI
+##  Auto-Magical Experiment Manager & Version Control for AI
 
 [![GitHub license](https://img.shields.io/badge/license-SSPL-green.svg)](https://img.shields.io/badge/license-SSPL-green.svg)
 [![GitHub version](https://img.shields.io/github/release-pre/allegroai/trains-server.svg)](https://img.shields.io/github/release-pre/allegroai/trains-server.svg)

From 4af3c65e5d537f079a2de0ba274241db51f1750a Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Fri, 14 Jun 2019 02:20:33 +0300
Subject: [PATCH 3/5] Add "Not supported on mobile devices" warning

---
 webserver/static/styles/index.css | 1 +
 webserver/templates/login.html    | 6 ++++++
 2 files changed, 7 insertions(+)

diff --git a/webserver/static/styles/index.css b/webserver/static/styles/index.css
index 7925c56..3d6fe58 100644
--- a/webserver/static/styles/index.css
+++ b/webserver/static/styles/index.css
@@ -30,6 +30,7 @@ body {
 }
 
 .mobile-warn {
+  font-size: 40px;
   display: none;
 }
 
diff --git a/webserver/templates/login.html b/webserver/templates/login.html
index 7d32ff6..1b93461 100644
--- a/webserver/templates/login.html
+++ b/webserver/templates/login.html
@@ -2,6 +2,10 @@
 
 {% block head %}
            <script charset="utf-8">
+function acknowlage() {
+  var div = document.getElementById('mobile-warn');
+  div.className = div.className.slice(0, div.className.length - 5);
+}
 function mobilecheck() {
   var check = false;
   (function(a){if(/(android|bb\d+|meego).+mobile|avantgo|bada\/|blackberry|blazer|compal|elaine|fennec|hiptop|iemobile|ip(hone|od)|iris|kindle|lge |maemo|midp|mmp|mobile.+firefox|netfront|opera m(ob|in)i|palm( os)?|phone|p(ixi|re)\/|plucker|pocket|psp|series(4|6)0|symbian|treo|up\.(browser|link)|vodafone|wap|windows ce|xda|xiino/i.test(a)||/1207|6310|6590|3gso|4thp|50[1-6]i|770s|802s|a wa|abac|ac(er|oo|s\-)|ai(ko|rn)|al(av|ca|co)|amoi|an(ex|ny|yw)|aptu|ar(ch|go)|as(te|us)|attw|au(di|\-m|r |s )|avan|be(ck|ll|nq)|bi(lb|rd)|bl(ac|az)|br(e|v)w|bumb|bw\-(n|u)|c55\/|capi|ccwa|cdm\-|cell|chtm|cldc|cmd\-|co(mp|nd)|craw|da(it|ll|ng)|dbte|dc\-s|devi|dica|dmob|do(c|p)o|ds(12|\-d)|el(49|ai)|em(l2|ul)|er(ic|k0)|esl8|ez([4-7]0|os|wa|ze)|fetc|fly(\-|_)|g1 u|g560|gene|gf\-5|g\-mo|go(\.w|od)|gr(ad|un)|haie|hcit|hd\-(m|p|t)|hei\-|hi(pt|ta)|hp( i|ip)|hs\-c|ht(c(\-| |_|a|g|p|s|t)|tp)|hu(aw|tc)|i\-(20|go|ma)|i230|iac( |\-|\/)|ibro|idea|ig01|ikom|im1k|inno|ipaq|iris|ja(t|v)a|jbro|jemu|jigs|kddi|keji|kgt( |\/)|klon|kpt |kwc\-|kyo(c|k)|le(no|xi)|lg( g|\/(k|l|u)|50|54|\-[a-w])|libw|lynx|m1\-w|m3ga|m50\/|ma(te|ui|xo)|mc(01|21|ca)|m\-cr|me(rc|ri)|mi(o8|oa|ts)|mmef|mo(01|02|bi|de|do|t(\-| |o|v)|zz)|mt(50|p1|v )|mwbp|mywa|n10[0-2]|n20[2-3]|n30(0|2)|n50(0|2|5)|n7(0(0|1)|10)|ne((c|m)\-|on|tf|wf|wg|wt)|nok(6|i)|nzph|o2im|op(ti|wv)|oran|owg1|p800|pan(a|d|t)|pdxg|pg(13|\-([1-8]|c))|phil|pire|pl(ay|uc)|pn\-2|po(ck|rt|se)|prox|psio|pt\-g|qa\-a|qc(07|12|21|32|60|\-[2-7]|i\-)|qtek|r380|r600|raks|rim9|ro(ve|zo)|s55\/|sa(ge|ma|mm|ms|ny|va)|sc(01|h\-|oo|p\-)|sdk\/|se(c(\-|0|1)|47|mc|nd|ri)|sgh\-|shar|sie(\-|m)|sk\-0|sl(45|id)|sm(al|ar|b3|it|t5)|so(ft|ny)|sp(01|h\-|v\-|v )|sy(01|mb)|t2(18|50)|t6(00|10|18)|ta(gt|lk)|tcl\-|tdg\-|tel(i|m)|tim\-|t\-mo|to(pl|sh)|ts(70|m\-|m3|m5)|tx\-9|up(\.b|g1|si)|utst|v400|v750|veri|vi(rg|te)|vk(40|5[0-3]|\-v)|vm40|voda|vulc|vx(52|53|60|61|70|80|81|83|85|98)|w3c(\-| )|webc|whit|wi(g |nc|nw)|wmlb|wonu|x700|yas\-|your|zeto|zte\-/i.test(a.substr(0,4))) check = true;})(navigator.userAgent||navigator.vendor||window.opera);
@@ -20,6 +24,8 @@ document.addEventListener('DOMContentLoaded', function(){
 {% endblock %}
 {% block popup %}
             <div id="mobile-warn" class="alert alert-warning mobile-warn" role="alert">
+                 <button type="button" class="close" data-dismiss="alert" aria-label="Close" onclick="acknowlage()">
+                     <span aria-hidden="true">&times;</span></button>
                 <strong>Notice!</strong>  The Web-App is not yet optimized for mobile devices.
             </div>
             <form role="form" class='form-horizontal' name="login_form" action="/create_user" method="post">

From c8f2b2b3193d03562c2685a228ea8368eec9ab72 Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Sun, 16 Jun 2019 22:41:49 +0300
Subject: [PATCH 4/5] Removed comments

---
 server/services/events.py | 2 --
 1 file changed, 2 deletions(-)

diff --git a/server/services/events.py b/server/services/events.py
index 23c2ecd..6da616f 100644
--- a/server/services/events.py
+++ b/server/services/events.py
@@ -355,7 +355,6 @@ def get_task_plots_v1_7(call, company_id, req_model):
     #     last_iter_count=iters,
     #     scroll_id=scroll_id)
 
-    # the following is a hack for Bosch, requested by Moshik
     # get last 10K events by iteration and group them by unique metric+variant, returning top events for combination
     result = event_bll.get_task_events(
         company_id, task_id,
@@ -414,7 +413,6 @@ def get_debug_images_v1_7(call, company_id, req_model):
     #     last_iter_count=iters,
     #     scroll_id=scroll_id)
 
-    # the following is a hack for Bosch, requested by Moshik
     # get last 10K events by iteration and group them by unique metric+variant, returning top events for combination
     result = event_bll.get_task_events(
         company_id, task_id,

From c70cbe04c138a0504b6100960434c5ee14bb6b0b Mon Sep 17 00:00:00 2001
From: allegroai <>
Date: Mon, 17 Jun 2019 00:55:05 +0300
Subject: [PATCH 5/5] Documentation

---
 README.md | 38 +++++++++++++++++++++++++-------------
 1 file changed, 25 insertions(+), 13 deletions(-)

diff --git a/README.md b/README.md
index 508ca24..9553cd8 100644
--- a/README.md
+++ b/README.md
@@ -8,16 +8,18 @@
 
 ## Introduction
 
-The **trains-server** is the infrastructure for [TRAINS](https://github.com/allegroai/trains).
+The **trains-server** is the backend service infrastructure for [TRAINS](https://github.com/allegroai/trains).
 It allows multiple users to collaborate and manage their experiments.
+By default, TRAINS is set up to work with the TRAINS demo server, which is open to anyone and resets periodically. 
+In order to host your own server, you will need to install **trains-server** and point TRAINS to it.
 
-The **trains-server** contains the following components:
+**trains-server** contains the following components:
 
-* the Web-App which is a single-page UI for experiment management and browsing
-* a REST interface for:
-    * documenting and logging experiment information, statistics and results
-    * querying experiments history, logs and results
-* a locally-hosted file server for storing images and models making them easily accessible using the Web-App
+* The TRAINS Web-App, a single-page UI for experiment management and browsing
+* RESTful API for:
+    * Documenting and logging experiment information, statistics 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
 
 You can quickly setup your **trains-server** using a pre-built Docker image (see [Installation](#installation)).
 
@@ -34,6 +36,8 @@ The **trains-server's** code is freely available [here](https://github.com/alleg
 ## Installation
 
 This section contains the instructions to setup and launch a pre-built Docker image for the **trains-server**.
+This is the quickest way to get started with your own server. 
+Alternatively, you can build the entire trains-server architecture using the code available in our repositories.
 
 **Please Note**:
 * This Docker image was tested with Linux, only. For Windows users, we recommend running the server
@@ -135,7 +139,7 @@ Elastic requires that `vm.max_map_count` is at least 262144 (see [Production mod
 #### Step 5: Choose a Data Directory
 
 You must choose a directory on your system in which all data maintained by the **trains-server** is stored,
-create that directory, and set its permissions. The data stored in that directory includes the database, uploaded files and logs.
+Create a directory, and set its permissions. The data stored in this directory will include the database, uploaded files and logs.
 
 For example, if your data directory is `/opt/trains`, then use the following command:
 
@@ -176,9 +180,9 @@ After the **trains-server** Dockers are up, the following are available:
 
 ### Configuring **trains**
 
-Once you've installed the **trains-server**, please make sure to configure **trains** to use your locally installed server (and not the demo server).
+Once you have installed the **trains-server**, make sure to configure **trains** to use your locally installed server (and not the demo server).
 
-If you've already installed **trains**, run the `trains-init` command for an interactive setup or edit your `trains.conf` file and make sure the `api.host` value is configured as follows:
+If you have already installed **trains**, run the `trains-init` command for an interactive setup or edit your `trains.conf` file and make sure the `api.host` value is configured as follows:
 
 ```
 api {
@@ -188,6 +192,12 @@ api {
 
 See [Installing and Configuring TRAINS](https://github.com/allegroai/trains#installing-and-configuring-trains) for more details.
 
+## What next?
+
+Now that the **trains-server** is installed, and TRAINS is configured to use it, 
+you can [use](https://github.com/allegroai/trains#using-trains) TRAINS in your experiments and view them in the web server, 
+for example http://localhost:8080
+
 ## Upgrade
 
 We are constantly updating, improving and adding to the **trains-server**.
@@ -226,8 +236,10 @@ When we release a new version and include a new pre-built Docker image for it, u
 
 [Server Side Public License v1.0](https://github.com/mongodb/mongo/blob/master/LICENSE-Community.txt)
 
-**trains-server** relies *heavily* on both [MongoDB](https://github.com/mongodb/mongo) and [ElasticSearch](https://github.com/elastic/elasticsearch).
-With the recent changes in both MongoDB's and ElasticSearch's OSS license, we feel it is our job as a community to support the projects we love and cherish.
-We feel the cause for the license change in both cases is more than just, and chose [SSPL](https://www.mongodb.com/licensing/server-side-public-license) because it is the more general and flexible of the two.
+**trains-server** relies on both [MongoDB](https://github.com/mongodb/mongo) and [ElasticSearch](https://github.com/elastic/elasticsearch).
+With the recent changes in both MongoDB's and ElasticSearch's OSS license, we feel it is our responsibility as a 
+member of the community to support the projects we love and cherish.
+We believe the cause for the license change in both cases is more than just, 
+and chose [SSPL](https://www.mongodb.com/licensing/server-side-public-license) because it is the more general and flexible of the two licenses.
 
 This is our way to say - we support you guys!