clearml-docs/docs/webapp/webapp_projects_page.md

86 lines
3.8 KiB
Markdown
Raw Normal View History

2021-12-21 11:42:44 +00:00
---
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.
2023-10-09 12:48:19 +00:00
An exception is the **All Experiments** folder, which shows all projects' and subprojects' contents in a single, flat
2021-12-21 11:42:44 +00:00
list.
2022-03-13 13:07:06 +00:00
![Projects page](../img/webapp_project_page.png)
2021-12-21 11:42:44 +00:00
2023-10-09 12:48:19 +00:00
If a project has any subprojects, clicking its folder will open its own project page. Access the projects' top-level
2021-12-21 11:42:44 +00:00
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
2022-03-28 09:17:15 +00:00
Project folders display summarized project information:
2021-12-21 11:42:44 +00:00
2024-11-03 13:32:30 +00:00
<div class="max-w-50">
2022-03-13 13:07:06 +00:00
![Project card](../img/webapp_project_card.png)
2021-12-21 11:42:44 +00:00
2024-11-03 13:32:30 +00:00
</div>
* When the project contains subprojects, the folder shows the number of subprojects within the project as an additional
tab. Click the tab to view a list of subprojects, and click on a subproject's name to navigate to it.
2021-12-21 11:42:44 +00:00
2024-11-03 13:32:30 +00:00
<div class="max-w-50">
![Subproject tab](../img/webapp_sub_project_card.png)
</div>
* When a project's `default_output_destination` is set, the folder displays the <img src="/docs/latest/icons/ico-info.svg" alt="Info" className="icon size-md space-sm" />
indicator. Hover over the indicator to view the default output destination.
2021-12-21 11:42:44 +00:00
2023-03-19 10:34:17 +00:00
<Collapsible title="Hidden Projects" type="configuration">
2023-03-21 10:18:15 +00:00
2023-03-15 13:11:34 +00:00
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" />
2023-03-21 10:18:15 +00:00
<br/>
![Hidden project configuration](../img/settings_hidden_projects.png)
2023-03-19 10:34:17 +00:00
</Collapsible>
2023-03-15 13:11:34 +00:00
2021-12-21 11:42:44 +00:00
### Project Actions
Click <img src="/docs/latest/icons/ico-bars-menu.svg" alt="Menu" className="icon size-md space-sm" /> on the top right
2022-03-28 09:17:15 +00:00
of a project folder to open its context menu and access the following project actions:
2021-12-21 11:42:44 +00:00
![Project context menu](../img/webapp_projects_context_menu.png)
2024-11-03 13:32:30 +00:00
* **Edit** - Rename the project and/or modify its default output destination.
2022-03-28 09:17:15 +00:00
* **New Project** - Create a new project (by default a subproject).
* **Move to** - Move the project into another project. If the target project does not exist, it is created on-the-fly.
2023-05-14 06:51:01 +00:00
* **Delete** - Delete the project. To delete a project, all of its contents (i.e. any pipelines/reports/datasets) must
2023-05-07 10:38:27 +00:00
first be archived or removed.
2021-12-21 11:42:44 +00:00
2024-07-18 07:10:48 +00:00
:::important Enterprise Feature
2024-07-02 07:18:27 +00:00
The ClearML Enterprise Server provides a mechanism to define your own custom actions, which will
appear in the context menu. Create a custom action by defining an HTTP request to issue when clicking on the context menu
action. For more information see [Custom UI Context Menu Actions](../deploying_clearml/clearml_server_config.md#custom-ui-context-menu-actions).
:::
2024-02-20 09:51:54 +00:00
## Create Projects
2021-12-21 11:42:44 +00:00
2024-02-20 09:51:54 +00:00
To create a project, click the **+ NEW PROJECT** button in the top right of the page or in a project's context menu,
2022-03-28 09:17:15 +00:00
which will open a **New Project** modal.
2024-11-03 13:32:30 +00:00
![New project modal](../img/webapp_projects_new_project.png)
* Project name
* Create in - Where the project should be created, either as a top-level project (create in `Projects root`) or as a
subproject of another project
* Description
* Default output destination - The storage location where model checkpoints (snapshots) and artifacts will be uploaded
when tasks in this project that do not have an explicit output destination specified are executed