ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-27 09:50:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#1067)

Browse Source
This commit is contained in:
pollfly 2025-03-02 11:54:05 +02:00 committed by GitHub
parent ec8b229fad
commit 3829d1f4b7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
15 changed files with 24 additions and 24 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/deploying_clearml/clearml_server_es7_migration.md
View File

@ -129,7 +129,7 @@ and ClearML Server needs to be installed.
1. Add the `clearml-server` repository to Helm client.
```
helm repo add allegroai https://allegroai.github.io/clearml-server-helm/
helm repo add clearml https://clearml.github.io/clearml-server-helm/
```
Confirm the `clearml-server` repository is now in the Helm client.

2
docs/deploying_clearml/clearml_server_linux_mac.md
View File

@ -136,7 +136,7 @@ Deploying the server requires a minimum of 8 GB of memory, 16 GB is recommended.
2. Download the ClearML Server docker-compose YAML file.
```
sudo curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
sudo curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
```
1. For Linux only, configure the **ClearML Agent Services**:

2
docs/deploying_clearml/clearml_server_win.md
View File

@ -57,7 +57,7 @@ Deploying the server requires a minimum of 8 GB of memory, 16 GB is recommended.
1. Save the ClearML Server docker-compose YAML file.
```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml
curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml
```
1. Run `docker-compose`. In PowerShell, execute the following commands:

6
docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md
View File

@ -12,8 +12,8 @@ This guide details the installation of the ClearML AI Application Gateway, speci
* Kubernetes cluster: `>= 1.21.0-0 < 1.32.0-0`
* Helm installed and configured
* Helm token to access allegroai helm-chart repo
* Credentials for allegroai docker repo
* Helm token to access `allegroai` helm-chart repo
* Credentials for `allegroai` docker repo
* A valid ClearML Server installation
## Optional for HTTPS
@ -27,7 +27,7 @@ This guide details the installation of the ClearML AI Application Gateway, speci
```
helm repo add allegroai-enterprise \
https://raw.githubusercontent.com/allegroai/clearml-enterprise-helm-charts/gh-pages \
https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-pages \
--username <GITHUB_TOKEN> \
--password <GITHUB_TOKEN>
```

2
docs/deploying_clearml/upgrade_server_aws_ec2_ami.md
View File

@ -49,7 +49,7 @@ If upgrading from Trains Server version 0.15 or older, a data migration is requi
1. Download the latest `docker-compose.yml` file. Execute the following command:
```
sudo curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
sudo curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
```
1. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

2
docs/deploying_clearml/upgrade_server_gcp.md
View File

@ -38,7 +38,7 @@ you can proceed to upgrade to v2.x.
1. Download the latest `docker-compose.yml` file:
```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
```
1. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

4
docs/deploying_clearml/upgrade_server_kubernetes_helm.md
View File

@ -7,13 +7,13 @@ title: Kubernetes
```bash
helm repo update
helm upgrade clearml allegroai/clearml
helm upgrade clearml clearml/clearml
```
**To change the values in an existing installation,** execute the following:
```bash
helm upgrade clearml allegroai/clearml --version <CURRENT CHART VERSION> -f custom_values.yaml
helm upgrade clearml clearml/clearml --version <CURRENT CHART VERSION> -f custom_values.yaml
```
See the [clearml-helm-charts repository](https://github.com/clearml/clearml-helm-charts/tree/main/charts/clearml#local-environment)

2
docs/deploying_clearml/upgrade_server_linux_mac.md
View File

@ -59,7 +59,7 @@ For backwards compatibility, the environment variables ``TRAINS_HOST_IP``, ``TRA
1. Download the latest `docker-compose.yml` file:
```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
```
1. Startup ClearML Server. This automatically pulls the latest ClearML Server build:

2
docs/deploying_clearml/upgrade_server_win.md
View File

@ -49,7 +49,7 @@ you can proceed to upgrade to v2.x.
1. Download the latest `docker-compose.yml` file:
```
curl https://raw.githubusercontent.com/allegroai/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml
curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml
```
1. Startup ClearML Server. This automatically pulls the latest ClearML Server build.

6
docs/getting_started/main.md
View File

@ -32,19 +32,19 @@ training, and deploying models at every scale on any AI infrastructure.
<tbody>
<tr>
<td><a href="https://github.com/clearml/clearml/blob/master/docs/tutorials/Getting_Started_1_Experiment_Management.ipynb"><b>Step 1</b></a> - Experiment Management</td>
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/allegroai/clearml/blob/master/docs/tutorials/Getting_Started_1_Experiment_Management.ipynb">
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/clearml/clearml/blob/master/docs/tutorials/Getting_Started_1_Experiment_Management.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a></td>
</tr>
<tr>
<td><a href="https://github.com/clearml/clearml/blob/master/docs/tutorials/Getting_Started_2_Setting_Up_Agent.ipynb"><b>Step 2</b></a> - Remote Execution Agent Setup</td>
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/allegroai/clearml/blob/master/docs/tutorials/Getting_Started_2_Setting_Up_Agent.ipynb">
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/clearml/clearml/blob/master/docs/tutorials/Getting_Started_2_Setting_Up_Agent.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a></td>
</tr>
<tr>
<td><a href="https://github.com/clearml/clearml/blob/master/docs/tutorials/Getting_Started_3_Remote_Execution.ipynb"><b>Step 3</b></a> - Remotely Execute Tasks</td>
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/allegroai/clearml/blob/master/docs/tutorials/Getting_Started_3_Remote_Execution.ipynb">
<td className="align-center"><a className="no-ext-icon" target="_blank" href="https://colab.research.google.com/github/clearml/clearml/blob/master/docs/tutorials/Getting_Started_3_Remote_Execution.ipynb">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab"/>
</a></td>
</tr>

2
docs/guides/clearml-task/clearml_task_tutorial.md
View File

@ -49,7 +49,7 @@ Execution log at: https://app.clear.ml/projects/552d5399112d47029c146d5248570295
### Executing a Local Script
For this example, use a local version of [this script](https://github.com/clearml/events/blob/master/webinar-0620/keras_mnist.py).
1. Clone the [allegroai/events](https://github.com/clearml/events) repository
1. Clone the [clearml/events](https://github.com/clearml/events) repository
1. Go to the root folder of the cloned repository
1. Run the following command:

2
docs/guides/ide/google_colab.md
View File

@ -16,7 +16,7 @@ and running, users can send Tasks to be executed on Google Colab's hardware.
## Steps
1. Open up [this Google Colab notebook](https://colab.research.google.com/github/allegroai/clearml/blob/master/examples/clearml_agent/clearml_colab_agent.ipynb).
1. Open up [this Google Colab notebook](https://colab.research.google.com/github/clearml/clearml/blob/master/examples/clearml_agent/clearml_colab_agent.ipynb).
1. Run the first cell, which installs all the necessary packages:
```

2
docs/guides/services/slack_alerts.md
View File

@ -22,7 +22,7 @@ The Slack API token and channel you create are required to configure the Slack a
1. In **Development Slack Workspace**, select a workspace.
1. Click **Create App**.
1. In **Basic Information**, under **Display Information**, complete the following:
- In **Short description**, enter "Allegro Train Bot".
- In **Short description**, enter "ClearML Train Bot".
- In **Background color**, enter "#202432".
1. Click **Save Changes**.
1. In **OAuth & Permissions**, under **Scopes**, click **Add an OAuth Scope**, and then select the following permissions

4
docs/webapp/webapp_exp_track_visual.md
View File

@ -252,7 +252,7 @@ To download the task history as a CSV file, hover over the log and click <img sr
ClearML maintains a system-wide, large but strict limit for task history items. Once the limit is reached, the oldest entries are purged to make room for fresh entries.
:::
### Description
### Description
Add descriptive text to the task in the **Description** section. To modify the description, hover over the
description box and click **Edit**.
@ -304,7 +304,7 @@ All scalars that ClearML automatically logs, as well as those explicitly reporte
Scalar series can be displayed in [graph view](#graph-view) (default) or in [metric values view](#metric-values-view):
#### Graph View
#### Graph View
Scalar graph view (<img src="/docs/latest/icons/ico-charts-view.svg" alt="Graph view" className="icon size-md space-sm" />)
shows scalar series plotted as a time series line chart. By default, a single plot is shown for each scalar metric,
with all variants overlaid within.

8
docs/webapp/webapp_reports.md
View File

@ -424,22 +424,22 @@ To add an image, add an exclamation point, followed by the alt text enclosed by
image enclosed in parentheses:
```
![Logo](https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg)
![Logo](https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg)
```
The rendered output should look like this:
![Logo](https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg)
![Logo](https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg)
To add a title to the image, which you can see in a tooltip when hovering over the image, add the title after the image's
link:
```
![With title](https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg "ClearML logo")
![With title](https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg "ClearML logo")
```
The rendered output should look like this:
<img src="https://raw.githubusercontent.com/allegroai/clearml/master/docs/clearml-logo.svg" alt="Logo with Title" title="ClearML logo"/>
<img src="https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg" alt="Logo with Title" title="ClearML logo"/>
Hover over the image to see its title.