Skip to content

Commit 0b99c6c

Browse files
authored
Add UI basics section (#1004)
1 parent 0bcac8b commit 0b99c6c

9 files changed

Lines changed: 55 additions & 3 deletions

File tree

903 KB
Loading
236 KB
Loading
279 KB
Loading
204 KB
Loading
408 KB
Loading

docs/source/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@
1515
quick_start/getting_started.md
1616
quick_start/SDK_basics.md
1717
quick_start/QL_basics.md
18+
quick_start/UI_basics.md
1819
quick_start/integrations.md
1920

2021
.. toctree::

docs/source/overview.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@ Aim users track 1000s of training runs and sometimes more than 100s of metrics p
3333
Aim enables a powerful pythonic query language to filter through metadata.
3434
It's like a python if statement over everything you have tracked. You can use this on all explorer screens.
3535

36-
37-
3836
### Runs explorer
3937
Runs explorer will help you to hollistically view all your runs, each metric last tracked values and tracked hyperparameters.
4038

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
## UI Basics
2+
3+
Aim enables powerful UI to explore logged ML runs and metadata.
4+
5+
### Runs explorer
6+
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.
7+
8+
Features:
9+
- Full Research context at hand
10+
- Search runs by date, experiment, hash, tag or parameters
11+
- Search by run/experiment
12+
13+
<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/runs.png" />
14+
15+
### Metrics explorer
16+
Metrics explorer helps you to compare 100s of metrics within a few clicks.
17+
It helps to save lots of time compared to other open-source experiment tracking tools.
18+
19+
Features:
20+
- Easily query any metric
21+
- Group by any parameter
22+
- Divide into subplots
23+
- Aggregate grouped metrics (by conf. interval, std. dev., std. err., min/max)
24+
- Apply smoothing
25+
- Change scale of the axes (linear or log)
26+
- Align metrics by time, epoch or another metric
27+
28+
<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/metrics.png" />
29+
30+
### Params explorer
31+
Params explorer enables a parallel coordinates view for metrics and params. Very helpful when doing hyperparameter search.
32+
33+
Features:
34+
- Easily query any metrics and params
35+
- Group runs or divide into subplots
36+
- Apply chart indicator to see correlations
37+
38+
<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/params.png" />
39+
40+
### Single run page
41+
Explore all the metadata associated with a run on the single run page.
42+
It's accessible from all the tables and tooltips.
43+
44+
Features:
45+
- See all the logged params of a run
46+
- See all the tracked metrics(including system metrics)
47+
48+
<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/single_run.png" />
49+
50+
### Images explorer (coming soon...)
51+
Track intermediate images and search, compare them on the Images Explorer.
52+
53+
<img style="border: 1px solid #1d2253" src="../_static/images/ui_basics/images.png" />

docs/source/quick_start/getting_started.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ Start up the Aim UI to observe the run:
5252
aim up
5353
```
5454

55-
See more details in UI basics.
55+
See more details in [UI basics](./UI_basics.html).
5656

5757
### Query metadata via SDK
5858

0 commit comments

Comments
 (0)