mirror of
https://github.com/clearml/clearml-docs
synced 2025-06-26 18:17:44 +00:00
Add projects page doc (#135)
This commit is contained in:
@@ -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.
|
||||
Reference in New Issue
Block a user