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 edits (#796)

Browse Source
This commit is contained in:
pollfly
2024-03-12 11:24:42 +02:00
committed by GitHub
parent dce8b12932
commit 67cfbb1ef6
28 changed files with 58 additions and 55 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/clearml_sdk/clearml_sdk.md
View File

@@ -106,7 +106,7 @@ and [example](https://github.com/allegroai/clearml/blob/master/examples/schedule
### TriggerScheduler
The `TriggerScheduler` class facilitates triggering task execution in the case that specific events occur in the system
(e.g. model publication, dataset creation, task failure). See [code](https://github.com/allegroai/clearml/blob/master/clearml/automation/trigger.py#L148)
(such as model publication, dataset creation, task failure). See [code](https://github.com/allegroai/clearml/blob/master/clearml/automation/trigger.py#L148)
and [usage example](https://github.com/allegroai/clearml/blob/master/examples/scheduler/trigger_example.py).
## Examples

2
docs/clearml_sdk/model_sdk.md
View File

@@ -181,7 +181,7 @@ The default operator for a query is `or`, unless `and` is placed at the beginnin
### Retrieving Models
Retrieve a local copy of a ClearML model through a `Model`/`InputModel` object's [`get_local_copy()`](../references/sdk/model_model.md#get_local_copy).
The method returns a path to a cached local copy of the model. In the case that the model is already cached, you can set
`force_download` to `True` in order to download a fresh version.
`force_download` to `True` to download a fresh version.
## Logging Metrics and Plots

12
docs/clearml_sdk/task_sdk.md
View File

@@ -19,7 +19,7 @@ To ensure every run will provide the same results, ClearML controls the determin
:::
:::note
ClearML object (e.g. task, project) names are required to be at least 3 characters long
ClearML object (such as task, project) names are required to be at least 3 characters long
:::
```python
@@ -100,8 +100,8 @@ By default, when ClearML is integrated into your script, it automatically captur
and parameters from supported argument parsers. But, you may want to have more control over what your experiment logs.
#### Frameworks
To control a task's framework logging, use the `auto_connect_frameworks` parameter of the [`Task.init`](../references/sdk/task.md#taskinit)
method. Turn off all automatic logging by setting the parameter to `False`. For finer grained control of logged frameworks,
To control a task's framework logging, use the `auto_connect_frameworks` parameter of [`Task.init()`](../references/sdk/task.md#taskinit).
Turn off all automatic logging by setting the parameter to `False`. For finer grained control of logged frameworks,
input a dictionary, with framework-boolean pairs.
For example:
@@ -165,7 +165,7 @@ auto_connect_arg_parser={}
### Task Reuse
Every `Task.init` call will create a new task for the current execution.
In order to mitigate the clutter that a multitude of debugging tasks might create, a task will be reused if:
To mitigate the clutter that a multitude of debugging tasks might create, a task will be reused if:
* The last time it was executed (on this machine) was under 24 hours ago (configurable, see
[`sdk.development.task_reuse_time_window_in_hours`](../configs/clearml_conf.md#task_reuse) in
the ClearML configuration reference)
@@ -183,7 +183,7 @@ The task will continue reporting its outputs based on the iteration in which it
train/loss scalar reported was for iteration 100, when continued, the next report will be as iteration 101.
:::note Reproducibility
Continued tasks may not be reproducible. In order to guarantee task reproducibility, you must ensure that all steps are
Continued tasks may not be reproducible. To guarantee task reproducibility, you must ensure that all steps are
done in the same order (e.g. maintaining learning rate profile, ensuring data is fed in the same order).
:::
@@ -786,7 +786,7 @@ task = Task.init(
Specify the model storage URI location using the relevant format:
* A shared folder: `/mnt/share/folder`
* S3: `s3://bucket/folder`
* Non-AWS S3-like services (e.g. MinIO): `s3://host_addr:port/bucket`
* Non-AWS S3-like services (such as MinIO): `s3://host_addr:port/bucket`
* Google Cloud Storage: `gs://bucket-name/folder`
* Azure Storage: `azure://<account name>.blob.core.windows.net/path/to/file`
:::