Search syntax documentation #432
Conversation
docs/search_syntax.md
Outdated
| | ```duration``` | Run duration in seconds | ```numeric```| | ||
| | ```created_at``` | Run creation datetime | ```numeric``` | | ||
| | ```finalized_at``` | Run end datetime | ```numeric``` | | ||
| | ```metrics``` | Set of run metrics | ```dictionary``` | |
There was a problem hiding this comment.
can these be given table-like format in the markdown source, too? ie, lining up the columns
docs/search_syntax.md
Outdated
| ### Run parameters | ||
| Run parameters could be accessed via attributes. | ||
| ```python | ||
| run.hparams.param1 >= 64 |
There was a problem hiding this comment.
typo? hparams? should be just params.
There was a problem hiding this comment.
Actually should be just param1 I'll fix that
| @@ -0,0 +1,228 @@ | |||
| # Search Syntax Documentation | |||
|
|
|||
| ## Introduction | |||
There was a problem hiding this comment.
what do you think about to have a glossary with links so you can easily jump to any section? not a requirement but just a thought if I want to quickly check special section.
There was a problem hiding this comment.
Yes! I'll add it
docs/search_syntax.md
Outdated
| ### Filter Metrics by run | ||
| You can also filter the metrics by combining metric attributes with run attributes. | ||
|
|
||
| Showing the metrics with the last value greater than 6 belonging to a run with the name that starts with marvelous. | ||
|
|
||
|  |
There was a problem hiding this comment.
what do you think to a like a complex query with different operators and cases?
docs/search_syntax.md
Outdated
| ## Operations | ||
|
|
||
| ### String operations | ||
| For the ```string``` attributes you can use the following comparing operator: |
There was a problem hiding this comment.
| For the ```string``` attributes you can use the following comparing operator: | |
| For the ```string``` attributes you can use the following comparison operator: |
(there are multiples places where this comment applies)
docs/search_syntax.md
Outdated
| - ``` <= ``` | ||
|
|
||
| ### Boolean operations | ||
| For the ```boolean``` attributes you can use the following comparing operator: |
There was a problem hiding this comment.
Please also document that having no operator or a unary operation also works for booleans, e.g. run.archived is the same as run.archived == True, and !run.archived is the same as run.archived == False
docs/search_syntax.md
Outdated
|
|
||
| ### Example with ```run.duration``` (numeric) | ||
|
|
||
| Select only the runs where the duration is exactly 111111111 |
There was a problem hiding this comment.
Use something more realistic, like 60
docs/search_syntax.md
Outdated
| ``` | ||
|
|
||
| ### Run parameters | ||
| Run parameters could be accessed via attributes. |
There was a problem hiding this comment.
| Run parameters could be accessed via attributes. | |
| Run parameters can be accessed via attributes. |
docs/search_syntax.md
Outdated
| Run parameters could be accessed via attributes. | ||
|  | ||
|
|
||
| ### Filtering Runs with Unset Attributes |
There was a problem hiding this comment.
| ### Filtering Runs with Unset Attributes | |
| ### Filtering Runs with Unset Parameters |
(there are multiples places where this comment applies)
docs/search_syntax.md
Outdated
| - ``` .match() ``` | ||
| - ``` .search() ``` |
There was a problem hiding this comment.
| - ``` .match() ``` | |
| - ``` .search() ``` | |
| - ``` re.match() ``` | |
| - ``` re.search() ``` |
docs/search_syntax.md
Outdated
|
|
||
| - run.archived can be either True or False. | ||
| - The duration of run must be greater than 0. | ||
| - The run has to contain a metric named 'TestMetric' and is value of last must be greater than 2.5. |
There was a problem hiding this comment.
| - The run has to contain a metric named 'TestMetric' and is value of last must be greater than 2.5. | |
| - The run has to contain a metric named 'TestMetric' and its last recorded value must be greater than 2.5. |
docs/search_syntax.md
Outdated
| ## Introduction | ||
|
|
||
| This document provides an overview of the search syntax that users can utilize to filter metrics and runs. | ||
|
|
There was a problem hiding this comment.
We should start by introducing that the syntax is essentially Python "so it should feel pretty intuitive for most users", and then explain that we'll dive into more details about supported operations below.
docs/search_syntax.md
Outdated
|
|
||
|
|
||
| ## Search Runs | ||
| You can filter the runs using the following run attributes: |
There was a problem hiding this comment.
We should make it clear that these are attributes for the run object
docs/search_syntax.md
Outdated
| | ```metrics``` | Set of run metrics | ```dictionary``` | | ||
|
|
||
| ## Search Metrics | ||
| You can filter the metrics using the following metric attributes: |
There was a problem hiding this comment.
We should make it clear that these are attributes for the metric object
fixes #327