mirror of
https://github.com/clearml/clearml-docs
synced 2025-02-07 13:21:46 +00:00
Add project overview (#8)
This commit is contained in:
parent
b87ea3b9d7
commit
7e907a0ffc
@ -18,7 +18,8 @@ model checkpoints, artifacts, and charts to cloud storage (see [Storage](../inte
|
|||||||
In the UI and code, tasks are grouped into projects, which are logical entities similar to folders. Users can decide
|
In the UI and code, tasks are grouped into projects, which are logical entities similar to folders. Users can decide
|
||||||
how to group tasks, though different models or objectives are usually grouped into different projects.
|
how to group tasks, though different models or objectives are usually grouped into different projects.
|
||||||
Projects can be divided into sub-projects (and sub-sub-projects, etc.) just like files and subdirectories on a
|
Projects can be divided into sub-projects (and sub-sub-projects, etc.) just like files and subdirectories on a
|
||||||
computer, making experiment organization easier.
|
computer, making experiment organization easier. In the WebApp, every project has an [**Overview**](../webapp/webapp_project_overview.md)
|
||||||
|
tab, where a project description can be written and shared.
|
||||||
|
|
||||||
Tasks that are in the system can be accessed and utilized with code. To [access a task](#accessing-tasks), it can be identified either by a
|
Tasks that are in the system can be accessed and utilized with code. To [access a task](#accessing-tasks), it can be identified either by a
|
||||||
project name & task name combination or by a unique ID.
|
project name & task name combination or by a unique ID.
|
||||||
|
BIN
docs/img/gif/webapp_metric_snapshot.gif
Normal file
BIN
docs/img/gif/webapp_metric_snapshot.gif
Normal file
Binary file not shown.
After Width: | Height: | Size: 415 KiB |
36
docs/webapp/webapp_project_overview.md
Normal file
36
docs/webapp/webapp_project_overview.md
Normal file
@ -0,0 +1,36 @@
|
|||||||
|
---
|
||||||
|
title: Project Overview
|
||||||
|
---
|
||||||
|
|
||||||
|
A project's **OVERVIEW** tab provides options to present a general picture of the project. The page consists of a graph
|
||||||
|
that can show a snapshot of a specific metric's value across the project's experiments, and a space to enter and edit a
|
||||||
|
project's description. When either overview option is utilized, the **OVERVIEW** tab becomes the project's landing page,
|
||||||
|
meaning that it's the first thing that is seen when opening the project.
|
||||||
|
|
||||||
|
![Project overview tab gif](../img/gif/webapp_metric_snapshot.gif)
|
||||||
|
|
||||||
|
## Metric snapshot
|
||||||
|
|
||||||
|
On the top of the **OVERVIEW** tab, there is an option to display a **metric snapshot**. Choose a metric and variant,
|
||||||
|
and then the window will present an aggregated view of the value for that metric value and the time that each
|
||||||
|
experiment scored that value. This way, the project's progress can be quickly deduced.
|
||||||
|
|
||||||
|
All project experiments that reported the specified metric show up in the snapshot. Their colors vary based
|
||||||
|
on their status (`Completed`, `Aborted`, `Published`, or `Failed`). Hover over a point in the snapshot, and a box will
|
||||||
|
appear with the details of the experiment associated with the metric value. Click the point, and you will
|
||||||
|
be sent to the experiment's page.
|
||||||
|
|
||||||
|
## Project description
|
||||||
|
|
||||||
|
Every project has a `description` field. The UI provides a Markdown editor to edit this field.
|
||||||
|
|
||||||
|
In the Markdown document, you can write and share reports and add links to **ClearML** experiments
|
||||||
|
or any network resource such as issue tracker, web repository, etc.
|
||||||
|
|
||||||
|
### Editing the description
|
||||||
|
|
||||||
|
To edit the description in the **OVERVIEW** tab, hover over the description section, and press the **EDIT** button that
|
||||||
|
appears on the top right of the window.
|
||||||
|
|
||||||
|
When using the Markdown editor, you can make use of features such as bullets,
|
||||||
|
numbered lists, code blocks, headings with levels, images, and italicized and bolded text.
|
@ -24,6 +24,7 @@ module.exports = {
|
|||||||
{'WebApp': ['webapp/webapp_overview', 'webapp/webapp_home',
|
{'WebApp': ['webapp/webapp_overview', 'webapp/webapp_home',
|
||||||
{
|
{
|
||||||
'Projects Page': [
|
'Projects Page': [
|
||||||
|
'webapp/webapp_project_overview',
|
||||||
{
|
{
|
||||||
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
|
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
|
||||||
'webapp/webapp_exp_comparing', 'webapp/webapp_exp_sharing']
|
'webapp/webapp_exp_comparing', 'webapp/webapp_exp_sharing']
|
||||||
|
Loading…
Reference in New Issue
Block a user