From e77846a53656370e93fc8899a86bc459ac38d4df Mon Sep 17 00:00:00 2001 From: pollfly <75068813+pollfly@users.noreply.github.com> Date: Mon, 10 Feb 2025 09:54:13 +0200 Subject: [PATCH] Edits 50 (#1034) --- docs/clearml_sdk/model_sdk.md | 2 +- docs/clearml_serving/clearml_serving_tutorial.md | 2 +- docs/faq.md | 2 +- docs/webapp/applications/apps_dashboard.md | 4 ++++ docs/webapp/applications/apps_embed_model_deployment.md | 6 +++++- docs/webapp/applications/apps_hpo.md | 4 ++++ docs/webapp/applications/apps_llama_deployment.md | 6 +++++- docs/webapp/applications/apps_model_deployment.md | 3 +++ docs/webapp/applications/apps_ssh_session.md | 6 +++++- docs/webapp/applications/apps_task_scheduler.md | 3 +++ docs/webapp/applications/apps_trigger_manager.md | 4 ++++ docs/webapp/webapp_model_table.md | 6 +++--- src/css/custom.css | 4 ++++ 13 files changed, 43 insertions(+), 9 deletions(-) diff --git a/docs/clearml_sdk/model_sdk.md b/docs/clearml_sdk/model_sdk.md index 6abd26bc..5625b366 100644 --- a/docs/clearml_sdk/model_sdk.md +++ b/docs/clearml_sdk/model_sdk.md @@ -13,7 +13,7 @@ so the models are traceable to tasks. ## Output Models -### Manually Logging Models +### Manually Logging Models To manually log a model, create an instance of OutputModel class. diff --git a/docs/clearml_serving/clearml_serving_tutorial.md b/docs/clearml_serving/clearml_serving_tutorial.md index aec4ef7c..3d5ef43e 100644 --- a/docs/clearml_serving/clearml_serving_tutorial.md +++ b/docs/clearml_serving/clearml_serving_tutorial.md @@ -82,7 +82,7 @@ Inference services status, console outputs and machine metrics are available in project (default: "DevOps" project). ::: -## Registering and Deploying New Models Manually +## Registering and Deploying New Models Manually Uploading an existing model file into the model repository can be done via the `clearml` RestAPI, the Python interface, or with the `clearml-serving` CLI. diff --git a/docs/faq.md b/docs/faq.md index 7b161be8..9324813f 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -161,7 +161,7 @@ clearml-session==0.3.2 #### How can I sort models by a certain metric? To sort models by a metric, in the ClearML Web UI, -add a [custom column](webapp/webapp_model_table.md#customizing-the-models-table) to the model table and sort by +add a [custom column](webapp/webapp_model_table.md#customizing-the-model-table) to the model table and sort by that metric column. Available custom column options depend upon the models in the table and the metrics that have been attached to them (see [Logging Metrics and Plots](clearml_sdk/model_sdk.md#logging-metrics-and-plots)). diff --git a/docs/webapp/applications/apps_dashboard.md b/docs/webapp/applications/apps_dashboard.md index 4b1d76ed..e122d018 100644 --- a/docs/webapp/applications/apps_dashboard.md +++ b/docs/webapp/applications/apps_dashboard.md @@ -38,9 +38,13 @@ of the chosen metric over time. * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration. +
+ ![Dashboard app instance launch form](../../img/apps_dashboard_wizard.png#light-mode-only) ![Dashboard app instance launch form](../../img/apps_dashboard_wizard_dark.png#dark-mode-only) +
+ ## Dashboard Once a project dashboard instance is launched, its dashboard displays the following information about a project: diff --git a/docs/webapp/applications/apps_embed_model_deployment.md b/docs/webapp/applications/apps_embed_model_deployment.md index 081c4894..2463f1ee 100644 --- a/docs/webapp/applications/apps_embed_model_deployment.md +++ b/docs/webapp/applications/apps_embed_model_deployment.md @@ -91,5 +91,9 @@ Deployment app instance task will be enqueued (make sure an agent is assigned to * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![Embedding Model Deployment form](../../img/apps_embedding_model_deployment_form.png#light-mode-only) -![Embedding Model Deployment form](../../img/apps_embedding_model_deployment_form_dark.png#dark-mode-only) \ No newline at end of file +![Embedding Model Deployment form](../../img/apps_embedding_model_deployment_form_dark.png#dark-mode-only) + +
\ No newline at end of file diff --git a/docs/webapp/applications/apps_hpo.md b/docs/webapp/applications/apps_hpo.md index 2ed18254..0238b3a6 100644 --- a/docs/webapp/applications/apps_hpo.md +++ b/docs/webapp/applications/apps_hpo.md @@ -74,9 +74,13 @@ limits. * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![HPO app instance launch form](../../img/apps_hpo_wizard.png#light-mode-only) ![HPO app instance launch form](../../img/apps_hpo_wizard_dark.png#dark-mode-only) +
+ ## Dashboard Once an HPO instance is launched, the dashboard displays a summary of the optimization process. diff --git a/docs/webapp/applications/apps_llama_deployment.md b/docs/webapp/applications/apps_llama_deployment.md index 136423e3..2819882c 100644 --- a/docs/webapp/applications/apps_llama_deployment.md +++ b/docs/webapp/applications/apps_llama_deployment.md @@ -78,4 +78,8 @@ values from the file, which can be modified before launching the app instance Used to stop the application from entering an idle state when the machine metrics are low but the application is actually still running -![llama deployment app form](../../img/apps_llama_form.png) \ No newline at end of file +
+ +![llama deployment app form](../../img/apps_llama_form.png) + +
\ No newline at end of file diff --git a/docs/webapp/applications/apps_model_deployment.md b/docs/webapp/applications/apps_model_deployment.md index 22c2e90f..e0c0afe4 100644 --- a/docs/webapp/applications/apps_model_deployment.md +++ b/docs/webapp/applications/apps_model_deployment.md @@ -146,6 +146,9 @@ instance task will be enqueued (make sure an agent is assigned to that queue) * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![vLLM Model Deployment app form](../../img/apps_model_deployment_form.png#light-mode-only) ![vLLM Model Deployment app form](../../img/apps_model_deployment_form_dark.png#dark-mode-only) +
\ No newline at end of file diff --git a/docs/webapp/applications/apps_ssh_session.md b/docs/webapp/applications/apps_ssh_session.md index d38cd5ee..113bb001 100644 --- a/docs/webapp/applications/apps_ssh_session.md +++ b/docs/webapp/applications/apps_ssh_session.md @@ -93,5 +93,9 @@ closed and restored into a new instance when the session app instance is cloned * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![SSH Session form](../../img/apps_ssh_session_wizard.png#light-mode-only) -![SSH Session form](../../img/apps_ssh_session_wizard_dark.png#dark-mode-only) \ No newline at end of file +![SSH Session form](../../img/apps_ssh_session_wizard_dark.png#dark-mode-only) + +
\ No newline at end of file diff --git a/docs/webapp/applications/apps_task_scheduler.md b/docs/webapp/applications/apps_task_scheduler.md index 8d6d4129..7d623a02 100644 --- a/docs/webapp/applications/apps_task_scheduler.md +++ b/docs/webapp/applications/apps_task_scheduler.md @@ -33,9 +33,12 @@ times. * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![TaskScheduler instance launch form](../../img/apps_taskscheduler_wizard.png#light-mode-only) ![TaskScheduler instance launch form](../../img/apps_taskscheduler_wizard_dark.png#dark-mode-only) +
## Dashboard diff --git a/docs/webapp/applications/apps_trigger_manager.md b/docs/webapp/applications/apps_trigger_manager.md index 02c49362..5ee17eb6 100644 --- a/docs/webapp/applications/apps_trigger_manager.md +++ b/docs/webapp/applications/apps_trigger_manager.md @@ -52,9 +52,13 @@ The app monitors your workspace for trigger events and will launch copies of the * **Export Configuration** - Export the app instance configuration as a JSON file, which you can later import to create a new instance with the same configuration +
+ ![Trigger manager instance launch form](../../img/apps_trigger_manager_wizard.png#light-mode-only) ![Trigger manager instance launch form](../../img/apps_trigger_manager_wizard_dark.png#dark-mode-only) +
+ ## Dashboard The Trigger Manager app instance's dashboard displays its console log. The log shows the instance's activity: periodic diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index 88c520c1..791e6618 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -1,8 +1,8 @@ --- -title: The Model table +title: The Model Table --- -The model table is a [customizable](#customizing-the-models-table) list of models associated with the tasks in a project. From the model table, +The model table is a [customizable](#customizing-the-model-table) list of models associated with the tasks in a project. From the model table, view model details, and modify, publish, archive, tag, and move models to other projects. View the model table in table view Table view @@ -64,7 +64,7 @@ Customize the table using any of the following: * Sort columns - By metadata, metric, ML framework, description, and last update elapsed time. :::note -The following models-table customizations are saved on a **per-project** basis: +The following model-table customizations are saved on a **per-project** basis: * Columns order * Column width * Active sort order diff --git a/src/css/custom.css b/src/css/custom.css index b8db16a1..e428974d 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -82,6 +82,10 @@ html[data-theme="dark"] a:hover { max-width: 75%; } +.max-w-65 { + max-width: 65%; +} + .max-w-50 { max-width: 50%; }