ClearML/clearml
1
0
Fork 0
mirror of https://github.com/clearml/clearml synced 2025-03-03 02:32:11 +00:00
Code Issues Actions1 Packages Projects Releases Wiki Activity

Fix docstrings

Browse Source
This commit is contained in:
allegroai 2022-10-14 10:12:49 +03:00
parent 5ece83fe9f
commit a0e19d833d
4 changed files with 40 additions and 40 deletions
clearml
automation
parameters.py
backend_interface/task
task.py
model.pytask.py

8
clearml/automation/parameters.py
View File

@ -323,15 +323,15 @@ class ParameterSet(Parameter):
.. code-block:: javascript
[ {'opt1': 10, 'arg2': 20, 'arg2': 30},
{'opt2': 11, 'arg2': 22, 'arg2': 33}, ]
[ {"opt1": 10, "arg2": 20, "arg2": 30},
{"opt2": 11, "arg2": 22, "arg2": 33} ]
Two complex combination each one sampled from a different range:
.. code-block:: javascript
[ {'opt1': UniformParameterRange('arg1',0,1) , 'arg2': 20},
{'opt2': UniformParameterRange('arg1',11,12), 'arg2': 22},]
[ {"opt1": UniformParameterRange('arg1',0,1) , "arg2": 20},
{"opt2": UniformParameterRange('arg1',11,12), "arg2": 22},]
"""
super(ParameterSet, self).__init__(name=None)
self.values = parameter_combinations

28
clearml/backend_interface/task/task.py
View File

@ -1703,9 +1703,9 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
.. code-block:: py
{'title': {'series': {
'x': [0, 1 ,2],
'y': [10, 11 ,12],
{"title": {"series": {
"x": [0, 1 ,2],
"y": [10, 11 ,12]
}}}
:param int max_samples: Maximum samples per series to return. Default is 0 returning all scalars.
@ -1750,17 +1750,17 @@ class Task(IdObjectBase, AccessMixin, SetupUploadMixin):
.. code-block:: py
[{
'timestamp': 1636921296370,
'type': 'plot',
'task': '0ce5e89bbe484f428e43e767f1e2bb11',
'iter': 0,
'metric': 'Manual Reporting',
'variant': 'Just a plot',
'plot_str': '{"data": [{"type": "scatter", "mode": "markers", "name": null,
"x": [0.2620246750155817], "y": [0.2620246750155817]}]}',
'@timestamp': '2021-11-14T20:21:42.387Z',
'worker': 'machine-ml',
'plot_len': 6135,
"timestamp": 1636921296370,
"type": "plot",
"task": "0ce5e89bbe484f428e43e767f1e2bb11",
"iter": 0,
"metric": "Manual Reporting",
"variant": "Just a plot",
"plot_str": "{'data': [{'type': 'scatter', 'mode': 'markers', 'name': null,
'x': [0.2620246750155817], 'y': [0.2620246750155817]}]}",
"@timestamp": "2021-11-14T20:21:42.387Z",
"worker": "machine-ml",
"plot_len": 6135,
},]
:param int max_iterations: Maximum number of historic plots (iterations from end) to return.
:return: list: List of dicts, each one represents a single plot

24
clearml/model.py
View File

@ -806,8 +806,8 @@ class InputModel(Model):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:param str name: The name of the newly imported model. (Optional)
:param str project: The project name to add the model into. (Optional)
@ -998,8 +998,8 @@ class InputModel(Model):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:return: An empty model object.
@ -1187,8 +1187,8 @@ class OutputModel(BaseModel):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:return: The label enumeration.
@ -1208,8 +1208,8 @@ class OutputModel(BaseModel):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
"""
@ -1254,8 +1254,8 @@ class OutputModel(BaseModel):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:param str name: The name for the newly created model. (Optional)
@ -1681,8 +1681,8 @@ class OutputModel(BaseModel):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:return:

20
clearml/task.py
View File

@ -377,7 +377,7 @@ class Task(_Task):
.. code-block:: py
auto_connect_arg_parser={'do_not_include_me': False, }
auto_connect_arg_parser={"do_not_include_me": False, }
.. code-block:: py
@ -1633,8 +1633,8 @@ class Task(_Task):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
:return: The label enumeration dictionary (JSON).
@ -2053,8 +2053,8 @@ class Task(_Task):
.. code-block:: javascript
{
'background': 0,
'person': 1
"background": 0,
"person": 1
}
"""
super(Task, self).set_model_label_enumeration(enumeration=enumeration)
@ -2103,11 +2103,11 @@ class Task(_Task):
.. code-block:: javascript
{
'title': {
'series': {
'last': 0.5,
'min': 0.1,
'max': 0.9
"title": {
"series": {
"last": 0.5,
"min": 0.1,
"max": 0.9
}
}
}