diff --git a/docs/clearml_data/best_practices.md b/docs/clearml_data/best_practices.md index 289c0045..fade03f4 100644 --- a/docs/clearml_data/best_practices.md +++ b/docs/clearml_data/best_practices.md @@ -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. diff --git a/docs/fundamentals/projects.md b/docs/fundamentals/projects.md index 963f0184..6d337f56 100644 --- a/docs/fundamentals/projects.md +++ b/docs/fundamentals/projects.md @@ -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: diff --git a/docs/fundamentals/task.md b/docs/fundamentals/task.md index eaddc78c..d6e31bee 100644 --- a/docs/fundamentals/task.md +++ b/docs/fundamentals/task.md @@ -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') diff --git a/docs/hyperdatasets/webapp/webapp_dataviews.md b/docs/hyperdatasets/webapp/webapp_dataviews.md index d7513296..e547049a 100644 --- a/docs/hyperdatasets/webapp/webapp_dataviews.md +++ b/docs/hyperdatasets/webapp/webapp_dataviews.md @@ -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. ::: diff --git a/docs/img/webapp_projects_card.png b/docs/img/webapp_projects_card.png new file mode 100644 index 00000000..5298de91 Binary files /dev/null and b/docs/img/webapp_projects_card.png differ diff --git a/docs/img/webapp_projects_context_menu.png b/docs/img/webapp_projects_context_menu.png new file mode 100644 index 00000000..aaf78a7c Binary files /dev/null and b/docs/img/webapp_projects_context_menu.png differ diff --git a/docs/img/webapp_projects_inside.png b/docs/img/webapp_projects_inside.png new file mode 100644 index 00000000..c56820ed Binary files /dev/null and b/docs/img/webapp_projects_inside.png differ diff --git a/docs/img/webapp_projects_page.png b/docs/img/webapp_projects_page.png new file mode 100644 index 00000000..ca0c6e78 Binary files /dev/null and b/docs/img/webapp_projects_page.png differ diff --git a/docs/img/webapp_sub_project_card.png b/docs/img/webapp_sub_project_card.png new file mode 100644 index 00000000..22313ce8 Binary files /dev/null and b/docs/img/webapp_sub_project_card.png differ diff --git a/docs/webapp/webapp_exp_table.md b/docs/webapp/webapp_exp_table.md index 5888d220..ba3aea3d 100644 --- a/docs/webapp/webapp_exp_table.md +++ b/docs/webapp/webapp_exp_table.md @@ -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. ::: diff --git a/docs/webapp/webapp_model_table.md b/docs/webapp/webapp_model_table.md index 5ee3adbf..5ece07dc 100644 --- a/docs/webapp/webapp_model_table.md +++ b/docs/webapp/webapp_model_table.md @@ -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. ::: diff --git a/docs/webapp/webapp_overview.md b/docs/webapp/webapp_overview.md index 6f8942f3..0ea09b81 100644 --- a/docs/webapp/webapp_overview.md +++ b/docs/webapp/webapp_overview.md @@ -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: diff --git a/docs/webapp/webapp_projects_page.md b/docs/webapp/webapp_projects_page.md new file mode 100644 index 00000000..8094c2eb --- /dev/null +++ b/docs/webapp/webapp_projects_page.md @@ -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. + +![Projects page](../img/webapp_projects_page.png) + +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. + +![Subprojects in projects](../img/webapp_projects_inside.png) + +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. + +![Project card](../img/webapp_projects_card.png) + +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. + +![Subproject tab](../img/webapp_sub_project_card.png) + +### Project Actions + +Click Menu on the top right +of a project folder to open its context menu and access project actions. + +![Project context menu](../img/webapp_projects_context_menu.png) + +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. diff --git a/sidebars.js b/sidebars.js index 417e488b..287db45a 100644 --- a/sidebars.js +++ b/sidebars.js @@ -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',