ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-04-03 12:51:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#968)

Browse Source
This commit is contained in:
pollfly 2024-11-20 11:03:11 +02:00 committed by GitHub
parent bbbe57aa21
commit 3f80b9bdc8
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
5 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
docs/configs/clearml_conf.md
View File

@ -1108,7 +1108,7 @@ URL to a CA bundle, or set this option to `false` to skip SSL certificate verifi
* Log specific environment variables. OS environments are listed in the UI, under an experiment's * Log specific environment variables. OS environments are listed in the UI, under an experiment's
**CONFIGURATION > HYPERPARAMETERS > Environment** section. **CONFIGURATION > HYPERPARAMETERS > Environment** section.
Multiple selected variables are supported including the suffix "\*". For example: "AWS\_\*" will log any OS environment Multiple selected variables are supported including the suffix "\*". For example: "AWS\_\*" will log any OS environment
variable starting with "AWS\_". Example: `log_os_environments: ["AWS_*", "CUDA_VERSION"]` variable starting with `"AWS\_"`. Example: `log_os_environments: ["AWS_*", "CUDA_VERSION"]`
* This value can be overwritten with OS environment variable `CLEARML_LOG_ENVIRONMENT=AWS_*,CUDA_VERSION`. * This value can be overwritten with OS environment variable `CLEARML_LOG_ENVIRONMENT=AWS_*,CUDA_VERSION`.

2
docs/deploying_clearml/clearml_server_config.md
View File

@ -470,7 +470,7 @@ The action will appear in the context menu for the object type in which it was s
to access the context menu. to access the context menu.
* Project - In the project page > click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" className="icon size-md space-sm" /> * Project - In the project page > click the menu button <img src="/docs/latest/icons/ico-bars-menu.svg" className="icon size-md space-sm" />
on a specific project card to access its context menu on a specific project card to access its context menu
* Queue - In the [Workers and Queues](../webapp/webapp_workers_queues.md) page > **QUEUES** tab, right-click the queue * Queue - In the [Orchestration](../webapp/webapp_workers_queues.md) page > **QUEUES** tab, right-click the queue
to access its context menu to access its context menu
The custom action is always performed from a context-menu opened from a specific selected item. The custom action is always performed from a context-menu opened from a specific selected item.

8
docs/faq.md
View File

@ -91,7 +91,7 @@ title: FAQ
**ClearML Server Troubleshooting** **ClearML Server Troubleshooting**
* [I did a reinstall. Why can't I create credentials in the WebApp (UI)?](#clearml-server-reinstall-cookies) * [After reinstalling, why can't I create credentials in the WebApp (UI)?](#clearml-server-reinstall-cookies)
* [How do I fix Docker upgrade errors?](#common-docker-upgrade-errors) * [How do I fix Docker upgrade errors?](#common-docker-upgrade-errors)
* [Why is web login authentication not working?](#port-conflict) * [Why is web login authentication not working?](#port-conflict)
* [How do I bypass a proxy configuration to access my local ClearML Server?](#proxy-localhost) * [How do I bypass a proxy configuration to access my local ClearML Server?](#proxy-localhost)
@ -326,8 +326,8 @@ For more task configuration options, see [Hyperparameters](fundamentals/hyperpar
#### I noticed that all of my experiments appear as "Training". Are there other options? <a id="other-experiment-types"></a> #### I noticed that all of my experiments appear as "Training". Are there other options? <a id="other-experiment-types"></a>
Yes! When creating experiments and calling [`Task.init()`](references/sdk/task.md#taskinit), Yes! ClearML supports [multiple experiment types](fundamentals/task.md#task-types). When creating experiments and
you can provide an experiment type. ClearML supports [multiple experiment types](fundamentals/task.md#task-types). For example: calling [`Task.init()`](references/sdk/task.md#taskinit), you can provide an experiment type. For example:
```python ```python
task = Task.init(project_name, task_name, Task.TaskTypes.testing) task = Task.init(project_name, task_name, Task.TaskTypes.testing)
@ -977,7 +977,7 @@ For detailed instructions, see [Modifying non-responsive Task watchdog settings]
## ClearML Server Troubleshooting ## ClearML Server Troubleshooting
#### I did a reinstall. Why can't I create credentials in the WebApp (UI)? <a id="clearml-server-reinstall-cookies"></a> #### After reinstalling, why can't I create credentials in the WebApp (UI)? <a id="clearml-server-reinstall-cookies"></a>
The issue is likely your browser cookies for ClearML Server. Clearing your browser cookies for ClearML Server is recommended. The issue is likely your browser cookies for ClearML Server. Clearing your browser cookies for ClearML Server is recommended.
For example: For example:

BIN
docs/img/apps_embedding_model_deployment.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 158 KiB

After

Width:  |  Height:  |  Size: 158 KiB

2
docs/webapp/webapp_exp_table.md
View File

@ -217,7 +217,7 @@ to open the context menu
|---|---|---|---| |---|---|---|---|
| Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). Can also be accessed by double-clicking an experiment in the experiments table. | Any state | None | | Details | Open the experiment's [info panel](webapp_exp_track_visual.md#info-panel) (keeps the experiments list in view). Can also be accessed by double-clicking an experiment in the experiments table. | Any state | None |
| View Full Screen | View experiment details in [full screen](webapp_exp_track_visual.md#full-screen-details-view). | Any state | None | | View Full Screen | View experiment details in [full screen](webapp_exp_track_visual.md#full-screen-details-view). | Any state | None |
| Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Workers and Queues](webapp_workers_queues.md) page. | *Enqueued* | None | | Manage Queue | If an experiment is *Pending* in a queue, view the utilization of that queue, manage that queue (remove experiments and change the order of experiments), and view information about the worker(s) listening to the queue. See the [Orchestration](webapp_workers_queues.md) page. | *Enqueued* | None |
| View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None | | View Worker | If an experiment is *Running*, view resource utilization, worker details, and queues to which a worker is listening. | *Running* | None |
| Share | For **ClearML Hosted Service** users only, [share](webapp_exp_sharing.md) an experiment and its model with a **ClearML Hosted Service** user in another workspace. | Any state | None | | Share | For **ClearML Hosted Service** users only, [share](webapp_exp_sharing.md) an experiment and its model with a **ClearML Hosted Service** user in another workspace. | Any state | None |
| Archive | Move experiment to the project's archive. If it is shared (ClearML Hosted Service only), the experiment becomes private. | Any state | *Pending* to *Draft* | | Archive | Move experiment to the project's archive. If it is shared (ClearML Hosted Service only), the experiment becomes private. | Any state | *Pending* to *Draft* |