|
|
@ -1,7 +1,169 @@ |
|
|
|
--- |
|
|
|
--- |
|
|
|
comments: true |
|
|
|
comments: true |
|
|
|
|
|
|
|
description: Efficiently manage and compare AI models with Ultralytics HUB Projects. Create, share, and edit projects for streamlined model development. |
|
|
|
|
|
|
|
keywords: Ultralytics HUB projects, model management, model comparison, create project, share project, edit project, delete project, compare models |
|
|
|
--- |
|
|
|
--- |
|
|
|
|
|
|
|
|
|
|
|
# 🚧 Page Under Construction ⚒ |
|
|
|
# Ultralytics HUB Projects |
|
|
|
|
|
|
|
|
|
|
|
This page is currently under construction!️ 👷Please check back later for updates. 😃🔜 |
|
|
|
Ultralytics HUB projects provide an effective solution for consolidating and managing your models. If you are working with several models that perform similar tasks or have related purposes, Ultralytics HUB projects allow you to group these models together. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This creates a unified and organized workspace that facilitates easier model management, comparison and development. Having similar models or various iterations together can facilitate rapid benchmarking, as you can compare their effectiveness. This can lead to faster, more insightful iterative development and refinement of your models. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Create Project |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the [Projects](https://hub.ultralytics.com/projects) page by clicking on the **Projects** button in the sidebar. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the Projects button in the sidebar](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also create a project directly from the [Home](https://hub.ultralytics.com/home) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the Create Project card](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Click on the **Create Project** button on the top right of the page. This action will trigger the **Create Project** dialog, opening up a suite of options for tailoring your project to your needs. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Projects page with an arrow pointing to the Create Project button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_3.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Type the name of your project in the *Project name* field or keep the default name and finalize the project creation with a single click. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You have the additional option to enrich your project with a description and a unique image, enhancing its recognizability on the Projects page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When you're happy with your project configuration, click **Create**. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Create Project dialog with an arrow pointing to the Create button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_4.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
After your project is created, you will be able to access it from the Projects page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Projects page with an arrow pointing to one of the projects](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_5.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Next, [create a model](./models.md) inside your project. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Create Model button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_create_project_6.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Share Project |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
!!! info "Info" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ultralytics HUB's sharing functionality provides a convenient way to share projects with others. This feature is designed to accommodate both existing Ultralytics HUB users and those who have yet to create an account. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? note "Note" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You have control over the general access of your projects. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can choose to set the general access to "Private", in which case, only you will have access to it. Alternatively, you can set the general access to "Unlisted" which grants viewing access to anyone who has the direct link to the project, regardless of whether they have an Ultralytics HUB account or not. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project you want to share, open the project actions dropdown and click on the **Share** option. This action will trigger the **Share Project** dialog. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Share option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_share_project_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also share a project directly from the [Projects](https://hub.ultralytics.com/projects) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Projects page with an arrow pointing to the Share option of one of the projects](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_share_project_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Set the general access to "Unlisted" and click **Save**. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Share Project dialog with an arrow pointing to the dropdown and one to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_share_project_3.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
!!! warning "Warning" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When changing the general access of a project, the general access of the models inside the project will be changed as well. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Now, anyone who has the direct link to your project can view it. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can easily click on the project's link shown in the **Share Project** dialog to copy it. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Share Project dialog with an arrow pointing to the project's link](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_share_project_4.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Edit Project |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project you want to edit, open the project actions dropdown and click on the **Edit** option. This action will trigger the **Update Project** dialog. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Edit option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_edit_project_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also edit a project directly from the [Projects](https://hub.ultralytics.com/projects) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Projects page with an arrow pointing to the Edit option of one of the projects](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_edit_project_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Apply the desired modifications to your project and then confirm the changes by clicking **Save**. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Update Project dialog with an arrow pointing to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_edit_project_3.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Delete Project |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project you want to delete, open the project actions dropdown and click on the **Delete** option. This action will delete the project. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Delete option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_delete_project_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also delete a project directly from the [Projects](https://hub.ultralytics.com/projects) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Projects page with an arrow pointing to the Delete option of one of the projects](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_delete_project_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
!!! warning "Warning" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
When deleting a project, the the models inside the project will be deleted as well. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? note "Note" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
If you change your mind, you can restore the project from the [Trash](https://hub.ultralytics.com/trash) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the projects](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_delete_project_3.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Compare Models |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project where the models you want to compare are located. To use the model comparison feature, click on the **Charts** tab. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Charts tab](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_compare_models_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
This will display all the relevant charts. Each chart corresponds to a different metric and contains the performance of each model for that metric. The models are represented by different colors and you can hover over each data point to get more information. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Charts tab inside the Project page](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_compare_models_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Each chart can be enlarged for better visualization. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Charts tab inside the Project page with an arrow pointing to the expand icon](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_compare_models_3.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Charts tab inside the Project page with one of the charts expanded](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_compare_models_4.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You have the flexibility to customize your view by selectively hiding certain models. This feature allows you to concentrate on the models of interest. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Charts tab inside the Project page with an arrow pointing to the hide/unhide icon of one of the model](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_compare_models_5.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Reorder Models |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? note "Note" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Ultralytics HUB's reordering functionality works only inside projects you own. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project where the models you want to reorder are located. Click on the designated reorder icon of the model you want to move and drag it to the desired location. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the reorder icon](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_reorder_models_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Transfer Models |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Navigate to the Project page of the project where the model you want to mode is located, open the project actions dropdown and click on the **Transfer** option. This action will trigger the **Transfer Model** dialog. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Project page with an arrow pointing to the Transfer option of one of the models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_transfer_models_1.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
??? tip "Tip" |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
You can also transfer a model directly from the [Models](https://hub.ultralytics.com/models) page. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Models page with an arrow pointing to the Transfer option of one of the models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_transfer_models_2.jpg) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Select the project you want to transfer the model to and click **Save**. |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
![Ultralytics HUB screenshot of the Transfer Model dialog with an arrow pointing to the dropdown and one to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/projects/hub_transfer_models_3.jpg) |