ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-01-31 17:17:00 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Improve Task.query_tasks()` docstring

Browse Source
This commit is contained in:
allegroai 2023-02-28 17:08:07 +02:00
parent 4585db0f0f
commit 5d027a335f
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
clearml/task.py
View File

@ -1018,6 +1018,10 @@ class Task(_Task):
If None is passed, returns all tasks within the project If None is passed, returns all tasks within the project
:param list tags: Filter based on the requested list of tags (strings) (Task must have all the listed tags) :param list tags: Filter based on the requested list of tags (strings) (Task must have all the listed tags)
To exclude a tag add "-" prefix to the tag. Example: ["best", "-debug"] To exclude a tag add "-" prefix to the tag. Example: ["best", "-debug"]
To include All tags (instead of the default Or) use "__$all" before the tags, example:
["__$all", "best", "experiment", "ever"]
To combine All tags and exclude a list of tags use "__$not" before the excluded tags, example:
["__$all", "best", "experiment", "ever", "__$not", "internal", "test"]
:param list additional_return_fields: Optional, if not provided return a list of Task IDs. :param list additional_return_fields: Optional, if not provided return a list of Task IDs.
If provided return dict per Task with the additional requested fields. If provided return dict per Task with the additional requested fields.
Example: ``returned_fields=['last_updated', 'user', 'script.repository']`` will return a list of dict: Example: ``returned_fields=['last_updated', 'user', 'script.repository']`` will return a list of dict: