From 3829d1f4b771c812ec5b7514e1b31e3b25a5aca4 Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Sun, 2 Mar 2025 11:54:05 +0200 Subject: [PATCH] Small edits (#1067) --- docs/deploying_clearml/clearml_server_es7_migration.md | 2 +- docs/deploying_clearml/clearml_server_linux_mac.md | 2 +- docs/deploying_clearml/clearml_server_win.md | 2 +- .../enterprise_deploy/appgw_install_k8s.md | 6 +++--- docs/deploying_clearml/upgrade_server_aws_ec2_ami.md | 2 +- docs/deploying_clearml/upgrade_server_gcp.md | 2 +- docs/deploying_clearml/upgrade_server_kubernetes_helm.md | 4 ++-- docs/deploying_clearml/upgrade_server_linux_mac.md | 2 +- docs/deploying_clearml/upgrade_server_win.md | 2 +- docs/getting_started/main.md | 6 +++--- docs/guides/clearml-task/clearml_task_tutorial.md | 2 +- docs/guides/ide/google_colab.md | 2 +- docs/guides/services/slack_alerts.md | 2 +- docs/webapp/webapp_exp_track_visual.md | 4 ++-- docs/webapp/webapp_reports.md | 8 ++++---- 15 files changed, 24 insertions(+), 24 deletions(-) diff --git a/docs/deploying_clearml/clearml_server_es7_migration.md b/docs/deploying_clearml/clearml_server_es7_migration.md index abc6b671..126b222b 100644 --- a/docs/deploying_clearml/clearml_server_es7_migration.md +++ b/docs/deploying_clearml/clearml_server_es7_migration.md @@ -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. diff --git a/docs/deploying_clearml/clearml_server_linux_mac.md b/docs/deploying_clearml/clearml_server_linux_mac.md index 9509c748..52b25658 100644 --- a/docs/deploying_clearml/clearml_server_linux_mac.md +++ b/docs/deploying_clearml/clearml_server_linux_mac.md @@ -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**: diff --git a/docs/deploying_clearml/clearml_server_win.md b/docs/deploying_clearml/clearml_server_win.md index f3a54e20..5cf0e768 100644 --- a/docs/deploying_clearml/clearml_server_win.md +++ b/docs/deploying_clearml/clearml_server_win.md @@ -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: diff --git a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md index 945a31cb..4274f844 100644 --- a/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md +++ b/docs/deploying_clearml/enterprise_deploy/appgw_install_k8s.md @@ -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 \ --password ``` diff --git a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md index d962e3cb..ed129ab2 100644 --- a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md @@ -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. diff --git a/docs/deploying_clearml/upgrade_server_gcp.md b/docs/deploying_clearml/upgrade_server_gcp.md index a3d5c020..7739d82d 100644 --- a/docs/deploying_clearml/upgrade_server_gcp.md +++ b/docs/deploying_clearml/upgrade_server_gcp.md @@ -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. diff --git a/docs/deploying_clearml/upgrade_server_kubernetes_helm.md b/docs/deploying_clearml/upgrade_server_kubernetes_helm.md index a2d2fb0a..7aa1b6e0 100644 --- a/docs/deploying_clearml/upgrade_server_kubernetes_helm.md +++ b/docs/deploying_clearml/upgrade_server_kubernetes_helm.md @@ -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 -f custom_values.yaml +helm upgrade clearml clearml/clearml --version -f custom_values.yaml ``` See the [clearml-helm-charts repository](https://github.com/clearml/clearml-helm-charts/tree/main/charts/clearml#local-environment) diff --git a/docs/deploying_clearml/upgrade_server_linux_mac.md b/docs/deploying_clearml/upgrade_server_linux_mac.md index 78f87ac5..3a77d8a6 100644 --- a/docs/deploying_clearml/upgrade_server_linux_mac.md +++ b/docs/deploying_clearml/upgrade_server_linux_mac.md @@ -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: diff --git a/docs/deploying_clearml/upgrade_server_win.md b/docs/deploying_clearml/upgrade_server_win.md index 20350cd5..11f8690a 100644 --- a/docs/deploying_clearml/upgrade_server_win.md +++ b/docs/deploying_clearml/upgrade_server_win.md @@ -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. diff --git a/docs/getting_started/main.md b/docs/getting_started/main.md index bc1b3b17..12ab7727 100644 --- a/docs/getting_started/main.md +++ b/docs/getting_started/main.md @@ -32,19 +32,19 @@ training, and deploying models at every scale on any AI infrastructure. Step 1 - Experiment Management - + Open In Colab Step 2 - Remote Execution Agent Setup - + Open In Colab Step 3 - Remotely Execute Tasks - + Open In Colab diff --git a/docs/guides/clearml-task/clearml_task_tutorial.md b/docs/guides/clearml-task/clearml_task_tutorial.md index 99b86e0f..9f47b5df 100644 --- a/docs/guides/clearml-task/clearml_task_tutorial.md +++ b/docs/guides/clearml-task/clearml_task_tutorial.md @@ -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: diff --git a/docs/guides/ide/google_colab.md b/docs/guides/ide/google_colab.md index 49163696..dbee1a2d 100644 --- a/docs/guides/ide/google_colab.md +++ b/docs/guides/ide/google_colab.md @@ -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: ``` diff --git a/docs/guides/services/slack_alerts.md b/docs/guides/services/slack_alerts.md index e7bcb251..8a3bbd6a 100644 --- a/docs/guides/services/slack_alerts.md +++ b/docs/guides/services/slack_alerts.md @@ -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 diff --git a/docs/webapp/webapp_exp_track_visual.md b/docs/webapp/webapp_exp_track_visual.md index c2396e3b..14f3fbe2 100644 --- a/docs/webapp/webapp_exp_track_visual.md +++ b/docs/webapp/webapp_exp_track_visual.md @@ -252,7 +252,7 @@ To download the task history as a CSV file, hover over the log and click Graph view) 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. diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index a2766916..e84057c6 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -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: -Logo with Title +Logo with Title Hover over the image to see its title.