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

Fix links (#165)

Browse Source
This commit is contained in:
pollfly
2022-01-19 14:26:14 +02:00
committed by GitHub
parent b48dfe1d50
commit 70595e4f84
22 changed files with 48 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
docs/guides/datasets/data_man_python.md
View File

@@ -56,11 +56,11 @@ This adds the downloaded files to the current dataset.
dataset.upload()
```
This uploads the dataset to the ClearML Server by default. The dataset's destination can be changed by specifying the
target storage with the `output_url` parameter of the [`upload`](../../references/sdk/dataset#upload) method.
target storage with the `output_url` parameter of the [`upload`](../../references/sdk/dataset.md#upload) method.
### Finalizing the Dataset
Run the [`finalize`](../../references/sdk/dataset#finzalize) command to close the dataset and set that dataset's tasks
Run the [`finalize`](../../references/sdk/dataset.md#finalize) command to close the dataset and set that dataset's tasks
status to *completed*. The dataset can only be finalized if it doesn't have any pending uploads.
```python

6
docs/guides/distributed/distributed_pytorch_example.md
View File

@@ -14,7 +14,7 @@ dataset), and reports (uploads) the following to the main Task:
* Scalars - Loss reported as a scalar during training in each Task in a subprocess.
* Hyperparameters - Hyperparameters created in each Task are added to the hyperparameters in the main Task.
Each Task in a subprocess references the main Task by calling [Task.current_task](../../references/sdk/task#taskcurrent_task), which always returns
Each Task in a subprocess references the main Task by calling [Task.current_task](../../references/sdk/task.md#taskcurrent_task), which always returns
the main Task.
When the script runs, it creates an experiment named `test torch distributed`, which is associated with the `examples` project.
@@ -38,7 +38,7 @@ All of these artifacts appear in the main Task under **ARTIFACTS** **>** **OTHER
## Scalars
Loss is reported to the main Task by calling the [Logger.report_scalar](../../references/sdk/logger#report_scalar)
Loss is reported to the main Task by calling the [Logger.report_scalar](../../references/sdk/logger.md#report_scalar)
method on `Task.current_task().get_logger`, which is the logger for the main Task. Since `Logger.report_scalar` is called
with the same title (`loss`), but a different series name (containing the subprocess' `rank`), all loss scalar series are
logged together.
@@ -58,7 +58,7 @@ The single scalar plot for loss appears in **RESULTS** **>** **SCALARS**.
## Hyperparameters
**ClearML** automatically logs the argparse command line options. Since the [`Task.connect`](../../references/sdk/task#connect)
**ClearML** automatically logs the argparse command line options. Since the [`Task.connect`](../../references/sdk/task.md#connect)
method is called on [`Task.current_task`](../../references/sdk/task.md#taskcurrent_task), they are logged in the main Task. A different hyperparameter key is used in each
subprocess, so they do not overwrite each other in the main Task.

4
docs/guides/distributed/subprocess_example.md
View File

@@ -5,7 +5,7 @@ title: Subprocess
The [subprocess_example.py](https://github.com/allegroai/clearml/blob/master/examples/distributed/subprocess_example.py)
script demonstrates multiple subprocesses interacting and reporting to a main Task. The following happens in the script:
* This script initializes a main Task and spawns subprocesses, each for an instances of that Task.
* Each Task in a subprocess references the main Task by calling [Task.current_task](../../references/sdk/task#taskcurrent_task),
* Each Task in a subprocess references the main Task by calling [Task.current_task](../../references/sdk/task.md#taskcurrent_task),
which always returns the main Task.
* The Task in each subprocess reports the following to the main Task:
* Hyperparameters - Additional, different hyperparameters.
@@ -15,7 +15,7 @@ which always returns the main Task.
## Hyperparameters
ClearML automatically logs the command line options defined with `argparse`. A parameter dictionary is logged by
connecting it to the Task using a call to the [Task.connect](../../references/sdk/task#connect) method.
connecting it to the Task using a call to the [Task.connect](../../references/sdk/task.md#connect) method.
```python
additional_parameters = {

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

@@ -6,7 +6,7 @@ The [html_reporting.py](https://github.com/allegroai/clearml/blob/master/example
demonstrates reporting local HTML files and HTML by URL, using the [Logger.report_media](../../references/sdk/logger.md#report_media)
method.
**ClearML** reports these HTML debug samples in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>**
ClearML reports these HTML debug samples in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>**
**DEBUG SAMPLES** sub-tab.
When the script runs, it creates an experiment named `html samples reporting`, which is associated with the `examples` project.
@@ -18,7 +18,7 @@ When the script runs, it creates an experiment named `html samples reporting`, w
Report HTML by URL, using the [Logger.report_media](../../references/sdk/logger.md#report_media) method's `url` parameter.
See the example script's [report_html_url](https://github.com/allegroai/clearml/blob/master/examples/reporting/html_reporting.py#L16)
function, which reports the **ClearML** documentation's home page.
function, which reports the ClearML documentation's home page.
```python
Logger.current_logger().report_media("html", "url_html", iteration=iteration, url="https://clear.ml/docs")

2
docs/guides/reporting/media_reporting.md
View File

@@ -10,7 +10,7 @@ method to upload from:
* URL of media already uploaded to some storage
**ClearML** uploads media to the bucket specified in the **ClearML** configuration file or **ClearML** can be configured for image storage, see [Logger.set_default_upload_destination](../../references/sdk/logger.md#set_default_upload_destination)
(storage for [artifacts](../../fundamentals/artifacts#setting-upload-destination) is different). Set credentials for storage in the **ClearML**
(storage for [artifacts](../../fundamentals/artifacts.md#setting-upload-destination) is different). Set credentials for storage in the **ClearML**
[configuration file](../../configs/clearml_conf.md).
**ClearML** reports media in the **ClearML Web UI** **>** experiment details **>** **RESULTS** tab **>** **DEBUG SAMPLES**