This commit is contained in:
revital 2025-03-11 17:44:52 +02:00
commit f6cff8e460
145 changed files with 250 additions and 137 deletions

View File

@ -232,7 +232,7 @@ ranging from 2 GB to 12 GB (see [clearml-fractional-gpu repository](https://gith
This example runs the ClearML Ubuntu 22 with CUDA 12.3 container on GPU 0, which is limited to use up to 8GB of its memory.
:::note
--pid=host is required to allow the driver to differentiate between the container's processes and other host processes when limiting memory usage
`--pid=host` is required to allow the driver to differentiate between the container's processes and other host processes when limiting memory usage
:::
1. Run the following command inside the container to verify that the fractional gpu memory limit is working correctly:
```bash

View File

@ -212,7 +212,7 @@ Example:
ClearML serving instances send serving statistics (count/latency) automatically to Prometheus and Grafana can be used
to visualize and create live dashboards.
The default docker-compose installation is preconfigured with Prometheus and Grafana. Notice that by default data/ate
The default `docker-compose` installation is preconfigured with Prometheus and Grafana. Notice that by default data/ate
of both containers is *not* persistent. To add persistence, adding a volume mount is recommended.
You can also add many custom metrics on the input/predictions of your models. Once a model endpoint is registered,

View File

@ -22,7 +22,7 @@ The values in the ClearML configuration file can be overridden by environment va
and command-line arguments.
:::
# Editing Your Configuration File
## Editing Your Configuration File
To add, change, or delete options, edit your configuration file.
@ -1548,7 +1548,7 @@ environment {
}
```
### files section
### files section
**`files`** (*dict*)

View File

@ -5,8 +5,8 @@ title: Linux and macOS
Deploy the ClearML Server in Linux or macOS using the pre-built Docker image.
For ClearML docker images, including previous versions, see [https://hub.docker.com/r/allegroai/clearml](https://hub.docker.com/r/allegroai/clearml).
However, pulling the ClearML Docker image directly is not required. ClearML provides a docker-compose YAML file that does this.
The docker-compose file is included in the instructions on this page.
However, pulling the ClearML Docker image directly is not required. ClearML provides a `docker-compose` YAML file that does this.
The `docker-compose` file is included in the instructions on this page.
For information about upgrading ClearML Server in Linux or macOS, see [here](upgrade_server_linux_mac.md).
@ -134,7 +134,7 @@ Deploying the server requires a minimum of 8 GB of memory, 16 GB is recommended.
sudo chown -R $(whoami):staff /opt/clearml
```
2. Download the ClearML Server docker-compose YAML file.
2. Download the ClearML Server `docker-compose` YAML file:
```
sudo curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose.yml -o /opt/clearml/docker-compose.yml
```

View File

@ -54,7 +54,7 @@ Deploying the server requires a minimum of 8 GB of memory, 16 GB is recommended.
mkdir c:\opt\clearml\logs
```
1. Save the ClearML Server docker-compose YAML file.
1. Save the ClearML Server `docker-compose` YAML file.
```
curl https://raw.githubusercontent.com/clearml/clearml-server/master/docker/docker-compose-win10.yml -o c:\opt\clearml\docker-compose-win10.yml

View File

@ -13,7 +13,7 @@ without any coding. Applications are installed on top of the ClearML Server.
To run application you will need the following:
* RAM: Make sure you have at least 400 MB of RAM per application instance.
* Applications Service: Make sure that the applications agent service is up and running on your server:
* If you are using a docker-compose solution, make sure that the clearml-apps-agent service is running.
* If you are using a `docker-compose` solution, make sure that the clearml-apps-agent service is running.
* If you are using a Kubernetes cluster, check for the clearml-clearml-enterprise-apps component.
* Installation Files: Each application has its installation zip file. Make sure you have the relevant files for the
applications you wish to install.

View File

@ -13,11 +13,11 @@ The Application Gateway is available under the ClearML Enterprise plan.
* Credentials for the ClearML/allegroai docker repository
* A valid ClearML Server installation
## Host configurations
## Host Configurations
### Docker installation
### Docker Installation
Installing docker and docker-compose might vary depending on the specific operating system youre using. Here is an example for AmazonLinux:
Installing `docker` and `docker-compose` might vary depending on the specific operating system youre using. Here is an example for AmazonLinux:
```
sudo dnf -y install docker
@ -33,9 +33,9 @@ sudo docker login
Use the ClearML/allegroai dockerhub credentials when prompted by docker login.
### Docker-compose file
### Docker-compose File
This is an example of the docker-compose file you will need:
This is an example of the `docker-compose` file you will need:
```
version: '3.5'
@ -103,17 +103,17 @@ Edit it according to the following guidelines:
* `CLEARML_API_ACCESS_KEY`: ClearML server api key
* `CLEARML_API_SECRET_KEY`: ClearML server secret key
* `ROUTER_URL`: URL for this router that was previously configured in the load balancer starting with `https://`
* `ROUTER_NAME`: unique name for this router
* `AUTH_ENABLED`: enable or disable http calls authentication when the router is communicating with the ClearML server
* `SSL_VERIFY`: enable or disable SSL certificate validation when the router is communicating with the ClearML server
* `AUTH_COOKIE_NAME`: the cookie name used by the ClearML server to store the ClearML authentication cookie. This can usually be found in the `value_prefix` key starting with `allegro_token` in `envoy.yaml` file in the ClearML server installation (`/opt/allegro/config/envoy/envoy.yaml`) (see below)
* `AUTH_SECURE_ENABLED`: enable the Set-Cookie `secure` parameter
* `AUTH_BASE64_JWKS_KEY`: value form `k` key in the `jwks.json` file in the ClearML server installation
* `LISTEN_QUEUE_NAME`: (optional) name of queue to check for tasks (if none, every task is checked)
* `EXTRA_BASH_COMMAND`: command to be launched before starting the router
* `TCP_ROUTER_ADDRESS`: router external address, can be an IP or the host machine or a load balancer hostname, depends on network configuration
* `TCP_PORT_START`: start port for the TCP Session feature
* `TCP_PORT_END`: end port port for the TCP Session feature
* `ROUTER_NAME`: Unique name for this router
* `AUTH_ENABLED`: Enable or disable http calls authentication when the router is communicating with the ClearML server
* `SSL_VERIFY`: Enable or disable SSL certificate validation when the router is communicating with the ClearML server
* `AUTH_COOKIE_NAME`: Cookie name used by the ClearML server to store the ClearML authentication cookie. This can usually be found in the `value_prefix` key starting with `allegro_token` in `envoy.yaml` file in the ClearML server installation (`/opt/allegro/config/envoy/envoy.yaml`) (see below)
* `AUTH_SECURE_ENABLED`: Enable the Set-Cookie `secure` parameter
* `AUTH_BASE64_JWKS_KEY`: Value form `k` key in the `jwks.json` file in the ClearML server installation
* `LISTEN_QUEUE_NAME`: (*optional*) Name of queue to check for tasks (if none, every task is checked)
* `EXTRA_BASH_COMMAND`: Command to be launched before starting the router
* `TCP_ROUTER_ADDRESS`: Router external address, can be an IP or the host machine or a load balancer hostname, depends on network configuration
* `TCP_PORT_START`: Start port for the TCP Session feature
* `TCP_PORT_END`: End port for the TCP Session feature
Run the following command to start the router:
@ -121,11 +121,11 @@ Run the following command to start the router:
sudo docker compose --env-file runtime.env up -d
```
:::Note How to find my jwkskey
:::note How to find my jwkskey
The *JSON Web Key Set* (*JWKS*) is a set of keys containing the public keys used to verify any JSON Web Token (JWT).
In a docker-compose server installation, this can be found in the `CLEARML__secure__auth__token_secret` env var in the apiserver server component.
In a `docker-compose` server installation, this can be found in the `CLEARML__secure__auth__token_secret` env var in the apiserver server component.
:::

View File

@ -32,9 +32,9 @@ https://raw.githubusercontent.com/clearml/clearml-enterprise-helm-charts/gh-page
--password <GITHUB_TOKEN>
```
### Prepare values
### Prepare Values
Before installing the TTR create an helm-override files named `task-traffic-router.values-override.yaml`:
Before installing the TTR, create a `helm-override` files named `task-traffic-router.values-override.yaml`:
```
imageCredentials:
@ -55,20 +55,20 @@ tcpSession:
end:
```
Edit it accordingly to this guidelines:
Edit it accordingly to these guidelines:
* `clearml.apiServerUrlReference`: url usually starting with `https://api.`
* `clearml.apiServerUrlReference`: URL usually starting with `https://api.`
* `clearml.apiServerKey`: ClearML server api key
* `clearml.apiServerSecret`: ClearML server secret key
* `ingress.hostName`: url of router we configured previously for loadbalancer starting with `https://`
* `clearml.sslVerify`: enable or disable SSL certificate validation on apiserver calls check
* `clearml.authCookieName`: value from `value_prefix` key starting with `allegro_token` in `envoy.yaml` file in ClearML server installation.
* `clearml.jwksKey`: value form `k` key in `jwks.json` file in ClearML server installation (see below)
* `tcpSession.routerAddress`: router external address can be an IP or the host machine or a loadbalancer hostname, depends on the network configuration
* `tcpSession.portRange.start`: start port for the TCP Session feature
* `tcpSession.portRange.end`: end port port for the TCP Session feature
* `ingress.hostName`: URL of router we configured previously for load balancer starting with `https://`
* `clearml.sslVerify`: Enable or disable SSL certificate validation on apiserver calls check
* `clearml.authCookieName`: Value from `value_prefix` key starting with `allegro_token` in `envoy.yaml` file in ClearML server installation.
* `clearml.jwksKey`: Value form `k` key in `jwks.json` file in ClearML server installation (see below)
* `tcpSession.routerAddress`: Router external address can be an IP or the host machine or a load balancer hostname, depends on the network configuration
* `tcpSession.portRange.start`: Start port for the TCP Session feature
* `tcpSession.portRange.end`: End port for the TCP Session feature
::: How to find my jwkskey
:::note How to find my jwkskey
The *JSON Web Key Set* (*JWKS*) is a set of keys containing the public keys used to verify any JSON Web Token (JWT).

View File

@ -36,7 +36,7 @@ them before exporting.
Execute the data tool within the `apiserver` container.
Open a bash session inside the `apiserver` container of the server:
* In docker-compose:
* In `docker-compose`:
```commandline
sudo docker exec -it clearml-apiserver /bin/bash

View File

@ -100,9 +100,10 @@ Install the ClearML chart with the required configuration:
1. Prepare the `overrides.yaml` file and input the following content. Make sure to replace `<BASE_DOMAIN>` and `<SSO_*>`
with a valid domain that will have records pointing to the ingress controller accordingly.
The credentials specified in `<SUPERVISOR_USER_KEY>` and `<SUPERVISOR_USER_SECRET>` can be used to log in as the
supervisor user in the web UI.
supervisor user in the web UI.
Note that the `<SUPERVISOR_USER_EMAIL>` value must be explicitly quoted. To do so, put `\\"` around the quoted value.
For example `"\\"email@example.com\\””`
For example `"\\"email@example.com\\””`.
```
imageCredentials:
@ -192,7 +193,7 @@ Install the ClearML chart with the required configuration:
enabled: true
```
2. Install ClearML
2. Install ClearML:
```
helm install -n clearml \\
@ -305,9 +306,9 @@ spec:
kubernetes.io/metadata.name: clearml
```
## Applications Installation
## Application Installation
To install ClearML GUI applications, follow these steps:
To install ClearML GUI applications:
1. Get the apps to install and the installation script by downloading and extracting the archive provided by ClearML
@ -491,7 +492,7 @@ To install the ClearML Agent Chart, follow these steps:
-d '{"name":"default"}'
```
### Tenant Namespace isolation with NetworkPolicies
### Tenant Namespace Isolation with NetworkPolicies
To ensure network isolation for each tenant, you need to create a `NetworkPolicy` in the tenant namespace. This way
the entire namespace/tenant will not accept any connection from other namespaces.

View File

@ -43,7 +43,7 @@ should be reviewed and modified prior to the server installation
## Installing ClearML Server
### Preliminary Steps
1. Install Docker CE
1. Install Docker CE:
```
https://docs.docker.com/install/linux/docker-ce/ubuntu/
@ -113,10 +113,10 @@ should be reviewed and modified prior to the server installation
sudo systemctl enable disable-thp
```
1. Restart the machine
1. Restart the machine.
### Installing the Server
1. Remove any previous installation of ClearML Server
1. Remove any previous installation of ClearML Server:
```
sudo rm -R /opt/clearml/
@ -141,7 +141,7 @@ should be reviewed and modified prior to the server installation
sudo mkdir -pv /opt/allegro/config/onprem_poc
```
1. Copy the following ClearML configuration files to `/opt/allegro`
1. Copy the following ClearML configuration files to `/opt/allegro`:
* `constants.env`
* `docker-compose.override.yml`
* `docker-compose.yml`
@ -165,10 +165,13 @@ should be reviewed and modified prior to the server installation
sudo docker login -u=$DOCKERHUB_USER -p=$DOCKERHUB_PASSWORD
```
1. Start the `docker-compose` by changing directories to the directory containing the docker-compose files and running the following command:
sudo docker-compose --env-file constants.env up -d
1. Verify web access by browsing to your URL (IP address) and port 8080.
1. Start the `docker-compose` by changing directories to the directory containing the `docker-compose` files and running the following command:
```
sudo docker-compose --env-file constants.env up -d
```
1. Verify web access by browsing to your URL (IP address) and port 8080:
```
http://<server_ip_here>:8080
@ -191,7 +194,10 @@ the following subdomains should be forwarded to the corresponding ports on the s
* `https://app.<domain>` should be forwarded to port 8080
* `https://files.<domain>` should be forwarded to port 8081
:::warning
**Critical: Ensure no other ports are open to maintain the highest level of security.**
:::
Additionally, ensure that the following URLs are correctly configured in the server's environment file:

View File

@ -8,7 +8,7 @@ It covers the following:
* Set up security groups and IAM role
* Create EC2 instance with required disks
* Install dependencies and mount disks
* Deploy ClearML version using docker-compose
* Deploy ClearML version using `docker-compose`
* Set up load balancer and DNS
* Set up server backup
@ -117,10 +117,10 @@ Instance requirements:
## Load Balancer
1. Create a TLS certificate:
1. Choose a domain name to be used with the server. The main URL that will be used by the systems users will be app.\<domain\>
1. Choose a domain name to be used with the server. The main URL that will be used by the systems users will be `app.<domain>`
2. Create a certificate, with the following DNS names:
1. \<domain name\>
2. \*.\<domain name\>
1. `<domain name>`
2. `*.<domain name>`
2. Create the `envoy` target group for the server:
1. Port: 10000
@ -284,7 +284,7 @@ log would usually indicate the reason for the failure.
## Maintenance
### Removing app containers
### Removing App Containers
To remove old application containers, add the following to the cron:

View File

@ -31,7 +31,7 @@ The pip package also includes `clearml-data`. It can help you keep track of your
Both the 2 magic lines and the data tool will send all of their information to a ClearML server. This server then keeps an overview of your experiment runs and data sets over time, so you can always go back to a previous experiment, see how it was created and even recreate it exactly. Keep track of your best models by creating leaderboards based on your own metrics, and you can even directly compare multiple experiment runs, helping you to figure out the best way forward for your models.
To get started with a server right away, you can make use of the free tier. And when your needs grow, we've got you covered too! Just check out our website to find a tier that fits your organisation best. But, because we're open source, you can also host your own completely for free. We have AWS images, Google Cloud images, you can run it on docker-compose locally or even, if you really hate yourself, run it on a self-hosted kubernetes cluster using our helm charts.
To get started with a server right away, you can make use of the free tier. And when your needs grow, we've got you covered too! Just check out our website to find a tier that fits your organisation best. But, because we're open source, you can also host your own completely for free. We have AWS images, Google Cloud images, you can run it on `docker-compose` locally or even, if you really hate yourself, run it on a self-hosted kubernetes cluster using our helm charts.
So, to recap: to get started, all you need is a pip package and a server to store everything. Easy right? But MLOps is much more than experiment and data management. It's also about automation and orchestration, which is exactly where the `clearml-agent` comes into play.

View File

@ -18,22 +18,26 @@ The example does the following:
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots, which are titled **:monitor: machine**.
![image](../../../img/examples_keras_jupyter_08.png)
![Scalars](../../../img/examples_keras_jupyter_08.png#light-mode-only)
![Scalars](../../../img/examples_keras_jupyter_08_dark.png#dark-mode-only)
## Plots
The example calls Matplotlib methods to create several sample plots, and TensorBoard methods to plot histograms for layer density.
They appear in **PLOTS**.
![image](../../../img/examples_keras_jupyter_03.png)
![Plots 1](../../../img/examples_keras_jupyter_03.png#light-mode-only)
![Plots 1](../../../img/examples_keras_jupyter_03_dark.png#dark-mode-only)
![image](../../../img/examples_keras_jupyter_03a.png)
![Plots 2](../../../img/examples_keras_jupyter_03a.png#light-mode-only)
![Plots 2](../../../img/examples_keras_jupyter_03a_dark.png#dark-mode-only)
## Debug Samples
The example calls Matplotlib methods to log debug sample images. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_keras_jupyter_04.png)
![Debug Samples](../../../img/examples_keras_jupyter_04.png#light-mode-only)
![Debug Samples](../../../img/examples_keras_jupyter_04_dark.png#dark-mode-only)
## Hyperparameters
@ -55,17 +59,20 @@ task_params['hidden_dim'] = 512
Parameter dictionaries appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **General**.
![image](../../../img/examples_keras_jupyter_20.png)
![General Hyperparameters](../../../img/examples_keras_jupyter_20.png#light-mode-only)
![General Hyperparameters](../../../img/examples_keras_jupyter_20_dark.png#dark-mode-only)
The TensorFlow Definitions appear in the **TF_DEFINE** subsection.
![image](../../../img/examples_keras_jupyter_21.png)
![TF Define](../../../img/examples_keras_jupyter_21.png#light-mode-only)
![TF Define](../../../img/examples_keras_jupyter_21_dark.png#dark-mode-only)
## Console
Text printed to the console for training appears in **CONSOLE**.
![image](../../../img/examples_keras_jupyter_07.png)
![Console Log](../../../img/examples_keras_jupyter_07.png#light-mode-only)
![Console Log](../../../img/examples_keras_jupyter_07_dark.png#dark-mode-only)
## Artifacts
@ -74,9 +81,11 @@ created using Keras.
The task info panel shows model tracking, including the model name and design in **ARTIFACTS** **>** **Output Model**.
![image](../../../img/examples_keras_jupyter_23.png)
![Artifacts](../../../img/examples_keras_jupyter_23.png#light-mode-only)
![Artifacts](../../../img/examples_keras_jupyter_23_dark.png#dark-mode-only)
Clicking on the model name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can view
the model's details and access the model.
![image](../../../img/examples_keras_jupyter_24.png)
![Model details](../../../img/examples_keras_jupyter_24.png#light-mode-only)
![Model details](../../../img/examples_keras_jupyter_24_dark.png#dark-mode-only)

View File

@ -25,31 +25,36 @@ The example script does the following:
The loss and accuracy metric scalar plots appear in **SCALARS**, along with the resource utilization plots,
which are titled **:monitor: machine**.
![image](../../../img/examples_keras_01.png)
![Scalars](../../../img/examples_keras_01.png#light-mode-only)
![Scalars](../../../img/examples_keras_01_dark.png#dark-mode-only)
## Histograms
Histograms for layer density appear in **PLOTS**.
![image](../../../img/examples_keras_02.png)
![Histograms](../../../img/examples_keras_02.png#light-mode-only)
![Histograms](../../../img/examples_keras_02_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs command line options generated with `argparse`, and TensorFlow Definitions.
ClearML automatically logs command line options generated with `argparse` and TensorFlow Definitions.
Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**.
![image](../../../img/examples_keras_00.png)
![Hyperparameters Args](../../../img/examples_keras_00.png#light-mode-only)
![Hyperparameters Args](../../../img/examples_keras_00_dark.png#dark-mode-only)
TensorFlow Definitions appear in **TF_DEFINE**.
![image](../../../img/examples_keras_00a.png)
![TF Defines](../../../img/examples_keras_00a.png#light-mode-only)
![TF Defines](../../../img/examples_keras_00a_dark.png#dark-mode-only)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/keras_colab_01.png)
![Console Log](../../../img/keras_colab_01.png#light-mode-only)
![Console Log](../../../img/keras_colab_01_dark.png#dark-mode-only)
## Configuration Objects
@ -64,4 +69,5 @@ task.connect_configuration(
It appears in **CONFIGURATION** **>** **CONFIGURATION OBJECTS** **>** **MyConfig**.
![image](../../../img/keras_colab_02.png)
![Custom configuration](../../../img/keras_colab_02.png#light-mode-only)
![Custom configuration](../../../img/keras_colab_02_dark.png#dark-mode-only)

View File

@ -12,16 +12,19 @@ and `matplotlib` to create a scatter diagram. When the script runs, it creates a
ClearML automatically logs the scatter plot, which appears in the [task's page](../../../webapp/webapp_exp_track_visual.md)
in the ClearML web UI, under **PLOTS**.
![image](../../../img/examples_sklearn_joblib_example_06.png)
![Plots](../../../img/examples_sklearn_joblib_example_06.png#light-mode-only)
![Plots](../../../img/examples_sklearn_joblib_example_06_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab.
![image](../../../img/examples_sklearn_joblib_example_01.png)
![Artifacts](../../../img/examples_sklearn_joblib_example_01.png#light-mode-only)
![Artifacts](../../../img/examples_sklearn_joblib_example_01_dark.png#dark-mode-only)
Clicking on the model name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can
view the model's details and access the model.
![image](../../../img/examples_sklearn_joblib_example_02.png)
![Model details](../../../img/examples_sklearn_joblib_example_02.png#light-mode-only)
![Model details](../../../img/examples_sklearn_joblib_example_02_dark.png#dark-mode-only)

View File

@ -16,30 +16,35 @@ The script does the following:
The loss and accuracy metric scalar plots appear in the task's page in the **ClearML web UI**, under
**SCALARS**. The also includes resource utilization plots, which are titled **:monitor: machine**.
![image](../../../img/examples_pytorch_tensorboardx_03.png)
![Scalars](../../../img/examples_pytorch_tensorboardx_03.png#light-mode-only)
![Scalars](../../../img/examples_pytorch_tensorboardx_03_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>**
**HYPERPARAMETERS** **>** **Args**.
![image](../../../img/examples_pytorch_tensorboardx_01.png)
![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_pytorch_tensorboardx_01_dark.png#dark-mode-only)
## Console
Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**.
![image](../../../img/examples_pytorch_tensorboardx_02.png)
![Console log](../../../img/examples_pytorch_tensorboardx_02.png#light-mode-only)
![Console log](../../../img/examples_pytorch_tensorboardx_02_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using PyTorch.
![image](../../../img/examples_pytorch_tensorboardx_04.png)
![Artifacts](../../../img/examples_pytorch_tensorboardx_04.png#light-mode-only)
![Artifacts](../../../img/examples_pytorch_tensorboardx_04_dark.png#dark-mode-only)
Clicking on the model's name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can
view the model's details and access the model.
![image](../../../img/examples_pytorch_tensorboardx_model.png)
![Model details](../../../img/examples_pytorch_tensorboardx_model.png#light-mode-only)
![Model details](../../../img/examples_pytorch_tensorboardx_model_dark.png#dark-mode-only)

View File

@ -14,5 +14,6 @@ the `examples` project.
ClearML automatically captures the video data that is added to the `SummaryWriter` object, using the `add_video` method.
The video appears in the task's **DEBUG SAMPLES** tab.
![Debug Samples](../../../img/examples_tensorboardx_debug.png)
![Debug Samples](../../../img/examples_tensorboardx_debug.png#light-mode-only)
![Debug Samples](../../../img/examples_tensorboardx_debug_dark.png#dark-mode-only)

View File

@ -44,28 +44,33 @@ When the script runs, it logs:
ClearML logs the scalars from training each network. They appear in the task's page in the **ClearML web UI**, under
**SCALARS**.
![image](../../../img/integration_keras_tuner_06.png)
![Scalars](../../../img/integration_keras_tuner_06.png#light-mode-only)
![Scalars](../../../img/integration_keras_tuner_06_dark.png#dark-mode-only)
## Summary of Hyperparameter Optimization
ClearML automatically logs the parameters of each task run in the hyperparameter search. They appear in tabular
form in **PLOTS**.
![image](../../../img/integration_keras_tuner_07.png)
![HPO summary plot](../../../img/integration_keras_tuner_07.png#light-mode-only)
![HPO summary plot](../../../img/integration_keras_tuner_07_dark.png#dark-mode-only)
## Artifacts
ClearML automatically stores the output model. It appears in **ARTIFACTS** **>** **Output Model**.
![image](../../../img/integration_keras_tuner_03.png)
![Artifact](../../../img/integration_keras_tuner_03.png#light-mode-only)
![Artifact](../../../img/integration_keras_tuner_03_dark.png#dark-mode-only)
Model details, such as snap locations, appear in the **MODELS** tab.
![image](../../../img/integration_keras_tuner_04.png)
![Model details](../../../img/integration_keras_tuner_04.png#light-mode-only)
![Model details](../../../img/integration_keras_tuner_04_dark.png#dark-mode-only)
The model configuration is stored with the model.
![image](../../../img/integration_keras_tuner_05.png)
![Model configuration](../../../img/integration_keras_tuner_05.png#light-mode-only)
![Model configuration](../../../img/integration_keras_tuner_05_dark.png#dark-mode-only)
## Configuration Objects
@ -73,12 +78,14 @@ The model configuration is stored with the model.
ClearML automatically logs the TensorFlow Definitions, which appear in **CONFIGURATION** **>** **HYPERPARAMETERS**.
![image](../../../img/integration_keras_tuner_01.png)
![Hyperparameters](../../../img/integration_keras_tuner_01.png#light-mode-only)
![Hyperparameters](../../../img/integration_keras_tuner_01_dark.png#dark-mode-only)
### Configuration
The Task configuration appears in **CONFIGURATION** **>** **General**.
![image](../../../img/integration_keras_tuner_02.png)
![Configuration object](../../../img/integration_keras_tuner_02.png#light-mode-only)
![Configuration object](../../../img/integration_keras_tuner_02_dark.png#dark-mode-only)

View File

@ -20,24 +20,29 @@ In the **ClearML Web UI**, the PR Curve summaries appear in the task's page unde
* Blue PR curves
![image](../../../img/examples_tensorboard_pr_curve_01.png)
![Blue PR curves](../../../img/examples_tensorboard_pr_curve_01.png#light-mode-only)
![Blue PR curves](../../../img/examples_tensorboard_pr_curve_01_dark.png#dark-mode-only)
* Green PR curves
![image](../../../img/examples_tensorboard_pr_curve_02.png)
![Green PR curves](../../../img/examples_tensorboard_pr_curve_02.png#light-mode-only)
![Green PR curves](../../../img/examples_tensorboard_pr_curve_02_dark.png#dark-mode-only)
* Red PR curves
![image](../../../img/examples_tensorboard_pr_curve_03.png)
![Red PR curves](../../../img/examples_tensorboard_pr_curve_03.png#light-mode-only)
![Red PR curves](../../../img/examples_tensorboard_pr_curve_03_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**.
![image](../../../img/examples_tensorboard_pr_curve_04.png)
![Hyperparameters](../../../img/examples_tensorboard_pr_curve_04.png#light-mode-only)
![Hyperparameters](../../../img/examples_tensorboard_pr_curve_04_dark.png#dark-mode-only)
## Console
All other console output appears in **CONSOLE**.
All console output appears in **CONSOLE** tab.
![image](../../../img/examples_tensorboard_pr_curve_05.png)
![Console log](../../../img/examples_tensorboard_pr_curve_05.png#light-mode-only)
![Console log](../../../img/examples_tensorboard_pr_curve_05_dark.png#dark-mode-only)

View File

@ -14,25 +14,29 @@ project.
The `tf.summary.scalar` output appears in the ClearML web UI, in the task's
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
![image](../../../img/examples_tensorboard_toy_03.png)
![Scalars](../../../img/examples_tensorboard_toy_03.png#light-mode-only)
![Scalars](../../../img/examples_tensorboard_toy_03_dark.png#dark-mode-only)
## Plots
The `tf.summary.histogram` output appears in **PLOTS**.
![image](../../../img/examples_tensorboard_toy_04.png)
![Plots](../../../img/examples_tensorboard_toy_04.png#light-mode-only)
![Plots](../../../img/examples_tensorboard_toy_04_dark.png#dark-mode-only)
## Debug Samples
ClearML automatically tracks images and text output to TensorFlow. They appear in **DEBUG SAMPLES**.
![image](../../../img/examples_tensorboard_toy_05.png)
![Debug Samples](../../../img/examples_tensorboard_toy_05.png#light-mode-only)
![Debug Samples](../../../img/examples_tensorboard_toy_05_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>**
**TF_DEFINE**.
![image](../../../img/examples_tensorboard_toy_01.png)
![Hyperparameters](../../../img/examples_tensorboard_toy_01.png#light-mode-only)
![Hyperparameters](../../../img/examples_tensorboard_toy_01_dark.png#dark-mode-only)

View File

@ -13,30 +13,35 @@ When the script runs, it creates a task named `Tensorflow v2 mnist with summarie
The loss and accuracy metric scalar plots appear in the task's page in the **ClearML web UI** under
**SCALARS**. Resource utilization plots, which are titled **:monitor: machine**, also appear in the **SCALARS** tab.
![Task scalars](../../../img/examples_tensorflow_mnist_06.png)
![Task scalars](../../../img/examples_tensorflow_mnist_06.png#light-mode-only)
![Task scalars](../../../img/examples_tensorflow_mnist_06_dark.png#dark-mode-only)
## Hyperparameters
ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS**
**>** **TF_DEFINE**.
![Task hyperparameters](../../../img/examples_tensorflow_mnist_01.png)
![Task hyperparameters](../../../img/examples_tensorflow_mnist_01.png#light-mode-only)
![Task hyperparameters](../../../img/examples_tensorflow_mnist_01_dark.png#dark-mode-only)
## Console
All console output appears in **CONSOLE**.
![Task console](../../../img/examples_tensorflow_mnist_05.png)
![Task console](../../../img/examples_tensorflow_mnist_05.png#light-mode-only)
![Task console](../../../img/examples_tensorflow_mnist_05_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using TensorFlow.
![Task models](../../../img/examples_tensorflow_mnist_03.png)
![Task models](../../../img/examples_tensorflow_mnist_03.png#light-mode-only)
![Task models](../../../img/examples_tensorflow_mnist_03_dark.png#dark-mode-only)
Clicking on a model's name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can
view the model's details and access the model.
![Model details](../../../img/examples_tensorflow_mnist_10.png)
![Model details](../../../img/examples_tensorflow_mnist_10.png#light-mode-only)
![Model details](../../../img/examples_tensorflow_mnist_10_dark.png#dark-mode-only)

View File

@ -13,7 +13,8 @@ the `examples` project.
ClearML automatically captures scalars logged with XGBoost, which can be visualized in plots in the
ClearML WebApp, in the task's **SCALARS** tab.
![Scalars](../../../img/examples_xgboost_metric_scalars.png)
![Scalars](../../../img/examples_xgboost_metric_scalars.png#light-mode-only)
![Scalars](../../../img/examples_xgboost_metric_scalars_dark.png#dark-mode-only)
## Models
@ -21,14 +22,17 @@ ClearML automatically captures the model logged using the `xgboost.save` method,
View saved snapshots in the task's **ARTIFACTS** tab.
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts.png)
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts.png#light-mode-only)
![Artifacts tab](../../../img/examples_xgboost_metric_artifacts_dark.png#dark-mode-only)
To view the model details, click the model name in the **ARTIFACTS** page, which will open the model's info tab. Alternatively, download the model.
![Model info panel](../../../img/examples_xgboost_metric_model.png)
![Model info panel](../../../img/examples_xgboost_metric_model.png#light-mode-only)
![Model info panel](../../../img/examples_xgboost_metric_model_dark.png#dark-mode-only)
## Console
All console output during the script's execution appears in the task's **CONSOLE** page.
![Console output](../../../img/examples_xgboost_metric_console.png)
![Console output](../../../img/examples_xgboost_metric_console.png#light-mode-only)
![Console output](../../../img/examples_xgboost_metric_console_dark.png#dark-mode-only)

View File

@ -18,25 +18,30 @@ classification dataset using XGBoost
The feature importance plot and tree plot appear in the task's page in the **ClearML web UI**, under
**PLOTS**.
![Feature importance plot](../../../img/examples_xgboost_sample_06.png)
![Feature importance plot](../../../img/examples_xgboost_sample_06.png#light-mode-only)
![Feature importance plot](../../../img/examples_xgboost_sample_06_dark.png#dark-mode-only)
![Tree plot](../../../img/examples_xgboost_sample_06a.png)
![Tree plot](../../../img/examples_xgboost_sample_06a.png#light-mode-only)
![Tree plot](../../../img/examples_xgboost_sample_06a_dark.png#dark-mode-only)
## Console
All other console output appear in **CONSOLE**.
![image](../../../img/examples_xgboost_sample_05.png)
![Console log](../../../img/examples_xgboost_sample_05.png#light-mode-only)
![Console log](../../../img/examples_xgboost_sample_05_dark.png#dark-mode-only)
## Artifacts
Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks
models and any snapshots created using XGBoost.
![image](../../../img/examples_xgboost_sample_10.png)
![Artifacts](../../../img/examples_xgboost_sample_10.png#light-mode-only)
![Artifacts](../../../img/examples_xgboost_sample_10_dark.png#dark-mode-only)
Clicking on the model's name takes you to the [model's page](../../../webapp/webapp_model_viewing.md), where you can
view the model's details and access the model.
![image](../../../img/examples_xgboost_sample_03.png)
![Model details](../../../img/examples_xgboost_sample_03.png#light-mode-only)
![Model details](../../../img/examples_xgboost_sample_03_dark.png#dark-mode-only)

Binary file not shown.

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 86 KiB

After

Width:  |  Height:  |  Size: 76 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 129 KiB

After

Width:  |  Height:  |  Size: 120 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 126 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 119 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

After

Width:  |  Height:  |  Size: 104 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 107 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 90 KiB

After

Width:  |  Height:  |  Size: 99 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 39 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 269 KiB

After

Width:  |  Height:  |  Size: 128 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 130 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 120 KiB

After

Width:  |  Height:  |  Size: 118 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 123 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 88 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 94 KiB

After

Width:  |  Height:  |  Size: 72 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 48 KiB

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 42 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 46 KiB

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 54 KiB

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 85 KiB

After

Width:  |  Height:  |  Size: 68 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 70 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

After

Width:  |  Height:  |  Size: 48 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 73 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 108 KiB

After

Width:  |  Height:  |  Size: 97 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 98 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 103 KiB

After

Width:  |  Height:  |  Size: 174 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 185 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 221 KiB

After

Width:  |  Height:  |  Size: 388 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 387 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 29 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 76 KiB

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 35 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 262 KiB

After

Width:  |  Height:  |  Size: 113 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 70 KiB

After

Width:  |  Height:  |  Size: 112 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 59 KiB

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 34 KiB

After

Width:  |  Height:  |  Size: 38 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 39 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 50 KiB

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 53 KiB

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 59 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 49 KiB

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Some files were not shown because too many files have changed in this diff Show More