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

Small updates (#179)

Browse Source
This commit is contained in:
pollfly
2022-02-06 11:53:47 +02:00
committed by GitHub
parent c73f86954c
commit 805f196018
4 changed files with 32 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -54,3 +54,7 @@ The model’s **LABELS** tab displays its label enumeration.
![Model Labels tab](../../img/examples_model_logging_labels.png)
## Additional Example
See [PyTorch Model Updating](../frameworks/pytorch/model_updating.md) for a more robust example, which trains a model,
and then logs it with OutputModel.

99
docs/guides/reporting/model_updating.md
View File

@@ -1,99 +0,0 @@
---
title: Model Updating
---
The [model_update_pytorch.py](https://github.com/allegroai/clearml/blob/master/examples/reporting/model_update_pytorch.py)
example demonstrates training a model and logging it using the [OutputModel](../../references/sdk/model_outputmodel.md)
class.
The example does the following:
* Creates a task named `Model update pytorch` in the `examples` project.
* Trains a neural network on the CIFAR10 dataset for image classification.
* Uses an OutputModel object to log the model, its label enumeration and configuration dictionary.
:::note Disabling automatic framework logging
This example disables the default automatic capturing of PyTorch outputs, to demonstrate how to manually control what is
logged from PyTorch. See [this FAQ](../../faq.md#controlling_logging) for more information.
:::
## Initialization
An OutputModel object is instantiated for the task.
```python
from clearml import Task, OutputModel
task = Task.init(
project_name="examples",
task_name="Model update pytorch",
auto_connect_frameworks={"pytorch": False}
)
output_model = OutputModel(task=task)
```
## Label Enumeration
The label enumeration dictionary is logged using the [`Task.connect_label_enumeration`](../../references/sdk/task.md#connect_label_enumeration)
method which will update the task’s resulting model information. The current running task is accessed using the
[`Task.current_task`](../../references/sdk/task.md#taskcurrent_task) class method.
```python
# store the label enumeration of the training model
classes = ("plane", "car", "bird", "cat", "deer", "dog", "frog", "horse", "ship", "truck",)
enumeration = {k: v for v, k in enumerate(classes, 1)}
Task.current_task().connect_label_enumeration(enumeration)
```
:::note Directly Setting Model Enumeration
You can set a model’s label enumeration directly using the [`OutputModel.update_labels`](../../references/sdk/model_outputmodel.md#update_labels)
method
:::
## Model Configuration
Add a configuration dictionary to the model using the [`OutputModel.update_design`](../../references/sdk/model_outputmodel.md#update_design)
method.
```python
model_config_dict = {
"list_of_ints": [1, 2, 3, 4],
"dict": {
"sub_value": "string",
"sub_integer": 11
},
"value": 13.37
}
model.update_design(config_dict=model_config_dict)
```
## Updating Models
To update a model, use the [OutputModel.update_weights](../../references/sdk/model_outputmodel.md#update_weights) method.
This uploads the model to the set storage destination (see [Setting Upload Destination](../../fundamentals/artifacts.md#setting-upload-destination)),
and registers that location to the task as the output model.
```python
# CONDITION depicts a custom condition for when to save the model. The model is saved and then updated in ClearML
CONDITION = True
if CONDITION:
torch.save(net.state_dict(), PATH)
model.update_weights(weights_filename=PATH)
```
## WebApp
The model appears in the task’s **ARTIFACTS** tab.
![Task artifacts](../../img/examples_model_update_artifacts.png)
Clicking on the model name takes you to the [model’s page](../../webapp/webapp_model_viewing.md), where you can view the
model’s details and access the model.
![Model page](../../img/examples_model_update_model.png)
The model’s **NETWORK** tab displays its configuration.
![Model network tab](../../img/examples_model_update_network.png)
The model’s **LABELS** tab displays its label enumeration.
![Model labels](../../img/examples_model_update_labels.png)