New HUB Cloud Training docs page (#8174)
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Priytosh Tripathi
GitHub
parent
79e0d59eeb
commit
920ce66bf8
8 changed files with 175 additions and 186 deletions
|
|
@ -10,111 +10,54 @@ keywords: Ultralytics, HUB Models, AI model training, model creation, model trai
|
|||
|
||||
The process is user-friendly and efficient, involving a simple three-step creation and accelerated training powered by Ultralytics YOLOv8. During training, real-time updates on model metrics are available so that you can monitor each step of the progress. Once training is completed, you can preview your model and easily deploy it to real-world applications. Therefore, Ultralytics HUB offers a comprehensive yet straightforward system for model creation, training, evaluation, and deployment.
|
||||
|
||||
The entire process of training a Model is detailed on our [Cloud Training Page](cloudtraining.md)
|
||||
|
||||
|
||||
|
||||
## Train Model
|
||||
|
||||
Navigate to the [Models](https://hub.ultralytics.com/models) page by clicking on the **Models** button in the sidebar.
|
||||
Training the Model using HUB is a 4 step process <br />
|
||||
**Execute the pre-requisites script** - Run the already mention scripts to prepare the virtual Environment.<br />
|
||||
**Provide the API and start Training** - Once the model has been prepared, we can provide the API key as provided in the previous model (by simple copying and pasting the code block) and executing it.<br />
|
||||
**Check the results and Metrics** - Upon successful code execution, a link is presented that directs the user to the Metrics Page. This page provides comprehensive details regarding the trained model, including model specifications, box loss, class loss, object loss, dataset information, and image distributions. Additionally, the deploy tab offers access to the trained model's documentation and license details.<br />
|
||||
**Test your model** - Ultralytics HUB offers testing the model using custom Image, device camera or even links to test it using your `iPhone` or `Android` device.<br />
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can also train a model directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Click on the **Train Model** button on the top right of the page. This action will trigger the **Train Model** dialog.
|
||||
|
||||
|
||||
|
||||
The **Train Model** dialog has three simple steps, explained below.
|
||||
|
||||
### 1. Dataset
|
||||
|
||||
In this step, you have to select the dataset you want to train your model on. After you selected a dataset, click **Continue**.
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can skip this step if you train a model directly from the Dataset page.
|
||||
|
||||
|
||||
|
||||
|
||||
### 2. Model
|
||||
|
||||
In this step, you have to choose the project in which you want to create your model, the name of your model and your model's architecture.
|
||||
|
||||
??? note "Note"
|
||||
|
||||
Ultralytics HUB will try to pre-select the project.
|
||||
|
||||
If you opened the **Train Model** dialog as described above, Ultralytics HUB will pre-select the last project you used.
|
||||
|
||||
If you opened the **Train Model** dialog from the Project page, Ultralytics HUB will pre-select the project you were inside of.
|
||||
|
||||
|
||||
|
||||
In case you don't have a project created yet, you can set the name of your project in this step and it will be created together with your model.
|
||||
|
||||
|
||||
|
||||
!!! Info "Info"
|
||||
|
||||
You can read more about the available [YOLOv8](https://docs.ultralytics.com/models/yolov8) (and [YOLOv5](https://docs.ultralytics.com/models/yolov5)) architectures in our documentation.
|
||||
|
||||
When you're happy with your model configuration, click **Continue**.
|
||||
|
||||
|
||||
|
||||
|
||||
??? note "Note"
|
||||
|
||||
By default, your model will use a pre-trained model (trained on the [COCO](https://docs.ultralytics.com/datasets/detect/coco) dataset) to reduce training time.
|
||||
|
||||
You can change this behaviour by opening the **Advanced Options** accordion.
|
||||
|
||||
### 3. Train
|
||||
|
||||
In this step, you will start training you model.
|
||||
|
||||
Ultralytics HUB offers three training options:
|
||||
|
||||
- Ultralytics Cloud **(COMING SOON)**
|
||||
- Google Colab
|
||||
- Bring your own agent
|
||||
|
||||
In order to start training your model, follow the instructions presented in this step.
|
||||
|
||||
|
||||
|
||||
??? note "Note"
|
||||
|
||||
When you are on this step, before the training starts, you can change the default training configuration by opening the **Advanced Options** accordion.
|
||||
|
||||
|
||||
|
||||
??? note "Note"
|
||||
|
||||
When you are on this step, you have the option to close the **Train Model** dialog and start training your model from the Model page later.
|
||||
|
||||
|
||||
|
||||
To start training your model using Google Colab, simply follow the instructions shown above or on the Google Colab notebook.
|
||||
|
||||
<a href="https://colab.research.google.com/github/ultralytics/hub/blob/master/hub.ipynb" target="_blank">
|
||||
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab">
|
||||
</a>
|
||||
|
||||
When the training starts, you can click **Done** and monitor the training progress on the Model page.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
??? note "Note"
|
||||
|
||||
In case the training stops and a checkpoint was saved, you can resume training your model from the Model page.
|
||||
|
||||
|
||||
You can change this behavior by opening the **Advanced Options** accordion.
|
||||
|
||||
## Preview Model
|
||||
|
||||
|
|
@ -122,27 +65,46 @@ Ultralytics HUB offers a variety of ways to preview your trained model.
|
|||
|
||||
You can preview your model if you click on the **Preview** tab and upload an image in the **Test** card.
|
||||
|
||||
|
||||
|
||||
|
||||
You can also use our Ultralytics Cloud API to effortlessly [run inference](inference-api.md) with your custom model.
|
||||
|
||||
|
||||
|
||||
|
||||
Furthermore, you can preview your model in real-time directly on your [iOS](https://apps.apple.com/xk/app/ultralytics/id1583935240) or [Android](https://play.google.com/store/apps/details?id=com.ultralytics.ultralytics_app) mobile device by [downloading](https://ultralytics.com/app_install) our [Ultralytics HUB Mobile Application](app/index.md).
|
||||
|
||||
|
||||
|
||||
|
||||
## Train the model
|
||||
|
||||
Ultralytics HUB offers three training options:
|
||||
|
||||
- **Ultralytics Cloud** - Read more about training via Ultralytics Cloud [Cloud Training Page](cloudtraining.md)
|
||||
- **Google Colab**
|
||||
- **Bring your own agent**
|
||||
|
||||
## Training the Model on Google Colab
|
||||
|
||||
To start training your model using Google Colab, simply follow the instructions shown above or on the Google Colab notebook.
|
||||
|
||||
<a href="https://colab.research.google.com/github/ultralytics/hub/blob/master/hub.ipynb" target="_blank">
|
||||
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open In Colab">
|
||||
</a>
|
||||
|
||||
|
||||
|
||||
## Bring your own Agent
|
||||
|
||||
A user can create API end point through Ultralytics HUB and use their own agent to train the Model locally. Simply follow the steps on the section and then we can see the details of the training by a link generated on the terminal on the Agent. <br />
|
||||
The link takes us to the Metrics Information and Deployment completion page to know more about the model and deploy / share it.
|
||||
|
||||
|
||||
|
||||
## Deploy Model
|
||||
|
||||
You can export your model to 13 different formats, including ONNX, OpenVINO, CoreML, TensorFlow, Paddle and many others.
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can customize the export options of each format if you open the export actions dropdown and click on the **Advanced** option.
|
||||
|
||||
|
||||
|
||||
|
||||
## Share Model
|
||||
|
||||
|
|
@ -158,17 +120,11 @@ You can export your model to 13 different formats, including ONNX, OpenVINO, Cor
|
|||
|
||||
Navigate to the Model page of the model you want to share, open the model actions dropdown and click on the **Share** option. This action will trigger the **Share Model** dialog.
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can also share a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
|
||||
|
||||
|
||||
|
||||
|
||||
Set the general access to "Unlisted" and click **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
Now, anyone who has the direct link to your model can view it.
|
||||
|
||||
|
|
@ -178,36 +134,7 @@ Now, anyone who has the direct link to your model can view it.
|
|||
|
||||
|
||||
|
||||
## Edit Model
|
||||
## Edit and Delete Model
|
||||
|
||||
Navigate to the Model page of the model you want to edit, open the model actions dropdown and click on the **Edit** option. This action will trigger the **Update Model** dialog.
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can also edit a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
|
||||
|
||||
|
||||
|
||||
Apply the desired modifications to your model and then confirm the changes by clicking **Save**.
|
||||
|
||||
|
||||
|
||||
## Delete Model
|
||||
|
||||
Navigate to the Model page of the model you want to delete, open the model actions dropdown and click on the **Delete** option. This action will delete the model.
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can also delete a model directly from the [Models](https://hub.ultralytics.com/models) page or from the Project page of the project where your model is located.
|
||||
|
||||
|
||||
|
||||
??? note "Note"
|
||||
|
||||
If you change your mind, you can restore the model from the [Trash](https://hub.ultralytics.com/trash) page.
|
||||
|
||||
|
||||
Navigate to the Model page of the model you want to edit, open the model actions dropdown and click on the **Edit** option. This action will trigger the **Update Model** dialog. Navigate to the Model page of the model you want to delete, open the model actions dropdown and click on the **Delete** option. This action will delete the model.
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue