mirror of
https://github.com/clearml/clearml-docs
synced 2025-04-02 12:21:08 +00:00
Add projects page doc (#135)
This commit is contained in:
parent
f44ebcaae9
commit
5bc60cfac6
@ -23,7 +23,7 @@ version contents ready to be updated.
|
||||
Organize the datasets according to use-cases and use tags. This makes managing multiple datasets and
|
||||
accessing the most updated datasets for different use-cases easier.
|
||||
|
||||
Like any ClearML tasks, datasets can be organized into [projects (and sub-projects)](../fundamentals/projects.md#creating-sub-projects).
|
||||
Like any ClearML tasks, datasets can be organized into [projects (and subprojects)](../fundamentals/projects.md#creating-subprojects).
|
||||
Additionally, when creating a dataset, tags can be applied to the dataset, which will make searching for the dataset easier.
|
||||
|
||||
Organizing your datasets into projects by use-case makes it easier to access the most recent dataset version for that use-case.
|
||||
|
@ -7,7 +7,7 @@ when Hyper-Datasets are enabled), providing a logical structure similar to file
|
||||
An often useful method is to categorize components into projects according to models or objectives.
|
||||
Grouping into projects helps in identifying tasks, models, and dataviews when queried.
|
||||
|
||||
Projects can be divided into sub-projects (and sub-sub-projects, etc.) just like files and subdirectories on a
|
||||
Projects can be divided into subprojects (and sub-subprojects, etc.) just like files and subdirectories on a
|
||||
computer, making organization easier.
|
||||
|
||||
Projects contain a textual description field for noting relevant information. The WebApp supports markdown rendering
|
||||
@ -25,12 +25,12 @@ models, and dataviews, can be viewed in the project's [experiments table](../web
|
||||
|
||||
## Usage
|
||||
|
||||
### Creating Sub-projects
|
||||
### Creating Subprojects
|
||||
|
||||
When [initializing a task](task.md#task-creation), its project needs to be specified. If the project entered does not exist, it will be created.
|
||||
Projects can contain sub-projects, just like folders can contain sub-folders. Input into the `project_name`
|
||||
Projects can contain subprojects, just like folders can contain sub-folders. Input into the `project_name`
|
||||
parameter a target project path. The project path should follow the project tree hierarchy, in which the project and
|
||||
sub-projects are slash (`/`) delimited.
|
||||
subprojects are slash (`/`) delimited.
|
||||
|
||||
For example:
|
||||
|
||||
|
@ -164,7 +164,7 @@ make sure to close a Task, before initializing a new one. To close a task simply
|
||||
(see example [here](../guides/advanced/multiple_tasks_single_process.md)).
|
||||
|
||||
When initializing a Task, its project needs to be specified. If the project entered does not exist, it will be created.
|
||||
Projects can be divided into sub-projects, just like folders are broken into sub-folders.
|
||||
Projects can be divided into subprojects, just like folders are broken into sub-folders.
|
||||
For example:
|
||||
```python
|
||||
Task.init(project_name='main_project/sub_project', task_name='test')
|
||||
|
@ -38,7 +38,7 @@ The following Dataviews-table customizations are saved on a **per project** basi
|
||||
* Active sort order
|
||||
* Active filters
|
||||
|
||||
If a project has sub-projects, the Dataviews can be viewed by their sub-project groupings or together with
|
||||
If a project has subprojects, the Dataviews can be viewed by their subproject groupings or together with
|
||||
all the Dataviews in the project. The customizations of these two views are saved separately.
|
||||
:::
|
||||
|
||||
|
BIN
docs/img/webapp_projects_card.png
Normal file
BIN
docs/img/webapp_projects_card.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 28 KiB |
BIN
docs/img/webapp_projects_context_menu.png
Normal file
BIN
docs/img/webapp_projects_context_menu.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 34 KiB |
BIN
docs/img/webapp_projects_inside.png
Normal file
BIN
docs/img/webapp_projects_inside.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 68 KiB |
BIN
docs/img/webapp_projects_page.png
Normal file
BIN
docs/img/webapp_projects_page.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 65 KiB |
BIN
docs/img/webapp_sub_project_card.png
Normal file
BIN
docs/img/webapp_sub_project_card.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 23 KiB |
@ -63,7 +63,7 @@ The following experiments-table customizations are saved on a **per project** ba
|
||||
* Active filters
|
||||
* Custom columns
|
||||
|
||||
If a project has sub-projects, the experiments can be viewed by their sub-project groupings or together with
|
||||
If a project has subprojects, the experiments can be viewed by their subproject groupings or together with
|
||||
all the experiments in the project. The customizations of these two views are saved separately.
|
||||
:::
|
||||
|
||||
|
@ -47,7 +47,7 @@ The following models-table customizations are saved on a **per project** basis:
|
||||
* Active filters
|
||||
* Custom columns
|
||||
|
||||
If a project has sub-projects, the models can be viewed by their sub-project groupings or together with
|
||||
If a project has subprojects, the models can be viewed by their subproject groupings or together with
|
||||
all the models in the project. The customizations of these two views are saved separately.
|
||||
:::
|
||||
|
||||
|
@ -14,7 +14,7 @@ The **ClearML Web UI** is the graphical user interface for the **ClearML** platf
|
||||
|
||||
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 - 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. It is a main projects 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:
|
||||
|
48
docs/webapp/webapp_projects_page.md
Normal file
48
docs/webapp/webapp_projects_page.md
Normal file
@ -0,0 +1,48 @@
|
||||
---
|
||||
title: Projects Page
|
||||
---
|
||||
|
||||
Use the Projects Page for project navigation and management.
|
||||
|
||||
Your projects are displayed like folders: click a folder to access its contents. The Projects Page shows the top-level
|
||||
projects in your workspace. Projects that contain nested subprojects are identified by an extra nested project tab.
|
||||
An exception is the **All Experiments** folder, which shows all projects’ and subprojects’ contents in a single, flat
|
||||
list.
|
||||
|
||||

|
||||
|
||||
If a project has any subprojects, clicking its folder will open its own project page. Access the projects’ top-level
|
||||
contents (i.e. experiments, models etc.) via the folder with the bracketed (`[ ]`) project name.
|
||||
|
||||

|
||||
|
||||
If a project does not contain any subprojects, clicking on its folder will open its experiment table (or [Project Overview](webapp_project_overview.md)
|
||||
page when relevant).
|
||||
|
||||
## Project Folders
|
||||
|
||||
Project folders display summarized project information.
|
||||
|
||||

|
||||
|
||||
When relevant, the folder has a tab which displays the number of subprojects in the project. Click the tab to view a list of
|
||||
subprojects. Click on a subproject's name to navigate to it.
|
||||
|
||||

|
||||
|
||||
### Project Actions
|
||||
|
||||
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right
|
||||
of a project folder to open its context menu and access project actions.
|
||||
|
||||

|
||||
|
||||
To delete a project, all of its experiments must be [archived](webapp_archiving.md) first.
|
||||
|
||||
## Create New Projects
|
||||
|
||||
1. Click the **+ NEW PROJECT** button in the top right of the page in a project's context menu, which will open a
|
||||
**New Project** window.
|
||||
1. Input a project name
|
||||
1. Input a target location (`Create in`). Projects can be created in the root or in another project (or subproject)
|
||||
1. Input a description and default output destination.
|
@ -24,7 +24,8 @@ module.exports = {
|
||||
|
||||
{'WebApp': ['webapp/webapp_overview', 'webapp/webapp_home',
|
||||
{
|
||||
'Projects Page': [
|
||||
'Projects': [
|
||||
'webapp/webapp_projects_page',
|
||||
'webapp/webapp_project_overview',
|
||||
{
|
||||
'Experiments': ['webapp/webapp_exp_table', 'webapp/webapp_exp_track_visual', 'webapp/webapp_exp_reproducing', 'webapp/webapp_exp_tuning',
|
||||
|
Loading…
Reference in New Issue
Block a user