diff --git a/docs/clearml_agent.md b/docs/clearml_agent.md index b5412efb..a43f78e1 100644 --- a/docs/clearml_agent.md +++ b/docs/clearml_agent.md @@ -475,7 +475,7 @@ To limit the number of simultaneous tasks run in services mode, pass the maximum Launch a service task like any other task, by enqueuing it to the appropriate queue. -:::warning +:::caution Do not enqueue training or inference tasks into the services queue. They will put an unnecessary load on the server. ::: @@ -562,7 +562,7 @@ Override worker schedules by: Set a schedule for a worker from the command line when running `clearml-agent`. Two properties enable setting working hours: -:::warning +:::caution Use only one of these properties ::: @@ -591,7 +591,7 @@ For example: Set a schedule for a worker using configuration file options. The options are: -:::warning +:::caution Use only one of these properties ::: @@ -608,7 +608,7 @@ For example, set a worker's schedule from 5 PM to 8 PM on Sunday through Tuesday Runtime properties override the command line uptime / downtime properties. The runtime properties are: -:::warning +:::caution Use only one of these properties ::: @@ -630,7 +630,7 @@ For example, to force a worker on for 24 hours: Queue tags override command line and runtime properties. The queue tags are the following: -:::warning +:::caution Use only one of these properties ::: diff --git a/docs/clearml_data/clearml_data_cli.md b/docs/clearml_data/clearml_data_cli.md index e3e4fd29..61ff832f 100644 --- a/docs/clearml_data/clearml_data_cli.md +++ b/docs/clearml_data/clearml_data_cli.md @@ -250,7 +250,7 @@ will be deleted. If a dataset is a parent to a dataset(s), you must pass `--force` in order to delete it. -:::warning +:::caution Deleting a parent dataset may cause child datasets to lose data! ::: diff --git a/docs/clearml_data/clearml_data_sdk.md b/docs/clearml_data/clearml_data_sdk.md index 325afe18..82d49692 100644 --- a/docs/clearml_data/clearml_data_sdk.md +++ b/docs/clearml_data/clearml_data_sdk.md @@ -255,7 +255,7 @@ case, all matching datasets will be deleted. If a dataset is a parent to a dataset(s), you must pass `force=True` in order to delete it. -:::warning +:::caution Deleting a parent dataset may cause child datasets to lose data! ::: diff --git a/docs/clearml_sdk/task_sdk.md b/docs/clearml_sdk/task_sdk.md index 2bbbf135..741964d2 100644 --- a/docs/clearml_sdk/task_sdk.md +++ b/docs/clearml_sdk/task_sdk.md @@ -627,7 +627,7 @@ task.set_parameters({'Args/epochs':7, 'lr': 0.5}) task.set_parameter(name='decay',value=0.001) ``` -:::warning Overwriting Parameters +:::caution Overwriting Parameters The `set_parameters` method replaces any existing hyperparameters in the task. ::: diff --git a/docs/configs/clearml_conf.md b/docs/configs/clearml_conf.md index dcafe62c..d1bdd042 100644 --- a/docs/configs/clearml_conf.md +++ b/docs/configs/clearml_conf.md @@ -662,7 +662,7 @@ Dictionary of configuration options for the ClearML Server API, web, and file se * The URL of your ClearML file server. For example, `https://files.MyDomain.com`. -:::warning +:::caution You must use a secure protocol with ``api.web_server``, ``api.files_server``, and ``api.api_server``. Use `https`, not `http`. ::: @@ -699,7 +699,7 @@ You must use a secure protocol with ``api.web_server``, ``api.files_server``, an * `true` - Verify * `false` - Do not verify. -:::warning +:::caution Set to False only if required. ::: diff --git a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md index 1d7b1ff4..f0068b58 100644 --- a/docs/deploying_clearml/clearml_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/clearml_server_aws_ec2_ami.md @@ -19,7 +19,7 @@ and delete all cookies under the ClearML Server URL. ## Launching -:::warning +:::caution By default, ClearML Server deploys as an open network. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page. ::: diff --git a/docs/deploying_clearml/clearml_server_config.md b/docs/deploying_clearml/clearml_server_config.md index 30407371..790fdcdd 100644 --- a/docs/deploying_clearml/clearml_server_config.md +++ b/docs/deploying_clearml/clearml_server_config.md @@ -208,7 +208,7 @@ For improved security, the ports for ClearML Server Elasticsearch, MongoDB, and they are only open internally in the docker network. If external access is needed, open these ports (but make sure to understand the security risks involved with doing so). -:::warning +:::caution Opening the ports for Elasticsearch, MongoDB, and Redis for external access may pose a security concern and is not recommended unless you know what you're doing. Network security measures, such as firewall configuration, should be considered when opening ports for external access. diff --git a/docs/deploying_clearml/clearml_server_es7_migration.md b/docs/deploying_clearml/clearml_server_es7_migration.md index 347663ff..44e92952 100644 --- a/docs/deploying_clearml/clearml_server_es7_migration.md +++ b/docs/deploying_clearml/clearml_server_es7_migration.md @@ -22,7 +22,7 @@ The migration process makes use of a script that automatically performs the foll * Renames the original data directory to avoid accidental reuse. -:::warning +:::caution Once the migration process completes successfully, the data is no longer accessible to the older version of Trains Server, and ClearML Server needs to be installed. ::: diff --git a/docs/deploying_clearml/clearml_server_gcp.md b/docs/deploying_clearml/clearml_server_gcp.md index a6188743..7669d78d 100644 --- a/docs/deploying_clearml/clearml_server_gcp.md +++ b/docs/deploying_clearml/clearml_server_gcp.md @@ -59,7 +59,7 @@ For more information see [Import the image to your custom images list](https://c ## Launching -:::warning +:::caution By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page. ::: diff --git a/docs/deploying_clearml/clearml_server_kubernetes_helm.md b/docs/deploying_clearml/clearml_server_kubernetes_helm.md index bced9e80..ae158e0a 100644 --- a/docs/deploying_clearml/clearml_server_kubernetes_helm.md +++ b/docs/deploying_clearml/clearml_server_kubernetes_helm.md @@ -23,7 +23,7 @@ Ensure that the `helm` binary is in the PATH of your shell. You will create a multi-node Kubernetes cluster using Helm, and then install ClearML in your cluster. For deployment instructions with up-to-date Helms charts, see the [clearml-helm-charts repository](https://github.com/allegroai/clearml-helm-charts/tree/main/charts/clearml#local-environment). -:::warning Server Access +:::caution Server Access By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page. ::: diff --git a/docs/deploying_clearml/clearml_server_linux_mac.md b/docs/deploying_clearml/clearml_server_linux_mac.md index a134ef9d..d7a51dfe 100644 --- a/docs/deploying_clearml/clearml_server_linux_mac.md +++ b/docs/deploying_clearml/clearml_server_linux_mac.md @@ -30,7 +30,7 @@ For Linux users only: ## Deploying -:::warning +:::caution By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page. ::: diff --git a/docs/deploying_clearml/clearml_server_win.md b/docs/deploying_clearml/clearml_server_win.md index 2b15a996..e177f0ec 100644 --- a/docs/deploying_clearml/clearml_server_win.md +++ b/docs/deploying_clearml/clearml_server_win.md @@ -15,7 +15,7 @@ and delete all cookies under the ClearML Server URL. ## Deploying -:::warning +:::caution By default, ClearML Server launches with unrestricted access. To restrict ClearML Server access, follow the instructions in the [Security](clearml_server_security.md) page. ::: diff --git a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md index dfe7929e..e7f02a58 100644 --- a/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md +++ b/docs/deploying_clearml/upgrade_server_aws_ec2_ami.md @@ -13,7 +13,7 @@ to upgrade and migrate to a [new AWS instance](#upgrading-and-migrating-to-a-new This section contains the steps to upgrade ClearML Server on the same AWS instance. -:::warning +:::caution Some legacy **Trains Server** AMIs provided an auto-upgrade on restart capability. This functionality is now deprecated. ::: diff --git a/docs/faq.md b/docs/faq.md index 22af7737..ab1a3dba 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -342,7 +342,7 @@ Your firewall may be preventing the connection. Try one of the following solutio * Direct python "requests" to use the enterprise certificate file by setting the OS environment variables CURL_CA_BUNDLE or REQUESTS_CA_BUNDLE. For a detailed discussion of this topic, see [https://stackoverflow.com/questions/48391750/disable-python-requests-ssl-validation-for-an-imported-module](https://stackoverflow.com/questions/48391750/disable-python-requests-ssl-validation-for-an-imported-module). * Disable certificate verification - :::warning + :::caution For security reasons, it is not recommended to disable certificate verification ::: 1. Upgrade ClearML to the current version: @@ -414,7 +414,7 @@ In rare instances, however, such as high disk usage for a privately-hosted Clear You can use the `APIClient` provided by ClearML Agent and `client.tasks.delete()` to delete an experiment. -:::warning +:::caution You cannot undo the deletion of an experiment. ::: diff --git a/docs/fundamentals/agents_and_queues.md b/docs/fundamentals/agents_and_queues.md index e0750102..39e5a8f3 100644 --- a/docs/fundamentals/agents_and_queues.md +++ b/docs/fundamentals/agents_and_queues.md @@ -109,7 +109,7 @@ This mode is intended for running maintenance tasks. Some suitable tasks include - [Control Service](../guides/services/aws_autoscaler.md) - AWS Autoscaler for example - [External services](../guides/services/slack_alerts.md) - Such as Slack integration alert service -:::warning +:::caution Do not enqueue training or inference tasks into the services queue. They will put an unnecessary load on the server. ::: diff --git a/docs/guides/ide/integration_pycharm.md b/docs/guides/ide/integration_pycharm.md index f2163cee..d949082a 100644 --- a/docs/guides/ide/integration_pycharm.md +++ b/docs/guides/ide/integration_pycharm.md @@ -25,7 +25,7 @@ private credentials (assuming the entire code base, including `.git` already exi ## Optional: ClearML Configuration Parameters -:::warning +:::caution If you set ClearML configuration parameters (ClearML Server and ClearML credentials) in the plugin, they will override the settings in the ClearML configuration file. ::: diff --git a/docs/img/settings_user_group.png b/docs/img/settings_user_group.png index 137c2283..59fbee32 100644 Binary files a/docs/img/settings_user_group.png and b/docs/img/settings_user_group.png differ diff --git a/docs/release_notes/ver_1_0.md b/docs/release_notes/ver_1_0.md index 8f01578a..ab48081d 100644 --- a/docs/release_notes/ver_1_0.md +++ b/docs/release_notes/ver_1_0.md @@ -4,7 +4,7 @@ title: Version 1.0 ### ClearML Serving 1.0.0 -:::warning Backwards Compatibility +:::caution Backwards Compatibility This release is not backwards compatible ::: diff --git a/docs/release_notes/ver_1_1.md b/docs/release_notes/ver_1_1.md index d1c4dec2..5da0ef20 100644 --- a/docs/release_notes/ver_1_1.md +++ b/docs/release_notes/ver_1_1.md @@ -4,7 +4,7 @@ title: Version 1.1 ### ClearML Serving 1.1.0 -:::warning Backwards Compatibility +:::caution Backwards Compatibility This release is not backwards compatible - see notes below on upgrading ::: diff --git a/src/css/custom.css b/src/css/custom.css index 9f88273e..b51aa7d9 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -40,6 +40,10 @@ html { --max-page-width: 1600px; --docusaurus-announcement-bar-height: 40px !important; --ifm-link-color: var(--ifm-color-primary-darker); + + --ifm-code-font-size: 85%; + --ifm-code-padding-horizontal: 0.3rem; + --ifm-code-padding-vertical: 0.2rem; } html[data-theme="dark"] {