ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-03-03 18:52:12 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fix docstrings

Browse Source
This commit is contained in:
Alex Burlacu 2023-03-29 19:01:48 +03:00
parent fc8435e26b
commit cc843f6afa
2 changed files with 8 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
clearml/model.py
View File

@ -1342,8 +1342,12 @@ class Model(BaseModel):
:param project_name: Optional, filter based project name string, if not given query models from all projects :param project_name: Optional, filter based project name string, if not given query models from all projects
:param model_name: Optional Model name as shown in the model artifactory :param model_name: Optional Model name as shown in the model artifactory
:param tags: Optional filter models based on list of tags, example: ['production', 'verified', '-qa'] :param tags: Filter based on the requested list of tags (strings)
Notice use '-' prefix to filter out tags. To exclude a tag add "-" prefix to the tag. Example: ['production', 'verified', '-qa']
To include All tags (instead of the default Any behaviour) use "__$all" as the first string, example:
["__$all", "best", "model", "ever"]
To combine All tags and exclude a list of tags use "__$not" before the excluded tags, example:
["__$all", "best", "model", "ever", "__$not", "internal", "test"]
:param only_published: If True, only return published models. :param only_published: If True, only return published models.
:param include_archived: If True, return archived models. :param include_archived: If True, return archived models.
:param max_results: Optional return the last X models, :param max_results: Optional return the last X models,

4
clearml/task.py
View File

@ -1021,9 +1021,9 @@ class Task(_Task):
:param str task_name: task name (str) in within the selected project :param str task_name: task name (str) in within the selected project
Return any partial match of task_name, regular expressions matching is also supported Return any partial match of task_name, regular expressions matching is also supported
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)
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: To include All tags (instead of the default All behaviour) use "__$all" as the first string, example:
["__$all", "best", "experiment", "ever"] ["__$all", "best", "experiment", "ever"]
To combine All tags and exclude a list of tags use "__$not" before the excluded tags, example: To combine All tags and exclude a list of tags use "__$not" before the excluded tags, example:
["__$all", "best", "experiment", "ever", "__$not", "internal", "test"] ["__$all", "best", "experiment", "ever", "__$not", "internal", "test"]