ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-03-13 07:28:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge branch 'main' of https://github.com/allegroai/clearml-docs into images_2

Browse Source
This commit is contained in:
revital 2025-03-09 07:53:08 +02:00
commit a75beafa31
20 changed files with 40 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -332,8 +332,8 @@ must be substituted with valid domain names or values from responses.
``` ```
APISERVER_URL="https://api.<BASE_DOMAIN>" APISERVER_URL="https://api.<BASE_DOMAIN>"
APISERVER_KEY="GGS9F4M6XB2DXJ5AFT9F" APISERVER_KEY="<APISERVER_KEY>"
APISERVER_SECRET="2oGujVFhPfaozhpuz2GzQfA5OyxmMsR3WVJpsCR5hrgHFs20PO" APISERVER_SECRET="<APISERVER_SECRET>"
``` ```
2. Create a *Tenant* (company): 2. Create a *Tenant* (company):
@ -525,7 +525,7 @@ Install the [Task Traffic Router](appgw.md) in your Kubernetes cluster, allowing
apiServerUrlReference: "<http://clearml-enterprise-apiserver.clearml:8008>" apiServerUrlReference: "<http://clearml-enterprise-apiserver.clearml:8008>"
apiserverKey: "<TENANT_KEY>" apiserverKey: "<TENANT_KEY>"
apiserverSecret: "<TENANT_SECRET>" apiserverSecret: "<TENANT_SECRET>"
jwksKey: "ymLh1ok5k5xNUQfS944Xdx9xjf0wueokqKM2dMZfHuH9ayItG2" jwksKey: "<JWKS_KEY>"
ingress: ingress:
enabled: true enabled: true
hostName: "<unique url in same domain as apiserver/webserver>" hostName: "<unique url in same domain as apiserver/webserver>"

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

@ -40,8 +40,8 @@ and running, users can send Tasks to be executed on Google Colab's hardware.
api_host="https://api.clear.ml", api_host="https://api.clear.ml",
web_host="https://app.clear.ml", web_host="https://app.clear.ml",
files_host="https://files.clear.ml", files_host="https://files.clear.ml",
key='6ZHX9UQMYL874A1NE8', key='<generated_key>',
secret='=2h6#%@Y&m*tC!VLEXq&JI7QhZPKuJfbaYD4!uUk(t7=9ENv' secret='<generated_secret>'
) )
``` ```

2
docs/integrations/autokeras.md
View File

@ -93,7 +93,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/catboost.md
View File

@ -91,7 +91,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/fastai.md
View File

@ -90,7 +90,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/keras.md
View File

@ -103,7 +103,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/lightgbm.md
View File

@ -92,7 +92,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/megengine.md
View File

@ -88,7 +88,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/pytorch.md
View File

@ -112,7 +112,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/pytorch_lightning.md
View File

@ -118,7 +118,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md), to
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/scikit_learn.md
View File

@ -94,7 +94,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/tao.md
View File

@ -111,7 +111,7 @@ cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents:
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/tensorflow.md
View File

@ -105,7 +105,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/xgboost.md
View File

@ -118,7 +118,7 @@ Use the ClearML [Autoscalers](../cloud_autoscaling/autoscaling_overview.md) to h
cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents: the autoscaler automatically spins up
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/yolov5.md
View File

@ -167,7 +167,7 @@ cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents:
and shuts down instances as needed, according to a resource budget that you set. and shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5.gif#light-mode-only)
![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only) ![Cloning, editing, enqueuing gif](../img/gif/integrations_yolov5_dark.gif#dark-mode-only)

2
docs/integrations/yolov8.md
View File

@ -112,7 +112,7 @@ cloud of your choice (AWS, GCP, Azure) and automatically deploy ClearML agents:
shuts down instances as needed, according to a resource budget that you set. shuts down instances as needed, according to a resource budget that you set.
### Cloning, Editing, and Enqueuing ### Reproducing Tasks
ClearML logs all the information required to reproduce a task, but you may also want to change a few parameters ClearML logs all the information required to reproduce a task, but you may also want to change a few parameters
and task details when you re-run it, which you can do through ClearML's UI. and task details when you re-run it, which you can do through ClearML's UI.

2
docs/overview.md
View File

@ -7,7 +7,7 @@ slug: /
# ClearML Documentation # ClearML Documentation
## Overview ## Overview
Welcome to the documentation for ClearML, the end to end platform for streamlining AI development and deployment. ClearML consists of three essential layers: Welcome to the documentation for ClearML, the end-to-end platform for streamlining AI development and deployment. ClearML consists of three essential layers:
1. [**Infrastructure Control Plane**](#infrastructure-control-plane) (Cloud/On-Prem Agnostic) 1. [**Infrastructure Control Plane**](#infrastructure-control-plane) (Cloud/On-Prem Agnostic)
2. [**AI Development Center**](#ai-development-center) 2. [**AI Development Center**](#ai-development-center)
3. [**GenAI App Engine**](#genai-app-engine) 3. [**GenAI App Engine**](#genai-app-engine)

7
docs/webapp/applications/apps_embed_model_deployment.md
View File

@ -48,6 +48,13 @@ After starting an Embedding Model Deployment instance, you can view the followin
![Embedding Model Deployment app](../../img/apps_embedding_model_deployment.png#light-mode-only) ![Embedding Model Deployment app](../../img/apps_embedding_model_deployment.png#light-mode-only)
![Embedding Model Deployment app](../../img/apps_embedding_model_deployment_dark.png#dark-mode-only) ![Embedding Model Deployment app](../../img/apps_embedding_model_deployment_dark.png#dark-mode-only)
:::tip EMBEDDING CLEARML VISUALIZATION
You can embed plots from the app instance dashboard into [ClearML Reports](../webapp_reports.md). These visualizations
are updated live as the app instance(s) updates. The Enterprise Plan supports embedding resources in
external tools (e.g. Notion). Hover over the plot and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
to copy the embed code, and navigate to a report to paste the embed code.
:::
## Embedding Model Deployment Instance Configuration ## Embedding Model Deployment Instance Configuration
When configuring a new Embedding Model Deployment instance, you can fill in the required parameters or reuse the When configuring a new Embedding Model Deployment instance, you can fill in the required parameters or reuse the

7
docs/webapp/applications/apps_llama_deployment.md
View File

@ -46,6 +46,13 @@ After starting a llama.cpp Model Deployment instance, you can view the following
![llama deployment dashboard](../../img/apps_llama_dashboard.png) ![llama deployment dashboard](../../img/apps_llama_dashboard.png)
:::tip EMBEDDING CLEARML VISUALIZATION
You can embed plots from the app instance dashboard into [ClearML Reports](../webapp_reports.md). These visualizations
are updated live as the app instance(s) updates. The Enterprise Plan supports embedding resources in
external tools (e.g. Notion). Hover over the plot and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
to copy the embed code, and navigate to a report to paste the embed code.
:::
### Llama.cpp Model Deployment Instance Configuration ### Llama.cpp Model Deployment Instance Configuration
When configuring a new llama.cpp Model Deployment instance, you can fill in the required parameters or reuse the When configuring a new llama.cpp Model Deployment instance, you can fill in the required parameters or reuse the

6
docs/webapp/applications/apps_model_deployment.md
View File

@ -49,6 +49,12 @@ etc.
![vLLM Model Deployment App](../../img/apps_model_deployment.png#light-mode-only) ![vLLM Model Deployment App](../../img/apps_model_deployment.png#light-mode-only)
![vLLM Model Deployment App](../../img/apps_model_deployment_dark.png#dark-mode-only) ![vLLM Model Deployment App](../../img/apps_model_deployment_dark.png#dark-mode-only)
:::tip EMBEDDING CLEARML VISUALIZATION
You can embed plots from the app instance dashboard into [ClearML Reports](../webapp_reports.md). These visualizations
are updated live as the app instance(s) updates. The Enterprise Plan supports embedding resources in
external tools (e.g. Notion). Hover over the plot and click <img src="/docs/latest/icons/ico-plotly-embed-code.svg" alt="Embed code" className="icon size-md space-sm" />
to copy the embed code, and navigate to a report to paste the embed code.
:::
## vLLM Model Deployment Instance Configuration ## vLLM Model Deployment Instance Configuration