ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-02 12:21:08 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits (#752)

Browse Source
This commit is contained in:
pollfly 2024-01-08 16:16:34 +02:00 committed by GitHub
parent 6802e5f5bf
commit c2a128a9b4
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/clearml_sdk/task_sdk.md
View File

@ -871,7 +871,7 @@ task.connect(params_dictionary)
### Configuration Objects
To log configuration more elaborate than a key-value dictionary (such as nested dictionaries or configuration files),
use the [`Task.connect_configuration`](../references/sdk/task.md#connect_configuration) method.
use [`Task.connect_configuration()`](../references/sdk/task.md#connect_configuration).
This method saves configuration objects as blobs (i.e. ClearML is not aware of their internal structure).
```python
@ -895,14 +895,14 @@ config_file_yaml = task.connect_configuration(
A task's user properties do not impact task execution, so you can add / modify the properties at any stage. Add user
properties to a task with the [`Task.set_user_properties`](../references/sdk/task.md#set_user_properties) method.
For example, the code below sets the "backbone" property in a task:
```python
task.set_user_properties(
{"name": "backbone", "description": "network type", "value": "great"}
)
```
The above example sets the "backbone" property in a task.
![Task user properties](../img/fundamentals_task_config_properties.png)
## Scalars

2
docs/clearml_serving/clearml_serving.md
View File

@ -28,7 +28,7 @@ solution.
* Support for CPU and GPU nodes
* Auto-batching for DL models
* [Automatic deployment](clearml_serving_tutorial.md#automatic-model-deployment)
* Automatic model upgrades w/ canary support
* Automatic model upgrades with canary support
* Programmable API for model deployment
* [Canary A/B deployment](clearml_serving_tutorial.md#canary-endpoint-setup) - online Canary updates
* [Model Monitoring](clearml_serving_tutorial.md#model-monitoring-and-performance-metrics)

2
docs/clearml_serving/clearml_serving_setup.md
View File

@ -66,7 +66,7 @@ The following page goes over how to set up and upgrade `clearml-serving`.
cd docker && docker-compose --env-file example.env -f docker-compose-triton.yml up
```
If running on a GPU instance w/ Triton support (keras/pytorch/onnx etc.), use the triton gpu docker-compose file:
If running on a GPU instance with Triton support (keras/pytorch/onnx etc.), use the triton gpu docker-compose file:
```bash
cd docker && docker-compose --env-file example.env -f docker-compose-triton-gpu.yml up
```

12
docs/webapp/webapp_exp_tuning.md
View File

@ -58,7 +58,7 @@ User parameters are editable in any experiment, except experiments whose status
Select source code by changing any of the following:
* Repository, commit (select by ID, tag name, or choose the last commit in the branch), script, and /or working directory.
* Repository, commit (select by ID, tag name, or choose the last commit in the branch), script, and/or working directory.
* Installed Python packages and/or versions - Edit or clear (remove) them all.
* Uncommitted changes - Edit or clear (remove) them all.
@ -122,8 +122,8 @@ Add, change, or delete hyperparameters, which are organized in the **ClearML Web
**To add, change, or delete hyperparameters:**
* In the **CONFIGURATION** tab **>** **HYPERPARAMETERS** > **General** **>** hover **>** **EDIT** **>** add, change,
or delete keys and /or values **>** **SAVE**.
* In the **CONFIGURATION** tab **>** **HYPERPARAMETERS** **>** parameter group **>** hover **>** click **EDIT** **>** add, change,
or delete keys and/or values **>** click **SAVE**.
@ -134,8 +134,8 @@ except experiments whose status is *Published* (read-only).
**To add, change, or delete user properties:**
* In **CONFIGURATION** **>** **USER PROPERTIES** > **Properties** **>** hover **>** **EDIT** **>** add, change, or delete
keys and /or values **>** **SAVE**.
* In **CONFIGURATION** **>** **USER PROPERTIES** **>** **Properties** **>** hover **>** click **EDIT** **>** add, change, or delete
keys and/or values **>** click **SAVE**.
@ -143,7 +143,7 @@ except experiments whose status is *Published* (read-only).
**To add, change, or delete the Task model configurations:**
* In **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **GENERAL** **>** hover **>** **EDIT** or **CLEAR** (if the
* In **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** object name **>** hover **>** **EDIT** or **CLEAR** (if the
configuration is not empty).
### Artifacts