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

Update docs (#496)

Browse Source
This commit is contained in:
pollfly
2023-03-15 15:11:34 +02:00
committed by GitHub
parent 095c70d48f
commit 6b764f15ae
30 changed files with 119 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/webapp/datasets/webapp_dataset_page.md
View File

@@ -10,6 +10,11 @@ Datasets created with earlier versions of `clearml` are available in their origi
Use the **Datasets** Page to navigate between and manage datasets. The page shows summaries
for all datasets created using [ClearML Data](../../clearml_data/clearml_data.md).
You can view the datasets page in Project view <img src="/docs/latest/icons/ico-project-view.svg" alt="Project view" className="icon size-md" />
or in List view <img src="/docs/latest/icons/ico-flat-view.svg" alt="List view" className="icon size-md" />. In List
view, all datasets are shown side-by-side. In Project view, datasets are organized according to their projects, and
top-level projects are displayed. Click on a project card to view the project's datasets.
Click on a dataset card to navigate to its [Version List](webapp_dataset_viewing.md), where you can view the
dataset versions' lineage and contents.
@@ -22,10 +27,23 @@ Filter the datasets to find the one you’re looking for more easily. These filt
![Dataset page](../../img/webapp_dataset_page.png)
## Project Cards
In Project view, project cards display a project’s summarized dataset information:
![Project card](../../img/webapp_dataset_project_card.png)
* Project name
* Number of datasets in project
* Tags used by datasets in project
Click on a project card to view its datasets.
## Dataset Cards
The dataset cards display summarized dataset information:
In List view, the dataset cards display summarized dataset information:
<div class="max-w-50">

16
docs/webapp/pipelines/webapp_pipeline_page.md
View File

@@ -5,6 +5,11 @@ title: Pipelines Page
Use the **Pipelines** Page to navigate between and manage pipelines. The page shows execution summaries for all
[ClearML Pipelines](../../pipelines/pipelines.md).
You can view the Pipelines page in Project view <img src="/docs/latest/icons/ico-project-view.svg" alt="Project view" className="icon size-md" />
or in List view <img src="/docs/latest/icons/ico-flat-view.svg" alt="List view" className="icon size-md" />. In List
view, all pipelines are shown side-by-side. In Project view, pipelines are organized according to their projects, and
top-level projects are displayed. Click on a project card to view the project's pipelines.
Click on a pipeline card to navigate to its [Pipeline Runs Table](webapp_pipeline_table.md), where you can view the
pipeline structure, configuration, and outputs of all the pipeline’s runs, as well as create new runs.
@@ -18,14 +23,21 @@ Filter the pipelines to find the one you’re looking for more easily. These fil
![Pipelines page](../../img/webapp_pipeline_table.png)
## Project Cards
In Project view, project cards display a project's summarized pipeline information:
![Pipeline project card](../../img/webapp_pipeline_project_card.png)
Click on a project card to view its pipelines.
## Pipeline Cards
The pipeline cards display summarized pipeline information:
In List view, the pipeline cards display summarized pipeline information:
<div class="max-w-50">
![Project card](../../img/webapp_pipeline_card.png)
![Pipeline card](../../img/webapp_pipeline_card.png)
</div>

32
docs/webapp/webapp_model_viewing.md
View File

@@ -61,4 +61,34 @@ The **METADATA** tab lists the model's metadata entries, which consist of a key,
To modify / add / delete model metadata items, hover over Metadata, then click EDIT. This opens the Metadata editing
window.
![Model metadata editing](../img/webapp_model_metadata_edit.png)
![Model metadata editing](../img/webapp_model_metadata_edit.png)
## Lineage
The **LINEAGE** tab displays the model's creating experiment (the ClearML experiment that generated the model) and lists
all the tasks where the model is used as an input model. Click an experiment to navigate to its page.
You can filter the task list by tags and task status.
Use the search bar to look for experiments based on their name, ID, or description.
![Model lineage](../img/webapp_model_lineage.png)
## Scalars
The **SCALARS** tab displays all scalar plots attached to a model. Scalar values are presented as time series line
charts. To see the series for a metric in high resolution, view it in full screen mode by hovering over the graph and
clicking <img src="/docs/latest/icons/ico-maximize.svg" alt="Maximize plot icon" className="icon size-sm space-sm" />.
For better plot analysis, see [Plot Controls](webapp_exp_track_visual.md#plot-controls).
Reported single value scalars are aggregated into a table plot displaying scalar names and values.
![Model scalars](../img/webapp_model_scalars.png)
## Plots
The **PLOTS** tab displays plots attached to a model. For better plot analysis, see [Plot Controls](webapp_exp_track_visual.md#plot-controls).
![Model plots](../img/webapp_model_plots.png)

5
docs/webapp/webapp_profile.md
View File

@@ -32,7 +32,8 @@ The profile tab presents user information.
### Customizing UI Behavior
Under **USER PREFERENCES**, users can set a few web UI options:
* **Show Hidden Projects** - Show ClearML infrastructure projects alongside your own projects. Disabled by default.
* **Show Hidden Projects** - Show ClearML infrastructure projects alongside your own projects. Disabled by default. When
enabled, these projects are labeled with <img src="/docs/latest/icons/ico-ghost.svg" alt="Hidden project" className="icon size-md space-sm" />.
* **Don't show ClearML Examples** - Hide the preloaded ClearML example content (project, pipeline, dataset, etc.)
* **HiDPI browser scale override** - Adjust scaling on High-DPI monitors to improve the web UI experience.
Enabled by default.
@@ -205,7 +206,7 @@ The system includes three pre-configured groups that can't be removed:
permissions to workspace resources
* `Queue admins` - Can create / delete / rename queues
The user group table lists all the active user groups. Each row includes a group's name, description, and member list.
The user group table lists all the active user groups. Each row includes a group's name, description, member list, and ID.
![User Management Page](../img/settings_user_management_table.png)

8
docs/webapp/webapp_projects_page.md
View File

@@ -28,6 +28,14 @@ subprojects. Click on a subproject's name to navigate to it.
![Subproject tab](../img/webapp_sub_project_card.png)
:::note Hidden Projects
By default, ClearML infrastructure projects (i.e. dataset, pipeline, reports, application projects) are not shown in the
projects page. You can enable viewing them in **Settings > Configuration > User Preferences**. When enabled, all infrastructure projects
are labeled with <img src="/docs/latest/icons/ico-ghost.svg" alt="Hidden project" className="icon size-md space-sm" />
![Hidden project configurtion](../img/settings_hidden_projects.png)
:::
### Project Actions
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right

17
docs/webapp/webapp_reports.md
View File

@@ -28,6 +28,7 @@ Reports are editable Markdown documents, supporting:
* Tables
* Code blocks
* Text and image hyperlinks
* Embedded images uploaded from your computer
* Embedded ClearML task content
![Report](../img/webapp_report.png)
@@ -59,17 +60,25 @@ experiment comparison)
![Reports step 3](../img/reports_step_3.png)
## Reports Page
Use the Reports Page to navigate between and manage reports. The page shows summaries
for all reports.
Use the Reports Page to navigate between and manage reports.
Click on a report card to access it.
You can view the reports page in Project view <img src="/docs/latest/icons/ico-project-view.svg" alt="Project view" className="icon size-md" />
or in List view <img src="/docs/latest/icons/ico-flat-view.svg" alt="List view" className="icon size-md" />. In List
view, all reports are shown side-by-side. In Project view, reports are organized according to their projects, and
top-level projects are displayed. Click on a project card to view the project's reports.
![Report page](../img/webapp_report_page.png)
## Project Cards
In Project view, project cards display a project’s summarized report information:
![Report project card](../img/webapp_report_project_card.png)
Click on a project card to view its reports.
### Report Cards
The report cards display summarized report information:
In List view, the report cards display summarized report information:
<div class="max-w-50">