ClearML/clearml-docs
1
0
Fork 0
mirror of https://github.com/clearml/clearml-docs synced 2025-06-26 18:17:44 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Small edits (#136)

Browse Source
This commit is contained in:
pollfly
2021-12-22 10:54:04 +02:00
committed by GitHub
parent 5bc60cfac6
commit eae9708461
10 changed files with 165 additions and 137 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/webapp/webapp_exp_tuning.md
View File

@@ -130,11 +130,11 @@ Add, change, or delete hyperparameters, which are organized in the **ClearML Web
* **TF_DEFINE** - TensorFlow definitions (from code, TF_DEFINEs automatic logging).
* **General** - Parameter dictionaries (from code, connected to the Task by calling the [Task.connect](../references/sdk/task.md#connect)
method.
method).
* Environment variables - Tracked if the `CLEARML_LOG_ENVIRONMENT` environment variable was set (see this [FAQ](../faq#track-env-vars)).
* Custom named parameter groups - see the `name` parameter in [Task.connect](../references/sdk/task.md#connectmutable-namenone).
* Custom named parameter groups (see the `name` parameter in [Task.connect](../references/sdk/task.md#connectmutable-namenone)).
**To add, change, or delete hyperparameters:**
@@ -191,7 +191,7 @@ model in the **MODELS** tab.
1. Edit the model configuration or label enumeration.
* Model configuration - In the **NETWORK** tab **>** Hover and click **EDIT**. **>** CLick **EDIT** or **CLEAR** (to
remove the configuration
remove the configuration).
Users can also search for the configuration (hover over the configuration textbox, the search box appears) and copy the
configuration to the clipboard (hover and click <img src="/docs/latest/icons/ico-clipboard.svg" alt="Copy Clipboard" className="icon size-md" />).

2
docs/webapp/webapp_model_table.md
View File

@@ -58,7 +58,7 @@ allow each feature. Model states are *Draft* (editable) and *Published* (read-on
| ClearML Action | Description | States Valid for the Action |
|---|---|--|
| View details | Model details include general information, the model configuration, and label enumeration. Click a model and the info panel slides open. | Any state |
| View details | Model details include general information, the model configuration, and label enumeration. Click a model, and the info panel slides open. | Any state |
| Publish | Publish a model to prevent changes to it. *Published* models are read-only. If a model is Published, its experiment also becomes Published (read-only). | *Draft* |
| Archive | To more easily work with active models, move a model to the archive. See [Archiving](webapp_archiving). | Any state |
| Tags | Tag models with color-coded labels to assist in organizing work. See [tagging models](#tagging-models). | Any state |

12
docs/webapp/webapp_overview.md
View File

@@ -2,19 +2,19 @@
title: Overview
---
The **ClearML Web UI** is the graphical user interface for the **ClearML** platform, which includes:
The **ClearML Web UI** is the graphical user interface for the ClearML platform, which includes:
* Experiment management
* Browsing
* Resource utilization monitoring
* Profile management
* Direct access to the **ClearML** community (Slack Channel, Youtube, and GitHub).
* Direct access to the ClearML community (Slack Channel, Youtube, and GitHub).
![image](../img/webapp_screenshots.gif)
The **ClearML Web UI** is composed of the following pages:
* The [Home](webapp_home.md) Page - The dashboard for recent activity, and quick access to experiments and projects.
* The [Projects Page](webapp_projects_page.md) - The main experimentation page. It is a main projects page where specific projects can be opened.
* The [Projects Page](webapp_projects_page.md) - The main experimentation page, where specific projects can be opened.
Each project page contains customizable [experiments](webapp_exp_table.md) and [models](webapp_model_table.md) tables
with the following options:
@@ -27,12 +27,12 @@ The **ClearML Web UI** is composed of the following pages:
* [View](webapp_model_viewing.md) and [modify](webapp_model_modifying.md) models
* The [Workers and Queues](webapp_workers_queues.md) Page - The resource monitoring and queues management page.
* The [Profile Page](webapp_profile.md) - Manage a **ClearML** user account:
* Create **ClearML** credentials
* The [Profile Page](webapp_profile.md) - Manage a ClearML user account:
* Create ClearML credentials
* Provide Cloud Storage Access credentials for the **ClearML Web UI**
* If using the **ClearML Hosted Service**, invite users and switch workspaces
In addition, from the **ClearML Web UI**, use these buttons to access the **ClearML** community:
In addition, from the **ClearML Web UI**, use these buttons to access the ClearML community:
* The **ClearML** <img src="/docs/latest/icons/ico-slack-c.svg" alt="Slack Channel" className="icon size-md" /> Slack channel. Ask questions about **ClearML**.
* The **ClearML** <img src="/docs/latest/icons/ico-youtube.svg" alt="YouTube" className="icon size-md" /> YouTube Channel. View our tutorials, presentations, and discussions.