ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-05-14 09:31:45 +00:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Small edits (#592)

Browse Source
This commit is contained in:
pollfly 2023-06-11 12:28:44 +03:00 committed by GitHub
parent 740fd4bb0b
commit a3f1e2ccb3
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/guides/pipeline/pipeline_decorator.md
View File

@ -39,7 +39,7 @@ In the example script, the controller defines the interactions between the pipel
:::info Local Execution
In this example, the pipeline is set to run in local mode by using
the <span class="link-code"><a href="../../references/sdk/automation_controller_pipelinecontroller.md#pipelinedecoratorrun_locally"><code>PipelineDecorator.run_locally</code></a></span>
the <span class="link-code"><a href="../../references/sdk/automation_controller_pipelinecontroller#pipelinedecoratorrun_locally"><code>PipelineDecorator.run_locally</code></a></span>
method before calling the pipeline function. See pipeline execution options [here](../../pipelines/pipelines_sdk_function_decorators.md#running-the-pipeline).
:::

2
docs/webapp/applications/apps_dashboard.md
View File

@ -27,7 +27,7 @@ of the chosen metric over time.
* Monitored Metric - Title - Metric title to track
* Monitored Metric - Series - Metric series (variant) to track
* Monitored Metric - Trend - Choose whether to track the monitored metric's highest or lowest values
* Slack Notification (optional) - Set up Slack integration for notifications of task failure. Select the
* **Slack Notification** (optional) - Set up Slack integration for notifications of task failure. Select the
`Alert on completed experiments` under `Additional options` to set up alerts for task completions.
* API Token - Slack workspace access token
* Channel Name - Slack channel to which task failure alerts will be posted

2
docs/webapp/applications/apps_gpu_compute.md
View File

@ -37,7 +37,7 @@ For more information about how autoscalers work, see [Autoscalers Overview](../.
* Git Password / Personal Access Token
* **Cloud Storage Access** (optional) - Access credentials to cloud storage service. Provides ClearML Tasks running on cloud
machines access to your storage
* Additional ClearML Configuration (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments
* **Additional ClearML Configuration** (optional) - A ClearML configuration file to use by the ClearML Agent when executing your experiments
![GPU Compute wizard](../../img/apps_gpu_compute_wizard.png)

26
docs/webapp/webapp_overview.md
View File

@ -15,34 +15,34 @@ The **ClearML Web UI** is the graphical user interface for the ClearML platform,
The WebApp's sidebar provides access to the following modules:
<ul>
<li>
<img src="/docs/latest/icons/ico-homepage.svg" alt="Homepage" className="icon size-md space-sm" /> <a href="webapp_home.md">Dashboard</a> - The dashboard for recent activity and quick access to experiments and projects.
<img src="/docs/latest/icons/ico-homepage.svg" alt="Homepage" className="icon size-md space-sm" /> <a href="webapp_home">Dashboard</a> - The dashboard for recent activity and quick access to experiments and projects.
</li>
<li>
<img src="/docs/latest/icons/ico-projects.svg" alt="Projects" className="icon size-md space-sm" /> <a href="webapp_projects_page.md">Projects</a> - The main experimentation page. Access your experiments and models as they are organized into projects.
The <a href="webapp_exp_table.md">experiments</a> and <a href="webapp_model_table.md">models</a> are displayed in tables
<img src="/docs/latest/icons/ico-projects.svg" alt="Projects" className="icon size-md space-sm" /> <a href="webapp_projects_page">Projects</a> - The main experimentation page. Access your experiments and models as they are organized into projects.
The <a href="webapp_exp_table">experiments</a> and <a href="webapp_model_table">models</a> are displayed in tables
which let you:
<ul>
<li><a href="webapp_exp_track_visual.md">Track ongoing experiments and visualize their results</a></li>
<li><a href="webapp_exp_reproducing.md">Reproduce previously run experiments</a></li>
<li><a href="webapp_exp_tuning.md">Tune experiments with no code change</a></li>
<li><a href="webapp_exp_comparing.md">Compare experiments</a></li>
<li><a href="webapp_exp_sharing.md">Share experiments and their models</a> with other ClearML hosted service users </li>
<li><a href="webapp_exp_track_visual">Track ongoing experiments and visualize their results</a></li>
<li><a href="webapp_exp_reproducing">Reproduce previously run experiments</a></li>
<li><a href="webapp_exp_tuning">Tune experiments with no code change</a></li>
<li><a href="webapp_exp_comparing">Compare experiments</a></li>
<li><a href="webapp_exp_sharing">Share experiments and their models</a> with other ClearML hosted service users </li>
</ul>
</li>
<li>
<img src="/docs/latest/icons/ico-side-bar-datasets.svg" alt="Datasets" className="icon size-md space-sm" /> <a href="datasets/webapp_dataset_page.md">Datasets</a> - View and manage your datasets.
<img src="/docs/latest/icons/ico-side-bar-datasets.svg" alt="Datasets" className="icon size-md space-sm" /> <a href="datasets/webapp_dataset_page">Datasets</a> - View and manage your datasets.
</li>
<li>
<img src="/docs/latest/icons/ico-pipelines.svg" alt="Pipelines" className="icon size-md space-sm" /> <a href="pipelines/webapp_pipeline_page.md">Pipelines</a> - View and manage your pipelines.
<img src="/docs/latest/icons/ico-pipelines.svg" alt="Pipelines" className="icon size-md space-sm" /> <a href="pipelines/webapp_pipeline_page">Pipelines</a> - View and manage your pipelines.
</li>
<li>
<img src="/docs/latest/icons/ico-reports.svg" alt="Reports" className="icon size-md space-sm" /> <a href="webapp_reports.md">Reports</a> - View and manage your reports.
<img src="/docs/latest/icons/ico-reports.svg" alt="Reports" className="icon size-md space-sm" /> <a href="webapp_reports">Reports</a> - View and manage your reports.
</li>
<li>
<img src="/docs/latest/icons/ico-workers.svg" alt="Workers and Queues" className="icon size-md space-sm" /> <a href="webapp_workers_queues.md">Orchestration</a> - Autoscale, monitor, and manage your resource usage and workers queues.
<img src="/docs/latest/icons/ico-workers.svg" alt="Workers and Queues" className="icon size-md space-sm" /> <a href="webapp_workers_queues">Orchestration</a> - Autoscale, monitor, and manage your resource usage and workers queues.
</li>
<li>
<img src="/docs/latest/icons/ico-applications.svg" alt="ClearML Apps" className="icon size-md space-sm" /> <a href="applications/apps_overview.md">Applications</a> - ClearML's GUI applications for no-code workflow execution.
<img src="/docs/latest/icons/ico-applications.svg" alt="ClearML Apps" className="icon size-md space-sm" /> <a href="applications/apps_overview">Applications</a> - ClearML's GUI applications for no-code workflow execution.
</li>
</ul>