Add UI basics section (#1004)

aimhubio · Nov 12, 2021 · 0b99c6c · 0b99c6c
1 parent 0bcac8b
commit 0b99c6c
Show file tree

Hide file tree

Showing 9 changed files with 55 additions and 3 deletions.
diff --git a/docs/source/_static/images/ui_basics/images.png b/docs/source/_static/images/ui_basics/images.png
diff --git a/docs/source/_static/images/ui_basics/metrics.png b/docs/source/_static/images/ui_basics/metrics.png
diff --git a/docs/source/_static/images/ui_basics/params.png b/docs/source/_static/images/ui_basics/params.png
diff --git a/docs/source/_static/images/ui_basics/runs.png b/docs/source/_static/images/ui_basics/runs.png
diff --git a/docs/source/_static/images/ui_basics/single_run.png b/docs/source/_static/images/ui_basics/single_run.png
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -15,6 +15,7 @@
    quick_start/getting_started.md
    quick_start/SDK_basics.md
    quick_start/QL_basics.md
+   quick_start/UI_basics.md
    quick_start/integrations.md
 
 .. toctree::

diff --git a/docs/source/overview.md b/docs/source/overview.md
@@ -33,8 +33,6 @@ Aim users track 1000s of training runs and sometimes more than 100s of metrics p
 Aim enables a powerful pythonic query language to filter through metadata.
 It's like a python if statement over everything you have tracked. You can use this on all explorer screens.
 
-
-
 ### Runs explorer
 Runs explorer will help you to hollistically view all your runs, each metric last tracked values and tracked hyperparameters.
 

diff --git a/docs/source/quick_start/UI_basics.md b/docs/source/quick_start/UI_basics.md
@@ -0,0 +1,53 @@
+## UI Basics
+
+Aim enables powerful UI to explore logged ML runs and metadata.
+
+### Runs explorer
+Runs explorer will help you to hollistically view all your [runs](./SDK_basics.html#create-a-run), each metric last tracked values and tracked hyperparameters.
+
+Features:
+- Full Research context at hand
+- Search runs by date, experiment, hash, tag or parameters
+- Search by run/experiment
+
+<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/runs.png" />
+
+### Metrics explorer
+Metrics explorer helps you to compare 100s of metrics within a few clicks.
+It helps to save lots of time compared to other open-source experiment tracking tools.
+
+Features:
+- Easily query any metric
+- Group by any parameter
+- Divide into subplots
+- Aggregate grouped metrics (by conf. interval, std. dev., std. err., min/max)
+- Apply smoothing
+- Change scale of the axes (linear or log)
+- Align metrics by time, epoch or another metric
+
+<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/metrics.png" />
+
+### Params explorer
+Params explorer enables a parallel coordinates view for metrics and params. Very helpful when doing hyperparameter search.
+
+Features:
+- Easily query any metrics and params
+- Group runs or divide into subplots
+- Apply chart indicator to see correlations
+
+<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/params.png" />
+
+### Single run page
+Explore all the metadata associated with a run on the single run page.
+It's accessible from all the tables and tooltips.
+
+Features:
+- See all the logged params of a run
+- See all the tracked metrics(including system metrics)
+
+<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/single_run.png" />
+
+### Images explorer (coming soon...)
+Track intermediate images and search, compare them on the Images Explorer.
+
+<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/images.png" />
diff --git a/docs/source/quick_start/getting_started.md b/docs/source/quick_start/getting_started.md
@@ -52,7 +52,7 @@ Start up the Aim UI to observe the run:
 aim up
 ```
 
-See more details in UI basics.
+See more details in [UI basics](./UI_basics.html).
 
 ### Query metadata via SDK