diff --git a/docs/clearml_data/data_management_examples/data_man_cifar_classification.md b/docs/clearml_data/data_management_examples/data_man_cifar_classification.md index 1e4cc2a3..860c5af6 100644 --- a/docs/clearml_data/data_management_examples/data_man_cifar_classification.md +++ b/docs/clearml_data/data_management_examples/data_man_cifar_classification.md @@ -68,7 +68,8 @@ reproducibility. Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png#light-mode-only) +![Dataset content tab](../../img/examples_data_management_cifar_dataset_dark.png#dark-mode-only) ## Using the Dataset diff --git a/docs/clearml_data/data_management_examples/data_man_python.md b/docs/clearml_data/data_management_examples/data_man_python.md index c8e5ea14..5d4adc06 100644 --- a/docs/clearml_data/data_management_examples/data_man_python.md +++ b/docs/clearml_data/data_management_examples/data_man_python.md @@ -79,7 +79,8 @@ After a dataset has been closed, it can no longer be modified. This ensures futu Information about the dataset can be viewed in the WebApp, in the dataset's [details panel](../../webapp/datasets/webapp_dataset_viewing.md#version-details-panel). In the panel's **CONTENT** tab, you can see a table summarizing version contents, including file names, file sizes, and hashes. -![Dataset content tab](../../img/examples_data_management_cifar_dataset.png) +![Dataset content tab](../../img/examples_data_management_cifar_dataset.png#light-mode-only) +![Dataset content tab](../../img/examples_data_management_cifar_dataset_dark.png#dark-mode-only) ## Data Ingestion diff --git a/docs/deploying_clearml/clearml_server_config.md b/docs/deploying_clearml/clearml_server_config.md index 014161cc..09b4e835 100644 --- a/docs/deploying_clearml/clearml_server_config.md +++ b/docs/deploying_clearml/clearml_server_config.md @@ -361,10 +361,16 @@ You can also use hashed passwords instead of plain-text passwords. To do that: ### Non-responsive Task Watchdog -The non-responsive task watchdog monitors tasks that were not updated for a specified time interval, and then -the watchdog marks them as `aborted`. The non-responsive experiment watchdog is always active. +The non-responsive task watchdog monitors for running tasks that have stopped communicating with the ClearML Server for a specified +time interval. If a task remains unresponsive beyond the set threshold, the watchdog marks it as `aborted`. -Modify the following settings for the watchdog: +A task is considered non-responsive if the time since its last communication with the ClearML Server exceeds the +configured threshold. The watchdog starts counting after each successful communication with the server. If no further +updates are received within the specified time, the task is considered non-responsive. This typically happens if: +* The task's main process is stuck but has not exited. +* There is a network issue preventing the task from communicating with the server. + +You can configure the following watchdog settings: * Watchdog status - enabled / disabled * The time threshold (in seconds) of experiment inactivity (default value is 7200 seconds (2 hours)). @@ -372,10 +378,15 @@ Modify the following settings for the watchdog: **To configure the non-responsive watchdog for the ClearML Server:** -1. In the ClearML Server `/opt/clearml/config/services.conf` file, add or edit the `tasks.non_responsive_tasks_watchdog` - section and specify the watchdog settings. +1. Open the ClearML Server `/opt/clearml/config/services.conf` file. + + :::tip + If the `services.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or + an alternate folder you configured). + ::: + +1. Add or edit the `tasks.non_responsive_tasks_watchdog` section and specify the watchdog settings. For example: - For example: ``` tasks { non_responsive_tasks_watchdog { @@ -389,11 +400,6 @@ Modify the following settings for the watchdog: } } ``` - - :::tip - If the `services.conf` file does not exist, create your own in ClearML Server's `/opt/clearml/config` directory (or - an alternate folder you configured), and input the modified configuration - ::: 1. Restart ClearML Server. diff --git a/docs/faq.md b/docs/faq.md index 3b5f642c..097a25ea 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -137,7 +137,8 @@ the following numbers are displayed: * API server version * API version -![Server version information](img/faq_server_versions.png) +![Server version information](img/faq_server_versions.png#light-mode-only) +![Server version information](img/faq_server_versions_dark.png#dark-mode-only) ClearML Python package information can be obtained by using `pip freeze`. @@ -593,7 +594,8 @@ Due to speed/optimization issues, the console displays only the last several hun You can always download the full log as a file using the ClearML Web UI. In the **ClearML Web UI >** task's **CONSOLE** tab, click `Download full log`. -![Download console log](img/faq_download_console_log.png) +![Download console log](img/faq_download_console_log.png#light-mode-only) +![Download console log](img/faq_download_console_log_dark.png#dark-mode-only)
@@ -604,17 +606,19 @@ and accuracy values of several tasks. In the task comparison page, under the **H you can visualize tasks' hyperparameter values in relation to performance metrics in a scatter plot or parallel coordinates plot: * [Scatter plot](webapp/webapp_exp_comparing.md#scatter-plot): View the correlation between a selected hyperparameter and - metric. For example, the image below shows a scatter plot that displays the values of a performance metric (`epoch_accuracy`) + metric. For example, the image below shows a scatter plot that displays the values of a performance metric (`accuracy`) and a hyperparameter (`epochs`) of a few tasks: - ![Scatter plot comparison](img/faq_compare_scatter.png) + ![Scatter plot comparison](img/faq_compare_scatter.png#light-mode-only) + ![Scatter plot comparison](img/faq_compare_scatter_dark.png#dark-mode-only) * [Parallel coordinates plot](webapp/webapp_exp_comparing.md#parallel-coordinates-mode): View the impact of hyperparameters on selected metric(s). For example, the image below shows - a parallel coordinates plot which displays the values of selected hyperparameters (`base_lr`, `batch_size`, and - `number_of_epochs`) and a performance metric (`accuracy`) of three tasks: + a parallel coordinates plot which displays the values of selected hyperparameters (`epochs`, `lr`, and `batch_size`) + and a performance metric (`accuracy`) of a few tasks: - ![Parallel Coordinates](img/compare_parallel_coordinates.png) + ![Parallel Coordinates](img/compare_parallel_coordinates.png#light-mode-only) + ![Parallel Coordinates](img/compare_parallel_coordinates_dark.png#dark-mode-only)
diff --git a/docs/guides/advanced/execute_remotely.md b/docs/guides/advanced/execute_remotely.md index 9502deb1..171dffb4 100644 --- a/docs/guides/advanced/execute_remotely.md +++ b/docs/guides/advanced/execute_remotely.md @@ -57,24 +57,28 @@ Logger.current_logger().report_scalar( These scalars can be visualized in plots, which appear in the ClearML web UI, in the task's **SCALARS** tab. -![Task Scalars](../../img/examples_pytorch_mnist_07.png) +![Task Scalars](../../img/examples_pytorch_mnist_07.png#light-mode-only) +![Task Scalars](../../img/examples_pytorch_mnist_07_dark.png#dark-mode-only) ## Hyperparameters ClearML automatically logs command line options defined with `argparse`. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. -![Task hyperparameters](../../img/examples_pytorch_mnist_01.png) +![Task hyperparameters](../../img/examples_pytorch_mnist_01.png#light-mode-only) +![Task hyperparameters](../../img/examples_pytorch_mnist_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**. -![Task console log](../../img/examples_pytorch_mnist_06.png) +![Task console log](../../img/examples_pytorch_mnist_06.png#light-mode-only) +![Task console log](../../img/examples_pytorch_mnist_06_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. -![Task artifacts](../../img/examples_remote_execution_artifacts.png) +![Task artifacts](../../img/examples_remote_execution_artifacts.png#light-mode-only) +![Task artifacts](../../img/examples_remote_execution_artifacts_dark.png#dark-mode-only) diff --git a/docs/guides/automation/manual_random_param_search_example.md b/docs/guides/automation/manual_random_param_search_example.md index fd71f4ba..36e94ebd 100644 --- a/docs/guides/automation/manual_random_param_search_example.md +++ b/docs/guides/automation/manual_random_param_search_example.md @@ -31,4 +31,5 @@ the `examples` project. This starts the parameter search, and creates the tasks: When these tasks are completed, their [results can be compared](../../webapp/webapp_exp_comparing.md). -![Comparison parallel coordinates](../../img/examples_hpo_parallel_coordinates.png) \ No newline at end of file +![Comparison parallel coordinates](../../img/examples_hpo_parallel_coordinates.png#light-mode-only) +![Comparison parallel coordinates](../../img/examples_hpo_parallel_coordinates_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/distributed/distributed_pytorch_example.md b/docs/guides/distributed/distributed_pytorch_example.md index c57e0341..a972e9ac 100644 --- a/docs/guides/distributed/distributed_pytorch_example.md +++ b/docs/guides/distributed/distributed_pytorch_example.md @@ -34,7 +34,8 @@ Task.current_task().upload_artifact( All of these artifacts appear in the main Task under **ARTIFACTS** **>** **OTHER**. -![Task artifacts](../../img/examples_pytorch_distributed_example_09.png) +![Task artifacts](../../img/examples_pytorch_distributed_example_09.png#light-mode-only) +![Task artifacts](../../img/examples_pytorch_distributed_example_09_dark.png#dark-mode-only) ## Scalars @@ -54,7 +55,8 @@ Task.current_task().get_logger().report_scalar( The single scalar plot for loss appears in **SCALARS**. -![Task scalars](../../img/examples_pytorch_distributed_example_08.png) +![Task scalars](../../img/examples_pytorch_distributed_example_08.png#light-mode-only) +![Task scalars](../../img/examples_pytorch_distributed_example_08_dark.png#dark-mode-only) ## Hyperparameters @@ -69,12 +71,15 @@ Task.current_task().connect(param) All the hyperparameters appear in **CONFIGURATION** **>** **HYPERPARAMETERS**. -![Task hyperparameters Args](../../img/examples_pytorch_distributed_example_01.png) +![Task hyperparameters Args](../../img/examples_pytorch_distributed_example_01.png#light-mode-only) +![Task hyperparameters Args](../../img/examples_pytorch_distributed_example_01_dark.png#dark-mode-only) -![Task hyperparameters General ](../../img/examples_pytorch_distributed_example_01a.png) +![Task hyperparameters General ](../../img/examples_pytorch_distributed_example_02.png#light-mode-only) +![Task hyperparameters General ](../../img/examples_pytorch_distributed_example_02_dark.png#dark-mode-only) ## Console Output to the console, including the text messages printed from the main Task object and each subprocess appear in **CONSOLE**. -![Task console log](../../img/examples_pytorch_distributed_example_06.png) \ No newline at end of file +![Task console log](../../img/examples_pytorch_distributed_example_06.png#light-mode-only) +![Task console log](../../img/examples_pytorch_distributed_example_06_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/distributed/subprocess_example.md b/docs/guides/distributed/subprocess_example.md index 42eab687..4f9c80c4 100644 --- a/docs/guides/distributed/subprocess_example.md +++ b/docs/guides/distributed/subprocess_example.md @@ -26,14 +26,17 @@ Task.current_task().connect(additional_parameters) Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. -![image](../../img/examples_subprocess_example_01.png) +![Hyperparameter Args](../../img/examples_subprocess_example_01.png#light-mode-only) +![Hyperparameter Args](../../img/examples_subprocess_example_01_dark.png#dark-mode-only) Parameter dictionaries appear in **General**. -![image](../../img/examples_subprocess_example_01a.png) +![Hyperparameter General](../../img/examples_subprocess_example_01a.png#light-mode-only) +![Hyperparameter General](../../img/examples_subprocess_example_01a_dark.png#dark-mode-only) ## Console Output to the console, including the text messages from the Task in each subprocess, appear in **CONSOLE**. -![image](../../img/examples_subprocess_example_02.png) \ No newline at end of file +![Console](../../img/examples_subprocess_example_02.png#light-mode-only) +![Console](../../img/examples_subprocess_example_02_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/frameworks/catboost/catboost.md b/docs/guides/frameworks/catboost/catboost.md index 2c6b0aeb..365cea5a 100644 --- a/docs/guides/frameworks/catboost/catboost.md +++ b/docs/guides/frameworks/catboost/catboost.md @@ -15,25 +15,30 @@ The example script does the following: ClearML automatically captures scalars logged by CatBoost. These scalars can be visualized in plots, which appear in the [ClearML web UI](../../../webapp/webapp_overview.md), in the task's **SCALARS** tab. -![Task scalars](../../../img/examples_catboost_scalars.png) +![Task scalars](../../../img/examples_catboost_scalars.png#light-mode-only) +![Task scalars](../../../img/examples_catboost_scalars_dark.png#dark-mode-only) ## Hyperparameters ClearML automatically logs command line options defined with argparse. They appear in **CONFIGURATIONS > HYPERPARAMETERS > Args**. -![Task hyperparameters](../../../img/examples_catboost_configurations.png) +![Task hyperparameters](../../../img/examples_catboost_configurations.png#light-mode-only) +![Task hyperparameters](../../../img/examples_catboost_configurations_dark.png#dark-mode-only) ## Console Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**. -![Task console](../../../img/examples_catboost_console.png) +![Task console](../../../img/examples_catboost_console.png#light-mode-only) +![Task console](../../../img/examples_catboost_console_dark.png#dark-mode-only) ## Artifacts Models created by the task appear in the task's **ARTIFACTS** tab. ClearML automatically logs and tracks models created using CatBoost. -![Task artifacts](../../../img/examples_catboost_artifacts.png) +![Task artifacts](../../../img/examples_catboost_artifacts.png#light-mode-only) +![Task artifacts](../../../img/examples_catboost_artifacts_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. -![Model page](../../../img/examples_catboost_model.png) +![Model page](../../../img/examples_catboost_model.png#light-mode-only) +![Model page](../../../img/examples_catboost_model_dark.png#dark-mode-only) diff --git a/docs/guides/frameworks/fastai/fastai_with_tensorboard.md b/docs/guides/frameworks/fastai/fastai_with_tensorboard.md index 1b58978e..59b9fd3c 100644 --- a/docs/guides/frameworks/fastai/fastai_with_tensorboard.md +++ b/docs/guides/frameworks/fastai/fastai_with_tensorboard.md @@ -18,16 +18,19 @@ The example code does the following: ClearML automatically logs the histogram output to TensorBoard. They appear in **PLOTS**. -![image](../../../img/examples_reporting_fastai_01.png) +![Scalars](../../../img/examples_reporting_fastai_01.png#light-mode-only) +![Scalars](../../../img/examples_reporting_fastai_01_dark.png#dark-mode-only) ## Plots Histograms output to TensorBoard. They appear in **PLOTS**. -![image](../../../img/examples_reporting_fastai_02.png) +![Plots](../../../img/examples_reporting_fastai_02.png#light-mode-only) +![Plots](../../../img/examples_reporting_fastai_02_dark.png#dark-mode-only) ## Logs Text printed to the console for training progress, as well as all other console output, appear in **CONSOLE**. -![image](../../../img/examples_reporting_fastai_03.png) +![Console](../../../img/examples_reporting_fastai_03.png#light-mode-only) +![Console](../../../img/examples_reporting_fastai_03_dark.png#dark-mode-only) diff --git a/docs/guides/frameworks/huggingface/transformers.md b/docs/guides/frameworks/huggingface/transformers.md index c095f3a9..a9a96ade 100644 --- a/docs/guides/frameworks/huggingface/transformers.md +++ b/docs/guides/frameworks/huggingface/transformers.md @@ -36,7 +36,8 @@ ClearML captures all of the `TrainingArguments` passed to the Trainer. View these parameters in the task's **CONFIGURATION** tab **> Hyperparameters** section. -![Transformers params](../../../img/examples_transformers_params.png) +![Transformers params](../../../img/examples_transformers_params.png#light-mode-only) +![Transformers params](../../../img/examples_transformers_params_dark.png#dark-mode-only) ### Models @@ -47,10 +48,12 @@ variable is set to `True`. ClearML automatically captures the model snapshots created by the Trainer, and saves them as artifacts. View the snapshots in the task's **ARTIFACTS** tab. -![Transformers models](../../../img/examples_transformers_artifacts.png) +![Transformers models](../../../img/examples_transformers_artifacts.png#light-mode-only) +![Transformers models](../../../img/examples_transformers_artifacts_dark.png#dark-mode-only) ### Scalars ClearML automatically captures the Trainer's scalars, which can be viewed in the task's **Scalars** tab. -![Transformers scalars](../../../img/integrations_transformers_scalars.png) +![Transformers scalars](../../../img/integrations_transformers_scalars.png#light-mode-only) +![Transformers scalars](../../../img/integrations_transformers_scalars_dark.png#dark-mode-only) diff --git a/docs/guides/frameworks/pytorch/model_updating.md b/docs/guides/frameworks/pytorch/model_updating.md index 4822eed8..cb5360a7 100644 --- a/docs/guides/frameworks/pytorch/model_updating.md +++ b/docs/guides/frameworks/pytorch/model_updating.md @@ -83,18 +83,22 @@ if CONDITION: ## WebApp The model appears in the task's **ARTIFACTS** tab. -![Task artifacts](../../../img/examples_model_update_artifacts.png) +![Task artifacts](../../../img/examples_model_update_artifacts.png#light-mode-only) +![Task artifacts](../../../img/examples_model_update_artifacts_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. -![Model page](../../../img/examples_model_update_model.png) +![Model page](../../../img/examples_model_update_model.png#light-mode-only) +![Model page](../../../img/examples_model_update_model_dark.png#dark-mode-only) The model's **NETWORK** tab displays its configuration. -![Model network tab](../../../img/examples_model_update_network.png) +![Model network tab](../../../img/examples_model_update_network.png#light-mode-only) +![Model network tab](../../../img/examples_model_update_network_dark.png#dark-mode-only) The model's **LABELS** tab displays its label enumeration. -![Model labels](../../../img/examples_model_update_labels.png) +![Model labels](../../../img/examples_model_update_labels.png#light-mode-only) +![Model labels](../../../img/examples_model_update_labels_dark.png#dark-mode-only) diff --git a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md index 31f63da4..1b81edf1 100644 --- a/docs/guides/frameworks/pytorch/pytorch_distributed_example.md +++ b/docs/guides/frameworks/pytorch/pytorch_distributed_example.md @@ -35,7 +35,8 @@ Task.current_task().upload_artifact( All of these artifacts appear in the main Task, **ARTIFACTS** **>** **OTHER**. -![image](../../../img/examples_pytorch_distributed_example_09.png) +![Artifacts](../../../img/examples_pytorch_distributed_example_09.png#light-mode-only) +![Artifacts](../../../img/examples_pytorch_distributed_example_09_dark.png#dark-mode-only) ## Scalars @@ -54,7 +55,8 @@ Task.current_task().get_logger().report_scalar( The single scalar plot for loss appears in **SCALARS**. -![image](../../../img/examples_pytorch_distributed_example_08.png) +![Scalars](../../../img/examples_pytorch_distributed_example_08.png#light-mode-only) +![Scalars](../../../img/examples_pytorch_distributed_example_08_dark.png#dark-mode-only) ## Hyperparameters @@ -69,7 +71,8 @@ Task.current_task().connect(param) Command line options appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **Args**. -![image](../../../img/examples_pytorch_distributed_example_01.png) +![Hyperparamter Args](../../../img/examples_pytorch_distributed_example_01.png#light-mode-only) +![Hyperparamter Args](../../../img/examples_pytorch_distributed_example_01_dark.png#dark-mode-only) Parameter dictionaries appear in the **General** section of **HYPERPARAMETERS**. @@ -78,10 +81,12 @@ param = {'worker_{}_stuff'.format(dist.get_rank()): 'some stuff ' + str(randint( Task.current_task().connect(param) ``` -![image](../../../img/examples_pytorch_distributed_example_02.png) +![Hyperparameter General args](../../../img/examples_pytorch_distributed_example_02.png#light-mode-only) +![Hyperparameter General args](../../../img/examples_pytorch_distributed_example_02_dark.png#dark-mode-only) ## Log Output to the console, including the text messages printed from the main Task object and each subprocess, appears in **CONSOLE**. -![image](../../../img/examples_pytorch_distributed_example_06.png) \ No newline at end of file +![Console log](../../../img/examples_pytorch_distributed_example_06.png#light-mode-only) +![Console log](../../../img/examples_pytorch_distributed_example_06_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/frameworks/pytorch/pytorch_matplotlib.md b/docs/guides/frameworks/pytorch/pytorch_matplotlib.md index afc20955..0e580fd7 100644 --- a/docs/guides/frameworks/pytorch/pytorch_matplotlib.md +++ b/docs/guides/frameworks/pytorch/pytorch_matplotlib.md @@ -14,15 +14,18 @@ The example does the following: The images shown in the example script's `imshow` function appear according to metric in **DEBUG SAMPLES**. -![image](../../../img/examples_pytorch_matplotlib_02.png) +![Debug samples](../../../img/examples_pytorch_matplotlib_02.png#light-mode-only) +![Debug samples](../../../img/examples_pytorch_matplotlib_02_dark.png#dark-mode-only) Select a debug sample by metric. -![image](../../../img/examples_pytorch_matplotlib_02a.png) +![Debug sample selection](../../../img/examples_pytorch_matplotlib_02a.png#light-mode-only) +![Debug sample selection](../../../img/examples_pytorch_matplotlib_02a_dark.png#dark-mode-only) -Open the debug sample in the image viewer. +Click a debug sample to view it in the image viewer. -![image](../../../img/examples_pytorch_matplotlib_02b.png) +![Debug sample image viewer](../../../img/examples_pytorch_matplotlib_02b.png#light-mode-only) +![Debug sample image viewer](../../../img/examples_pytorch_matplotlib_02b_dark.png#dark-mode-only) diff --git a/docs/guides/frameworks/pytorch/pytorch_mnist.md b/docs/guides/frameworks/pytorch/pytorch_mnist.md index ec46c3e6..aae3ed37 100644 --- a/docs/guides/frameworks/pytorch/pytorch_mnist.md +++ b/docs/guides/frameworks/pytorch/pytorch_mnist.md @@ -36,28 +36,33 @@ Logger.current_logger().report_scalar( These scalars can be visualized in plots, which appear in the ClearML [web UI](../../../webapp/webapp_overview.md), in the task's **SCALARS** tab. -![image](../../../img/examples_pytorch_mnist_07.png) +![Scalars](../../../img/examples_pytorch_mnist_07.png#light-mode-only) +![Scalars](../../../img/examples_pytorch_mnist_07_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_mnist_01.png) +![Hyperparameters](../../../img/examples_pytorch_mnist_01.png#light-mode-only) +![Hyperparameters](../../../img/examples_pytorch_mnist_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_mnist_06.png) +![Console Log](../../../img/examples_pytorch_mnist_06.png#light-mode-only) +![Console Log](../../../img/examples_pytorch_mnist_06_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_mnist_02.png) +![Models](../../../img/examples_pytorch_mnist_02.png#light-mode-only) +![Models](../../../img/examples_pytorch_mnist_02_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_pytorch_mnist_03.png) \ No newline at end of file +![Model details](../../../img/examples_pytorch_mnist_03.png#light-mode-only) +![Model details](../../../img/examples_pytorch_mnist_03_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/frameworks/pytorch/pytorch_tensorboard.md b/docs/guides/frameworks/pytorch/pytorch_tensorboard.md index 2dec7c79..41b282c0 100644 --- a/docs/guides/frameworks/pytorch/pytorch_tensorboard.md +++ b/docs/guides/frameworks/pytorch/pytorch_tensorboard.md @@ -18,34 +18,40 @@ In the example script, the `train` and `test` functions call the TensorBoard `Su These scalars, along with the resource utilization plots, which are titled **:monitor: machine**, appear in the task's page in the [ClearML web UI](../../../webapp/webapp_overview.md) under **SCALARS**. -![image](../../../img/examples_pytorch_tensorboard_07.png) +![Scalars](../../../img/examples_pytorch_tensorboard_07.png#light-mode-only) +![Scalars](../../../img/examples_pytorch_tensorboard_07_dark.png#dark-mode-only) ## Debug Samples ClearML automatically tracks images and text output to TensorFlow. They appear in **DEBUG SAMPLES**. -![image](../../../img/examples_pytorch_tensorboard_08.png) +![Debug Samples](../../../img/examples_pytorch_tensorboard_08.png#light-mode-only) +![Debug Samples](../../../img/examples_pytorch_tensorboard_08_dark.png#dark-mode-only) ## Hyperparameters ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. -![image](../../../img/examples_pytorch_tensorboard_01.png) +![Hyperparameters](../../../img/examples_pytorch_tensorboard_01.png#light-mode-only) +![Hyperparameters](../../../img/examples_pytorch_tensorboard_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_tensorboard_06.png) +![Console Log](../../../img/examples_pytorch_tensorboard_06.png#light-mode-only) +![Console Log](../../../img/examples_pytorch_tensorboard_06_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_tensorboard_02.png) +![Artifacts](../../../img/examples_pytorch_tensorboard_02.png#light-mode-only) +![Artifacts](../../../img/examples_pytorch_tensorboard_02_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. -![image](../../../img/examples_pytorch_tensorboard_03.png) \ No newline at end of file +![Model details](../../../img/examples_pytorch_tensorboard_03.png#light-mode-only) +![Model details](../../../img/examples_pytorch_tensorboard_03_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md b/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md index 6bc91d63..d1f08722 100644 --- a/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md +++ b/docs/guides/frameworks/pytorch/pytorch_tensorboardx.md @@ -18,29 +18,34 @@ The loss and accuracy metric scalar plots, along with the resource utilization p appear in the task's page in the [web UI](../../../webapp/webapp_overview.md), under **SCALARS**. -![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) ## Log 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 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) diff --git a/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md b/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md index dcde66a8..cf17ac86 100644 --- a/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md +++ b/docs/guides/frameworks/pytorch/tensorboard_toy_pytorch.md @@ -11,10 +11,12 @@ associated with the `examples` project. The debug sample images appear according to metric, in the task's **DEBUG SAMPLES** tab. -![image](../../../img/examples_tensorboard_toy_pytorch_02.png) +![Debug samples](../../../img/examples_tensorboard_toy_pytorch_02.png#light-mode-only) +![Debug samples](../../../img/examples_tensorboard_toy_pytorch_02_dark.png#dark-mode-only) ## Hyperparameters ClearML automatically logs TensorFlow Definitions. They appear in **CONFIGURATION** **>** **HYPERPARAMETERS** **>** **TF_DEFINE**. -![image](../../../img/examples_tensorboard_toy_pytorch_00.png) \ No newline at end of file +![Hyperparameters](../../../img/examples_tensorboard_toy_pytorch_00.png#light-mode-only) +![Hyperparameters](../../../img/examples_tensorboard_toy_pytorch_00_dark.png#dark-mode-only) \ No newline at end of file diff --git a/docs/img/apps_hpo.png b/docs/img/apps_hpo.png deleted file mode 100644 index 01529f0d..00000000 Binary files a/docs/img/apps_hpo.png and /dev/null differ diff --git a/docs/img/compare_parallel_coordinates.png b/docs/img/compare_parallel_coordinates.png index 4b3b1283..81a265c9 100644 Binary files a/docs/img/compare_parallel_coordinates.png and b/docs/img/compare_parallel_coordinates.png differ diff --git a/docs/img/compare_parallel_coordinates_dark.png b/docs/img/compare_parallel_coordinates_dark.png new file mode 100644 index 00000000..dcc24c6d Binary files /dev/null and b/docs/img/compare_parallel_coordinates_dark.png differ diff --git a/docs/img/examples_catboost_artifacts.png b/docs/img/examples_catboost_artifacts.png index c2110cda..931e7fde 100644 Binary files a/docs/img/examples_catboost_artifacts.png and b/docs/img/examples_catboost_artifacts.png differ diff --git a/docs/img/examples_catboost_artifacts_dark.png b/docs/img/examples_catboost_artifacts_dark.png new file mode 100644 index 00000000..40fee1b5 Binary files /dev/null and b/docs/img/examples_catboost_artifacts_dark.png differ diff --git a/docs/img/examples_catboost_configurations.png b/docs/img/examples_catboost_configurations.png index a8272ce0..3e7823ca 100644 Binary files a/docs/img/examples_catboost_configurations.png and b/docs/img/examples_catboost_configurations.png differ diff --git a/docs/img/examples_catboost_configurations_dark.png b/docs/img/examples_catboost_configurations_dark.png new file mode 100644 index 00000000..168c34b9 Binary files /dev/null and b/docs/img/examples_catboost_configurations_dark.png differ diff --git a/docs/img/examples_catboost_console.png b/docs/img/examples_catboost_console.png index 52643fca..940433b0 100644 Binary files a/docs/img/examples_catboost_console.png and b/docs/img/examples_catboost_console.png differ diff --git a/docs/img/examples_catboost_console_dark.png b/docs/img/examples_catboost_console_dark.png new file mode 100644 index 00000000..b8b684fe Binary files /dev/null and b/docs/img/examples_catboost_console_dark.png differ diff --git a/docs/img/examples_catboost_model.png b/docs/img/examples_catboost_model.png index 70a4909b..b66a8443 100644 Binary files a/docs/img/examples_catboost_model.png and b/docs/img/examples_catboost_model.png differ diff --git a/docs/img/examples_catboost_model_dark.png b/docs/img/examples_catboost_model_dark.png new file mode 100644 index 00000000..3470c59a Binary files /dev/null and b/docs/img/examples_catboost_model_dark.png differ diff --git a/docs/img/examples_catboost_scalars.png b/docs/img/examples_catboost_scalars.png index 28a53003..580eb933 100644 Binary files a/docs/img/examples_catboost_scalars.png and b/docs/img/examples_catboost_scalars.png differ diff --git a/docs/img/examples_catboost_scalars_dark.png b/docs/img/examples_catboost_scalars_dark.png new file mode 100644 index 00000000..3daa8f9c Binary files /dev/null and b/docs/img/examples_catboost_scalars_dark.png differ diff --git a/docs/img/examples_data_management_cifar_dataset.png b/docs/img/examples_data_management_cifar_dataset.png index 57d229a4..04fd9674 100644 Binary files a/docs/img/examples_data_management_cifar_dataset.png and b/docs/img/examples_data_management_cifar_dataset.png differ diff --git a/docs/img/examples_data_management_cifar_dataset_dark.png b/docs/img/examples_data_management_cifar_dataset_dark.png new file mode 100644 index 00000000..9b122dc0 Binary files /dev/null and b/docs/img/examples_data_management_cifar_dataset_dark.png differ diff --git a/docs/img/examples_hpo_parallel_coordinates.png b/docs/img/examples_hpo_parallel_coordinates.png index 7627d8a5..8cf953a4 100644 Binary files a/docs/img/examples_hpo_parallel_coordinates.png and b/docs/img/examples_hpo_parallel_coordinates.png differ diff --git a/docs/img/examples_hpo_parallel_coordinates_dark.png b/docs/img/examples_hpo_parallel_coordinates_dark.png new file mode 100644 index 00000000..bf21644c Binary files /dev/null and b/docs/img/examples_hpo_parallel_coordinates_dark.png differ diff --git a/docs/img/examples_model_update_artifacts.png b/docs/img/examples_model_update_artifacts.png index eee2aa00..25d5d385 100644 Binary files a/docs/img/examples_model_update_artifacts.png and b/docs/img/examples_model_update_artifacts.png differ diff --git a/docs/img/examples_model_update_artifacts_dark.png b/docs/img/examples_model_update_artifacts_dark.png new file mode 100644 index 00000000..36b1e74b Binary files /dev/null and b/docs/img/examples_model_update_artifacts_dark.png differ diff --git a/docs/img/examples_model_update_labels.png b/docs/img/examples_model_update_labels.png index 41edc686..600d968a 100644 Binary files a/docs/img/examples_model_update_labels.png and b/docs/img/examples_model_update_labels.png differ diff --git a/docs/img/examples_model_update_labels_dark.png b/docs/img/examples_model_update_labels_dark.png new file mode 100644 index 00000000..f666147b Binary files /dev/null and b/docs/img/examples_model_update_labels_dark.png differ diff --git a/docs/img/examples_model_update_model.png b/docs/img/examples_model_update_model.png index 60d8083b..b7d4b981 100644 Binary files a/docs/img/examples_model_update_model.png and b/docs/img/examples_model_update_model.png differ diff --git a/docs/img/examples_model_update_model_dark.png b/docs/img/examples_model_update_model_dark.png new file mode 100644 index 00000000..a3b63836 Binary files /dev/null and b/docs/img/examples_model_update_model_dark.png differ diff --git a/docs/img/examples_model_update_network.png b/docs/img/examples_model_update_network.png index 8db0352e..d3096a3f 100644 Binary files a/docs/img/examples_model_update_network.png and b/docs/img/examples_model_update_network.png differ diff --git a/docs/img/examples_model_update_network_dark.png b/docs/img/examples_model_update_network_dark.png new file mode 100644 index 00000000..337a98c7 Binary files /dev/null and b/docs/img/examples_model_update_network_dark.png differ diff --git a/docs/img/examples_pytorch_distributed_example_01.png b/docs/img/examples_pytorch_distributed_example_01.png index 1c757e38..562b4252 100644 Binary files a/docs/img/examples_pytorch_distributed_example_01.png and b/docs/img/examples_pytorch_distributed_example_01.png differ diff --git a/docs/img/examples_pytorch_distributed_example_01_dark.png b/docs/img/examples_pytorch_distributed_example_01_dark.png new file mode 100644 index 00000000..7ee16907 Binary files /dev/null and b/docs/img/examples_pytorch_distributed_example_01_dark.png differ diff --git a/docs/img/examples_pytorch_distributed_example_01a.png b/docs/img/examples_pytorch_distributed_example_01a.png deleted file mode 100644 index 05561153..00000000 Binary files a/docs/img/examples_pytorch_distributed_example_01a.png and /dev/null differ diff --git a/docs/img/examples_pytorch_distributed_example_02.png b/docs/img/examples_pytorch_distributed_example_02.png index d89d0378..b28509cc 100644 Binary files a/docs/img/examples_pytorch_distributed_example_02.png and b/docs/img/examples_pytorch_distributed_example_02.png differ diff --git a/docs/img/examples_pytorch_distributed_example_02_dark.png b/docs/img/examples_pytorch_distributed_example_02_dark.png new file mode 100644 index 00000000..0fb9ae1f Binary files /dev/null and b/docs/img/examples_pytorch_distributed_example_02_dark.png differ diff --git a/docs/img/examples_pytorch_distributed_example_06.png b/docs/img/examples_pytorch_distributed_example_06.png index 216dae82..a399be1e 100644 Binary files a/docs/img/examples_pytorch_distributed_example_06.png and b/docs/img/examples_pytorch_distributed_example_06.png differ diff --git a/docs/img/examples_pytorch_distributed_example_06_dark.png b/docs/img/examples_pytorch_distributed_example_06_dark.png new file mode 100644 index 00000000..1c633c5f Binary files /dev/null and b/docs/img/examples_pytorch_distributed_example_06_dark.png differ diff --git a/docs/img/examples_pytorch_distributed_example_08.png b/docs/img/examples_pytorch_distributed_example_08.png index 206b82eb..84fd3722 100644 Binary files a/docs/img/examples_pytorch_distributed_example_08.png and b/docs/img/examples_pytorch_distributed_example_08.png differ diff --git a/docs/img/examples_pytorch_distributed_example_08_dark.png b/docs/img/examples_pytorch_distributed_example_08_dark.png new file mode 100644 index 00000000..3a7ab8f3 Binary files /dev/null and b/docs/img/examples_pytorch_distributed_example_08_dark.png differ diff --git a/docs/img/examples_pytorch_distributed_example_09.png b/docs/img/examples_pytorch_distributed_example_09.png index 3e5d02e8..2880774a 100644 Binary files a/docs/img/examples_pytorch_distributed_example_09.png and b/docs/img/examples_pytorch_distributed_example_09.png differ diff --git a/docs/img/examples_pytorch_distributed_example_09_dark.png b/docs/img/examples_pytorch_distributed_example_09_dark.png new file mode 100644 index 00000000..df6a551c Binary files /dev/null and b/docs/img/examples_pytorch_distributed_example_09_dark.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02.png b/docs/img/examples_pytorch_matplotlib_02.png index 67ce4d54..69499a18 100644 Binary files a/docs/img/examples_pytorch_matplotlib_02.png and b/docs/img/examples_pytorch_matplotlib_02.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02_dark.png b/docs/img/examples_pytorch_matplotlib_02_dark.png new file mode 100644 index 00000000..fd09a689 Binary files /dev/null and b/docs/img/examples_pytorch_matplotlib_02_dark.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02a.png b/docs/img/examples_pytorch_matplotlib_02a.png index 888821a0..7c7c95f8 100644 Binary files a/docs/img/examples_pytorch_matplotlib_02a.png and b/docs/img/examples_pytorch_matplotlib_02a.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02a_dark.png b/docs/img/examples_pytorch_matplotlib_02a_dark.png new file mode 100644 index 00000000..376a955f Binary files /dev/null and b/docs/img/examples_pytorch_matplotlib_02a_dark.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02b.png b/docs/img/examples_pytorch_matplotlib_02b.png index bb195fab..4a60a3d7 100644 Binary files a/docs/img/examples_pytorch_matplotlib_02b.png and b/docs/img/examples_pytorch_matplotlib_02b.png differ diff --git a/docs/img/examples_pytorch_matplotlib_02b_dark.png b/docs/img/examples_pytorch_matplotlib_02b_dark.png new file mode 100644 index 00000000..fd0973c3 Binary files /dev/null and b/docs/img/examples_pytorch_matplotlib_02b_dark.png differ diff --git a/docs/img/examples_pytorch_mnist_01.png b/docs/img/examples_pytorch_mnist_01.png index 0021706c..4f0d77d0 100644 Binary files a/docs/img/examples_pytorch_mnist_01.png and b/docs/img/examples_pytorch_mnist_01.png differ diff --git a/docs/img/examples_pytorch_mnist_01_dark.png b/docs/img/examples_pytorch_mnist_01_dark.png new file mode 100644 index 00000000..01945497 Binary files /dev/null and b/docs/img/examples_pytorch_mnist_01_dark.png differ diff --git a/docs/img/examples_pytorch_mnist_02.png b/docs/img/examples_pytorch_mnist_02.png index 0b524844..73255f68 100644 Binary files a/docs/img/examples_pytorch_mnist_02.png and b/docs/img/examples_pytorch_mnist_02.png differ diff --git a/docs/img/examples_pytorch_mnist_02_dark.png b/docs/img/examples_pytorch_mnist_02_dark.png new file mode 100644 index 00000000..f3ac5ffc Binary files /dev/null and b/docs/img/examples_pytorch_mnist_02_dark.png differ diff --git a/docs/img/examples_pytorch_mnist_03.png b/docs/img/examples_pytorch_mnist_03.png index 58c5d8cb..584da60f 100644 Binary files a/docs/img/examples_pytorch_mnist_03.png and b/docs/img/examples_pytorch_mnist_03.png differ diff --git a/docs/img/examples_pytorch_mnist_03_dark.png b/docs/img/examples_pytorch_mnist_03_dark.png new file mode 100644 index 00000000..810f19bf Binary files /dev/null and b/docs/img/examples_pytorch_mnist_03_dark.png differ diff --git a/docs/img/examples_pytorch_mnist_06.png b/docs/img/examples_pytorch_mnist_06.png index a0929b8a..3a0b7005 100644 Binary files a/docs/img/examples_pytorch_mnist_06.png and b/docs/img/examples_pytorch_mnist_06.png differ diff --git a/docs/img/examples_pytorch_mnist_06_dark.png b/docs/img/examples_pytorch_mnist_06_dark.png new file mode 100644 index 00000000..f97525f1 Binary files /dev/null and b/docs/img/examples_pytorch_mnist_06_dark.png differ diff --git a/docs/img/examples_pytorch_mnist_07.png b/docs/img/examples_pytorch_mnist_07.png index 85a46d18..320e8faa 100644 Binary files a/docs/img/examples_pytorch_mnist_07.png and b/docs/img/examples_pytorch_mnist_07.png differ diff --git a/docs/img/examples_pytorch_mnist_07_dark.png b/docs/img/examples_pytorch_mnist_07_dark.png new file mode 100644 index 00000000..accc94fb Binary files /dev/null and b/docs/img/examples_pytorch_mnist_07_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_01.png b/docs/img/examples_pytorch_tensorboard_01.png index 5f2f456c..a1784fad 100644 Binary files a/docs/img/examples_pytorch_tensorboard_01.png and b/docs/img/examples_pytorch_tensorboard_01.png differ diff --git a/docs/img/examples_pytorch_tensorboard_01_dark.png b/docs/img/examples_pytorch_tensorboard_01_dark.png new file mode 100644 index 00000000..31d3ce68 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_01_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_02.png b/docs/img/examples_pytorch_tensorboard_02.png index e43631ac..8f7debbe 100644 Binary files a/docs/img/examples_pytorch_tensorboard_02.png and b/docs/img/examples_pytorch_tensorboard_02.png differ diff --git a/docs/img/examples_pytorch_tensorboard_02_dark.png b/docs/img/examples_pytorch_tensorboard_02_dark.png new file mode 100644 index 00000000..3cfa2851 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_02_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_03.png b/docs/img/examples_pytorch_tensorboard_03.png index 8b47bd04..977f20f2 100644 Binary files a/docs/img/examples_pytorch_tensorboard_03.png and b/docs/img/examples_pytorch_tensorboard_03.png differ diff --git a/docs/img/examples_pytorch_tensorboard_03_dark.png b/docs/img/examples_pytorch_tensorboard_03_dark.png new file mode 100644 index 00000000..3968a75d Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_03_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_06.png b/docs/img/examples_pytorch_tensorboard_06.png index 7e17a669..9d96c85f 100644 Binary files a/docs/img/examples_pytorch_tensorboard_06.png and b/docs/img/examples_pytorch_tensorboard_06.png differ diff --git a/docs/img/examples_pytorch_tensorboard_06_dark.png b/docs/img/examples_pytorch_tensorboard_06_dark.png new file mode 100644 index 00000000..a224091b Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_06_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_07.png b/docs/img/examples_pytorch_tensorboard_07.png index 14201747..975bbd60 100644 Binary files a/docs/img/examples_pytorch_tensorboard_07.png and b/docs/img/examples_pytorch_tensorboard_07.png differ diff --git a/docs/img/examples_pytorch_tensorboard_07_dark.png b/docs/img/examples_pytorch_tensorboard_07_dark.png new file mode 100644 index 00000000..baf8ec42 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_07_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboard_08.png b/docs/img/examples_pytorch_tensorboard_08.png index 7ea4f6de..f207105c 100644 Binary files a/docs/img/examples_pytorch_tensorboard_08.png and b/docs/img/examples_pytorch_tensorboard_08.png differ diff --git a/docs/img/examples_pytorch_tensorboard_08_dark.png b/docs/img/examples_pytorch_tensorboard_08_dark.png new file mode 100644 index 00000000..f53da658 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboard_08_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_01.png b/docs/img/examples_pytorch_tensorboardx_01.png index 1fb3bb96..564ff84e 100644 Binary files a/docs/img/examples_pytorch_tensorboardx_01.png and b/docs/img/examples_pytorch_tensorboardx_01.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_01_dark.png b/docs/img/examples_pytorch_tensorboardx_01_dark.png new file mode 100644 index 00000000..a9e55881 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboardx_01_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_02.png b/docs/img/examples_pytorch_tensorboardx_02.png index 6cf3b1e1..dae5a228 100644 Binary files a/docs/img/examples_pytorch_tensorboardx_02.png and b/docs/img/examples_pytorch_tensorboardx_02.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_02_dark.png b/docs/img/examples_pytorch_tensorboardx_02_dark.png new file mode 100644 index 00000000..05825b4e Binary files /dev/null and b/docs/img/examples_pytorch_tensorboardx_02_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_03.png b/docs/img/examples_pytorch_tensorboardx_03.png index d25737a0..1397d3da 100644 Binary files a/docs/img/examples_pytorch_tensorboardx_03.png and b/docs/img/examples_pytorch_tensorboardx_03.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_03_dark.png b/docs/img/examples_pytorch_tensorboardx_03_dark.png new file mode 100644 index 00000000..76c1d437 Binary files /dev/null and b/docs/img/examples_pytorch_tensorboardx_03_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_04.png b/docs/img/examples_pytorch_tensorboardx_04.png index bc728d0e..97cc46d4 100644 Binary files a/docs/img/examples_pytorch_tensorboardx_04.png and b/docs/img/examples_pytorch_tensorboardx_04.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_04_dark.png b/docs/img/examples_pytorch_tensorboardx_04_dark.png new file mode 100644 index 00000000..0945855b Binary files /dev/null and b/docs/img/examples_pytorch_tensorboardx_04_dark.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_model.png b/docs/img/examples_pytorch_tensorboardx_model.png index 4dfe0cab..cd170b5e 100644 Binary files a/docs/img/examples_pytorch_tensorboardx_model.png and b/docs/img/examples_pytorch_tensorboardx_model.png differ diff --git a/docs/img/examples_pytorch_tensorboardx_model_dark.png b/docs/img/examples_pytorch_tensorboardx_model_dark.png new file mode 100644 index 00000000..a65850dc Binary files /dev/null and b/docs/img/examples_pytorch_tensorboardx_model_dark.png differ diff --git a/docs/img/examples_remote_execution_artifacts.png b/docs/img/examples_remote_execution_artifacts.png index ada633e4..d595bc9f 100644 Binary files a/docs/img/examples_remote_execution_artifacts.png and b/docs/img/examples_remote_execution_artifacts.png differ diff --git a/docs/img/examples_remote_execution_artifacts_dark.png b/docs/img/examples_remote_execution_artifacts_dark.png new file mode 100644 index 00000000..245d4102 Binary files /dev/null and b/docs/img/examples_remote_execution_artifacts_dark.png differ diff --git a/docs/img/examples_reporting_fastai_01.png b/docs/img/examples_reporting_fastai_01.png index 42fb4686..caf2f247 100644 Binary files a/docs/img/examples_reporting_fastai_01.png and b/docs/img/examples_reporting_fastai_01.png differ diff --git a/docs/img/examples_reporting_fastai_01_dark.png b/docs/img/examples_reporting_fastai_01_dark.png new file mode 100644 index 00000000..71853731 Binary files /dev/null and b/docs/img/examples_reporting_fastai_01_dark.png differ diff --git a/docs/img/examples_reporting_fastai_02.png b/docs/img/examples_reporting_fastai_02.png index 86164dbc..2bdd9c6c 100644 Binary files a/docs/img/examples_reporting_fastai_02.png and b/docs/img/examples_reporting_fastai_02.png differ diff --git a/docs/img/examples_reporting_fastai_02_dark.png b/docs/img/examples_reporting_fastai_02_dark.png new file mode 100644 index 00000000..708522c7 Binary files /dev/null and b/docs/img/examples_reporting_fastai_02_dark.png differ diff --git a/docs/img/examples_reporting_fastai_03.png b/docs/img/examples_reporting_fastai_03.png index 2c7bdfef..26c484d6 100644 Binary files a/docs/img/examples_reporting_fastai_03.png and b/docs/img/examples_reporting_fastai_03.png differ diff --git a/docs/img/examples_reporting_fastai_03_dark.png b/docs/img/examples_reporting_fastai_03_dark.png new file mode 100644 index 00000000..209b10b7 Binary files /dev/null and b/docs/img/examples_reporting_fastai_03_dark.png differ diff --git a/docs/img/examples_subprocess_example_01.png b/docs/img/examples_subprocess_example_01.png index 44b564ba..9672a54a 100644 Binary files a/docs/img/examples_subprocess_example_01.png and b/docs/img/examples_subprocess_example_01.png differ diff --git a/docs/img/examples_subprocess_example_01_dark.png b/docs/img/examples_subprocess_example_01_dark.png new file mode 100644 index 00000000..a5694b96 Binary files /dev/null and b/docs/img/examples_subprocess_example_01_dark.png differ diff --git a/docs/img/examples_subprocess_example_01a.png b/docs/img/examples_subprocess_example_01a.png index b96b6c68..da5ebb94 100644 Binary files a/docs/img/examples_subprocess_example_01a.png and b/docs/img/examples_subprocess_example_01a.png differ diff --git a/docs/img/examples_subprocess_example_01a_dark.png b/docs/img/examples_subprocess_example_01a_dark.png new file mode 100644 index 00000000..7c652229 Binary files /dev/null and b/docs/img/examples_subprocess_example_01a_dark.png differ diff --git a/docs/img/examples_subprocess_example_02.png b/docs/img/examples_subprocess_example_02.png index 2e5049fb..b636458e 100644 Binary files a/docs/img/examples_subprocess_example_02.png and b/docs/img/examples_subprocess_example_02.png differ diff --git a/docs/img/examples_subprocess_example_02_dark.png b/docs/img/examples_subprocess_example_02_dark.png new file mode 100644 index 00000000..edb95564 Binary files /dev/null and b/docs/img/examples_subprocess_example_02_dark.png differ diff --git a/docs/img/examples_tensorboard_toy_pytorch_00.png b/docs/img/examples_tensorboard_toy_pytorch_00.png index 4d62c3ba..9f311194 100644 Binary files a/docs/img/examples_tensorboard_toy_pytorch_00.png and b/docs/img/examples_tensorboard_toy_pytorch_00.png differ diff --git a/docs/img/examples_tensorboard_toy_pytorch_00_dark.png b/docs/img/examples_tensorboard_toy_pytorch_00_dark.png new file mode 100644 index 00000000..58e7d247 Binary files /dev/null and b/docs/img/examples_tensorboard_toy_pytorch_00_dark.png differ diff --git a/docs/img/examples_tensorboard_toy_pytorch_02.png b/docs/img/examples_tensorboard_toy_pytorch_02.png index 16e26808..e15a37a6 100644 Binary files a/docs/img/examples_tensorboard_toy_pytorch_02.png and b/docs/img/examples_tensorboard_toy_pytorch_02.png differ diff --git a/docs/img/examples_tensorboard_toy_pytorch_02_dark.png b/docs/img/examples_tensorboard_toy_pytorch_02_dark.png new file mode 100644 index 00000000..0f10c336 Binary files /dev/null and b/docs/img/examples_tensorboard_toy_pytorch_02_dark.png differ diff --git a/docs/img/examples_transformers_artifacts.png b/docs/img/examples_transformers_artifacts.png index c222f1df..9e062156 100644 Binary files a/docs/img/examples_transformers_artifacts.png and b/docs/img/examples_transformers_artifacts.png differ diff --git a/docs/img/examples_transformers_artifacts_dark.png b/docs/img/examples_transformers_artifacts_dark.png new file mode 100644 index 00000000..0d3f6342 Binary files /dev/null and b/docs/img/examples_transformers_artifacts_dark.png differ diff --git a/docs/img/examples_transformers_params.png b/docs/img/examples_transformers_params.png index c152e069..d00216f6 100644 Binary files a/docs/img/examples_transformers_params.png and b/docs/img/examples_transformers_params.png differ diff --git a/docs/img/examples_transformers_params_dark.png b/docs/img/examples_transformers_params_dark.png new file mode 100644 index 00000000..aef72dc2 Binary files /dev/null and b/docs/img/examples_transformers_params_dark.png differ diff --git a/docs/img/faq_compare_scatter.png b/docs/img/faq_compare_scatter.png index c79fbc3a..8bb298fb 100644 Binary files a/docs/img/faq_compare_scatter.png and b/docs/img/faq_compare_scatter.png differ diff --git a/docs/img/faq_compare_scatter_dark.png b/docs/img/faq_compare_scatter_dark.png new file mode 100644 index 00000000..82e0e4fa Binary files /dev/null and b/docs/img/faq_compare_scatter_dark.png differ diff --git a/docs/img/faq_download_console_log.png b/docs/img/faq_download_console_log.png index f642934c..ccc6dd86 100644 Binary files a/docs/img/faq_download_console_log.png and b/docs/img/faq_download_console_log.png differ diff --git a/docs/img/faq_download_console_log_dark.png b/docs/img/faq_download_console_log_dark.png new file mode 100644 index 00000000..f274a8ee Binary files /dev/null and b/docs/img/faq_download_console_log_dark.png differ diff --git a/docs/img/faq_server_versions.png b/docs/img/faq_server_versions.png index 07f1ed02..0c097e2c 100644 Binary files a/docs/img/faq_server_versions.png and b/docs/img/faq_server_versions.png differ diff --git a/docs/img/faq_server_versions_dark.png b/docs/img/faq_server_versions_dark.png new file mode 100644 index 00000000..89b6ed6d Binary files /dev/null and b/docs/img/faq_server_versions_dark.png differ diff --git a/docs/img/fundamentals_logger_reported_images.png b/docs/img/fundamentals_logger_reported_images.png deleted file mode 100644 index 8c09a381..00000000 Binary files a/docs/img/fundamentals_logger_reported_images.png and /dev/null differ diff --git a/docs/img/fundamentals_logger_results.png b/docs/img/fundamentals_logger_results.png deleted file mode 100644 index 0707bb29..00000000 Binary files a/docs/img/fundamentals_logger_results.png and /dev/null differ diff --git a/docs/img/fundamentals_models.png b/docs/img/fundamentals_models.png deleted file mode 100644 index b57c5008..00000000 Binary files a/docs/img/fundamentals_models.png and /dev/null differ diff --git a/docs/img/integrations_transformers_scalars.png b/docs/img/integrations_transformers_scalars.png index 4ebc75a6..420d0d77 100644 Binary files a/docs/img/integrations_transformers_scalars.png and b/docs/img/integrations_transformers_scalars.png differ diff --git a/docs/img/integrations_transformers_scalars_dark.png b/docs/img/integrations_transformers_scalars_dark.png new file mode 100644 index 00000000..49fd6145 Binary files /dev/null and b/docs/img/integrations_transformers_scalars_dark.png differ diff --git a/docs/img/pipelines_DAG.png b/docs/img/pipelines_DAG.png deleted file mode 100644 index de3faf60..00000000 Binary files a/docs/img/pipelines_DAG.png and /dev/null differ diff --git a/docs/img/pipelines_new_run.png b/docs/img/pipelines_new_run.png index 67b40acf..4bcda63f 100644 Binary files a/docs/img/pipelines_new_run.png and b/docs/img/pipelines_new_run.png differ diff --git a/docs/img/pipelines_new_run_dark.png b/docs/img/pipelines_new_run_dark.png new file mode 100644 index 00000000..d517eef9 Binary files /dev/null and b/docs/img/pipelines_new_run_dark.png differ diff --git a/docs/integrations/transformers.md b/docs/integrations/transformers.md index 93c9d03a..532b20f7 100644 --- a/docs/integrations/transformers.md +++ b/docs/integrations/transformers.md @@ -50,7 +50,8 @@ To log the models created during training, set the `CLEARML_LOG_MODEL` environme You can see all the captured data in the task's page of the ClearML [WebApp](../webapp/webapp_exp_track_visual.md). -![transformers scalars](../img/integrations_transformers_scalars.png) +![transformers scalars](../img/integrations_transformers_scalars.png#light-mode-only) +![transformers scalars](../img/integrations_transformers_scalars_dark.png#dark-mode-only) Additionally, you can view all of your Transformers runs tracked by ClearML in the [Task Table](../webapp/webapp_model_table.md). Add custom columns to the table, such as mAP values, so you can easily sort and see what is the best performing model. diff --git a/docs/pipelines/pipelines.md b/docs/pipelines/pipelines.md index 2c0e742d..0860087c 100644 --- a/docs/pipelines/pipelines.md +++ b/docs/pipelines/pipelines.md @@ -103,7 +103,12 @@ You can rerun the pipeline programmatically or via the ClearML Web UI: * To launch a new pipeline run in the UI, click **+ NEW RUN** in the [pipeline runs](../webapp/pipelines/webapp_pipeline_table.md) page. This opens a **NEW RUN** modal, where you can set the run's parameters and execution queue. - ![Pipeline params UI](../img/pipelines_new_run.png) +
+ + ![Pipeline params UI](../img/pipelines_new_run.png#light-mode-only) + ![Pipeline params UI](../img/pipelines_new_run_dark.png#dark-mode-only) + +
The new pipeline run will be executed through the execution queue by a ClearML agent. The agent will rebuild the pipeline according to the configuration and DAG that was captured in the original run, and override the original diff --git a/docs/pipelines/pipelines_sdk_function_decorators.md b/docs/pipelines/pipelines_sdk_function_decorators.md index 97f43e75..5345d116 100644 --- a/docs/pipelines/pipelines_sdk_function_decorators.md +++ b/docs/pipelines/pipelines_sdk_function_decorators.md @@ -67,7 +67,12 @@ def main(pickle_url, mock_parameter='mock'): When the function is called, a corresponding ClearML Controller Task is created: its arguments are logged as the task's parameters. When launching a new pipeline run from the [UI](../webapp/pipelines/webapp_pipeline_page.md), you can modify their values for the new run. -![Pipeline new run](../img/pipelines_new_run.png) +
+ +![Pipeline new run](../img/pipelines_new_run.png#light-mode-only) +![Pipeline new run](../img/pipelines_new_run_dark.png#dark-mode-only) + +
## @PipelineDecorator.component Using the [`@PipelineDecorator.component`](../references/sdk/automation_controller_pipelinedecorator.md#pipelinedecoratorcomponent) diff --git a/docs/pipelines/pipelines_sdk_tasks.md b/docs/pipelines/pipelines_sdk_tasks.md index 36eefe5e..f1d03fd8 100644 --- a/docs/pipelines/pipelines_sdk_tasks.md +++ b/docs/pipelines/pipelines_sdk_tasks.md @@ -42,7 +42,12 @@ These parameters can be programmatically injected into a step's configuration us When launching a new pipeline run from the [UI](../webapp/pipelines/webapp_pipeline_table.md), you can modify their values for the new run. -![Pipeline new run](../img/pipelines_new_run.png) +
+ +![Pipeline new run](../img/pipelines_new_run.png#light-mode-only) +![Pipeline new run](../img/pipelines_new_run_dark.png#dark-mode-only) + +
### Additional Configuration You can connect configuration dictionaries or files to a pipeline controller using diff --git a/docs/webapp/applications/apps_embed_model_deployment.md b/docs/webapp/applications/apps_embed_model_deployment.md index 2463f1ee..d78afd25 100644 --- a/docs/webapp/applications/apps_embed_model_deployment.md +++ b/docs/webapp/applications/apps_embed_model_deployment.md @@ -16,7 +16,8 @@ endpoint activity and shuts down if the model remains inactive for a specified m The Embedding Model Deployment app makes use of the ClearML Traffic Router which implements a secure, authenticated network endpoint for the model. -If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. +If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. +For more information, see [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md). ::: After starting an Embedding Model Deployment instance, you can view the following information in its dashboard: diff --git a/docs/webapp/applications/apps_gradio.md b/docs/webapp/applications/apps_gradio.md index b04c0982..31e48b92 100644 --- a/docs/webapp/applications/apps_gradio.md +++ b/docs/webapp/applications/apps_gradio.md @@ -20,6 +20,7 @@ The Gradio Launcher relies on the ClearML Traffic Router which implements user a to the IP/port served by the Gradio app. If the ClearML AI application Gateway is not available, the Gradio app might not be accessible. +For more information, see [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md). ::: Once you start a Gradio launcher instance, you can view the following information in its dashboard: diff --git a/docs/webapp/applications/apps_llama_deployment.md b/docs/webapp/applications/apps_llama_deployment.md index 596586b3..e1233569 100644 --- a/docs/webapp/applications/apps_llama_deployment.md +++ b/docs/webapp/applications/apps_llama_deployment.md @@ -16,6 +16,7 @@ The llama.cpp Model Deployment app makes use of the ClearML Traffic Router which network endpoint for the model. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. +For more information, see [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md). ::: After starting a llama.cpp Model Deployment instance, you can view the following information in its dashboard: diff --git a/docs/webapp/applications/apps_model_deployment.md b/docs/webapp/applications/apps_model_deployment.md index e0c0afe4..6bddd620 100644 --- a/docs/webapp/applications/apps_model_deployment.md +++ b/docs/webapp/applications/apps_model_deployment.md @@ -17,6 +17,7 @@ The vLLM Model Deployment app makes use of the ClearML Traffic Router which impl network endpoint for the model. If the ClearML AI application Gateway is not available, the model endpoint might not be accessible. +For more information, see [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md). ::: Once you start a vLLM Model Deployment instance, you can view the following information in its dashboard: diff --git a/docs/webapp/applications/apps_streamlit.md b/docs/webapp/applications/apps_streamlit.md index 3aefbe21..4741a3e5 100644 --- a/docs/webapp/applications/apps_streamlit.md +++ b/docs/webapp/applications/apps_streamlit.md @@ -21,6 +21,7 @@ The Streamlit Launcher relies on the ClearML Traffic Router which implements use to the IP/port served by the Streamlit app. If the ClearML AI application Gateway is not available, the Streamlit app might not be accessible. +For more information, see [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md). ::: Once you start a Streamlit launcher instance, you can view the following information in its dashboard: diff --git a/docs/webapp/settings/webapp_settings_profile.md b/docs/webapp/settings/webapp_settings_profile.md index e7e92d8e..e2cf4454 100644 --- a/docs/webapp/settings/webapp_settings_profile.md +++ b/docs/webapp/settings/webapp_settings_profile.md @@ -103,7 +103,8 @@ these credentials cannot be recovered. The AI Application Gateway is available under the ClearML Enterprise plan. ::: -The AI Application Gateway enables external access to ClearML tasks and applications. The gateway is configured with an +The [AI Application Gateway](../../deploying_clearml/enterprise_deploy/appgw.md) enables external access to ClearML +tasks and applications. The gateway is configured with an endpoint or external address (ingress), accessible from outside ClearML. Generate tokens providing API access to the AI Application Gateway endpoints: diff --git a/docs/webapp/webapp_reports.md b/docs/webapp/webapp_reports.md index e84057c6..7e79eb6c 100644 --- a/docs/webapp/webapp_reports.md +++ b/docs/webapp/webapp_reports.md @@ -429,7 +429,11 @@ image enclosed in parentheses: The rendered output should look like this: -![Logo](https://raw.githubusercontent.com/clearml/clearml/master/docs/clearml-logo.svg) +Logo + +Logo + +
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: @@ -439,7 +443,9 @@ link: ``` The rendered output should look like this: -Logo with Title + + + Hover over the image to see its title. diff --git a/src/css/custom.css b/src/css/custom.css index 160fad9e..665be87c 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -620,6 +620,15 @@ html[data-theme=dark] .medium-zoom-image.medium-zoom-image--opened {border-radiu [data-theme='dark'] img[src$='#light-mode-only'] { display: none; } + +[data-theme='dark'] .light-mode-only { + display: none; +} + +[data-theme='light'] .dark-mode-only { + display: none; +} + /* table */ .markdown table { border-spacing: 0;