ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Rewrite model config example, fix configuration terminology (#45)

Browse Source
This commit is contained in:
pollfly
2021-08-22 15:23:48 +03:00
committed by GitHub
parent df935fa049
commit de1f0e559f
5 changed files with 37 additions and 24 deletions
Download Patch File Download Diff File Expand all files Collapse all files

43
docs/guides/reporting/model_config.md
View File

@@ -4,7 +4,7 @@ title: Configuring Models
The [model_config.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/model_config.py) example demonstrates
configuring a model and defining label enumeration. Connect the configuration and label enumeration to a Task and, once
connected, **ClearML** tracks any changes to them. When **ClearML** stores a model, in any framework, **ClearML** stores
connected, **ClearML** tracks any changes to them. When **ClearML** stores a model in any framework, **ClearML** stores
the configuration and label enumeration with it.
When the script runs, it creates an experiment named `Model configuration example`, which is associated with the `examples` project.
@@ -14,35 +14,41 @@ When the script runs, it creates an experiment named `Model configuration exampl
### Using a configuration file
Connect a configuration file to a Task by calling the [Task.connect_configuration](../../references/sdk/task.md#connect_configuration)
method with the file as an argument.
method with the file location and the configuration object's name as arguments. In this example, we connect a JSON file and a YAML file
to a Task.
# Connect a local configuration file
config_file = os.path.join('data_samples', 'sample.json')
config_file = task.connect_configuration(config_file)
config_file_json = 'data_samples/sample.json'
task.connect_configuration(name="json file", configuration=config_file_json)
...
config_file_yaml = 'data_samples/config_yaml.yaml'
task.connect_configuration(configuration=config_file_yaml, name="yaml file")
**ClearML** reports the configuration in the **ClearML Web UI**, experiment details, **CONFIGURATION** tab, **CONFIGURATION OBJECTS**
area. See the image in the next section.
**ClearML** reports the configurations in the **ClearML Web UI** experiment details **>** **CONFIGURATION** tab **>** **CONFIGURATION OBJECTS**
section. The contents of the JSON file will appear in the **json file** object, and the contents of the YAML file will appear
in the **yaml file** object, as specified in the `name` parameter of the `connect_configuration` method.
![image](../../img/examples_reporting_config.png)
### Configuration dictionary
Connect a configuration dictionary to a Task by creating a dictionary, and then calling the [Task.connect_configuration](../../references/sdk/task.md#connect_configuration)
method with the dictionary as an argument. After the configuration is connected, **ClearML** tracks changes to it.
method with the dictionary and the object name as arguments. After the configuration is connected, **ClearML** tracks changes to it.
model_config_dict = {
'value': 13.37,
'CHANGE ME': 13.37,
'dict': {'sub_value': 'string', 'sub_integer': 11},
'list_of_ints': [1, 2, 3, 4],
}
model_config_dict = task.connect_configuration(model_config_dict)
# We now update the dictionary after connecting it, and the changes will be tracked as well.
model_config_dict = task.connect_configuration(name='dictionary', configuration=model_config_dict)
# Update the dictionary after connecting it, and the changes will be tracked as well.
model_config_dict['new value'] = 10
model_config_dict['value'] *= model_config_dict['new value']
model_config_dict['CHANGE ME'] *= model_config_dict['new value']
**ClearML** reports the configuration in the **ClearML Web UI** **>** experiment details **>** **CONFIGURATION** tab **>**
**CONFIGURATION OBJECTS** area.
**CONFIGURATION OBJECTS** area **>** **dictionary** object.
![image](../../img/examples_reporting_config.png)
![image](../../img/examples_reporting_config_3.png)
## Label enumeration
@@ -53,3 +59,10 @@ method with the dictionary as an argument.
labels = {'background': 0, 'cat': 1, 'dog': 2}
task.connect_label_enumeration(labels)
Log a local model file.
OutputModel().update_weights('my_best_model.bin')
The model which is stored contains the model configuration and the label enumeration.
![image](../../img/examples_reporting_config_2.png)