Skip to content

Commit 920ce66

Browse files
New HUB Cloud Training docs page (ultralytics#8174)
Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
1 parent 79e0d59 commit 920ce66

File tree

8 files changed

+166
-177
lines changed

8 files changed

+166
-177
lines changed

.github/workflows/ci.yaml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,13 @@ name: Ultralytics CI
66
on:
77
push:
88
branches: [main]
9+
paths-ignore:
10+
- "docs/**"
11+
- "mkdocs.yml"
912
pull_request:
1013
branches: [main]
14+
paths-ignore:
15+
- "docs/**"
1116
schedule:
1217
- cron: "0 0 * * *" # runs at 00:00 UTC every day
1318
workflow_dispatch:

.github/workflows/docker.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ name: Publish Docker Images
66
on:
77
push:
88
branches: [main]
9+
paths-ignore:
10+
- "docs/**"
911
workflow_dispatch:
1012
inputs:
1113
Dockerfile:
@@ -113,7 +115,7 @@ jobs:
113115
with:
114116
timeout_minutes: 60
115117
retry_wait_seconds: 0
116-
max_attempts: 2 # retry once
118+
max_attempts: 2 # retry once
117119
command: |
118120
docker build \
119121
--platform ${{ matrix.platforms }} \

docs/en/hub/cloud-training.md

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
---
2+
comments: true
3+
description: Learn how to use Ultralytics HUB for cloud for efficient and user-friendly AI model training. For easy model creation, training, evaluation and deployment, follow our detailed guide.
4+
keywords: Ultralytics, HUB Models, AI model training, model creation, model training, model evaluation, model deployment
5+
---
6+
7+
# Cloud Training
8+
9+
Ultralytics provides a web-based cloud training platform, enabling rapid and streamlined deployment of custom object detection models. Users benefit from a straightforward interface that facilitates the selection of their desired dataset and training method. Ultralytics further streamlines the process by offering a diverse array of pre-built options and architectural configurations.
10+
11+
![cloud training cover](https://github.com/ultralytics/ultralytics/assets/19519529/cbfdb3b8-ad35-44a6-afe6-61ec0b8e8b8d)
12+
13+
Read more about creating and other details of a Model at our [HUB Models page](models.md)
14+
15+
## Selecting an Instance
16+
17+
For details on Picking a model, and instances for it, please read [Instances guide Page](models.md)
18+
19+
## Steps to train the Model
20+
21+
Once the instance has been selected, training a model using ultralytics Hub is a three step process, as below: <br />
22+
23+
1. Picking a Dataset - Read more about Dataset, steps to add/remove dataset from [Dataset page](datasets.md) <br />
24+
2. Picking a Model - Read more about Models, steps to create / share and handle a model [HUB Models page](models.md) <br />
25+
3. Training the Model on the chosen Dataset <br />
26+
27+
Ultralytics HUB offers three training options:
28+
29+
- **Ultralytics Cloud**
30+
- **Google Colab** - Read more about training via Google Colab [HUB Models page](models.md)
31+
- **Bring your own agent** - Read more about training via your own Agent [HUB Models page](models.md)
32+
33+
In order to start training your model, follow the instructions presented in these steps.
34+
35+
## Training via Ultralytics Cloud
36+
37+
To start training your model using Ultralytics Cloud, we need to simply select the Training Duration, Available Instances, and Payment options.<br />
38+
39+
**Training Duration** - The Ultralytics offers two kind of training durations <br />
40+
41+
1. Training based on `Epochs` - This option lets you train your model based on number of times your Dataset needs to go through the cycle of Train, Label and Test. The exact pricing based on number of Epochs is hard to determine. Hence, if the credit gets exhausted before intended number of Epochs, the training pauses and we get a prompt to Top-up and resume Training. <br />
42+
2. Timed Training - The timed training features allows you to fix the time duration of the entire Training process and also determines the estimated amount before the start of Training. <br />
43+
44+
![Ultralytics cloud screenshot of training Duration options](https://github.com/ultralytics/ultralytics/assets/19519529/47b96f3f-a9ea-441a-b065-cba97edc333f)
45+
46+
When the training starts, you can click **Done** and monitor the training progress on the Model page.
47+
48+
## Monitor your training
49+
50+
Once the model and mode of the training has been selected, a User can monitor the training procedure on the `Train` section with the link provided in the terminal (on your agent / Google colab) or a button from Ultralytics Cloud.
51+
52+
![Monitor your Training](https://github.com/ultralytics/ultralytics/assets/19519529/316f8301-0d60-465e-8c99-aa3daf66433c)
53+
54+
## Stopping and resuming your training
55+
56+
Once the training has started a user can `Stop` the training, which will also correspondingly pause the credit usage for the user. A user can again `Resume` the training from the point as described in the below screenshot.
57+
58+
![Pausing and Resuming Training](https://github.com/ultralytics/ultralytics/assets/19519529/b2707a93-fa5c-4ee2-8443-6be9e1c2857d)
59+
60+
## Payments and Billing options
61+
62+
Ultralytics HUB offers `Pay Now` as upfront and/or use `Ultralytics HUB Account` as a wallet to top-up and fulfil the billing. A user can pick from amongst two types of Account namely `Free` and `Pro` user. <br />
63+
The user can navigate to the profile by clicking the Profile picture in the bottom left corner
64+
![Clicking profile picture](https://github.com/ultralytics/ultralytics/assets/19519529/53e5410e-06f5-4b40-b29d-ef00b5779163)
65+
66+
Click on the Billing tab to know about your current plan and option to upgrade it.
67+
![Clicking Upgrade button](https://github.com/ultralytics/ultralytics/assets/19519529/361b43c7-a9d4-4d05-b80b-dc1fa8bce829)
68+
69+
User is prompted about different available plans, and can pick from the available plans as stated below.
70+
![Picking a plan](https://github.com/ultralytics/ultralytics/assets/19519529/4326b01c-0d7d-4850-ac4f-ced2de3339ee)
71+
72+
The user will then Navigate to the Payment page, fill in the details and payment is done.
73+
![Payment Page](https://github.com/ultralytics/ultralytics/assets/19519529/5deebabe-1d8a-485a-b290-e038729c849f)

docs/en/hub/datasets.md

Lines changed: 15 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -57,49 +57,43 @@ check_dataset('path/to/coco8.zip')
5757

5858
Once your dataset ZIP is ready, navigate to the [Datasets](https://hub.ultralytics.com/datasets) page by clicking on the **Datasets** button in the sidebar.
5959

60-
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the Datasets button in the sidebar](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_2.jpg)
61-
62-
??? tip "Tip"
63-
64-
You can also upload a dataset directly from the [Home](https://hub.ultralytics.com/home) page.
65-
66-
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the Upload Dataset card](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_3.jpg)
60+
![Ultralytics HUB screenshot of the Home page with an arrow pointing to the Datasets button in the sidebar](https://github.com/ultralytics/ultralytics/assets/19519529/2d9f774c-100d-4ff4-a82b-2a38ced33c21)
6761

6862
Click on the **Upload Dataset** button on the top right of the page. This action will trigger the **Upload Dataset** dialog.
6963

70-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Upload Dataset button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_4.jpg)
64+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Upload Dataset button](https://github.com/ultralytics/ultralytics/assets/19519529/52ac10f5-ce42-483a-ac02-1d37d2cba3de)
7165

7266
Upload your dataset in the _Dataset .zip file_ field.
7367

7468
You have the additional option to set a custom name and description for your Ultralytics HUB dataset.
7569

7670
When you're happy with your dataset configuration, click **Upload**.
7771

78-
![Ultralytics HUB screenshot of the Upload Dataset dialog with an arrow pointing to the Upload button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_5.jpg)
72+
![Ultralytics HUB screenshot of the Upload Dataset dialog with an arrow pointing to the Upload button](https://github.com/ultralytics/ultralytics/assets/19519529/7d210ff6-bdb2-4535-a661-0470274bd7d6)
7973

8074
After your dataset is uploaded and processed, you will be able to access it from the Datasets page.
8175

82-
![Ultralytics HUB screenshot of the Datasets page with an arrow pointing to one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_6.jpg)
76+
![Ultralytics HUB screenshot of the Datasets page with an arrow pointing to one of the datasets](https://github.com/ultralytics/ultralytics/assets/19519529/a05d9b66-f8ba-4474-b8ac-ebe0dd143831)
8377

8478
You can view the images in your dataset grouped by splits (Train, Validation, Test).
8579

86-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Images tab](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_7.jpg)
80+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Images tab](https://github.com/ultralytics/ultralytics/assets/19519529/e07468e3-6284-4334-9783-84bfb11130f8)
8781

8882
??? tip "Tip"
8983

9084
Each image can be enlarged for better visualization.
9185

92-
![Ultralytics HUB screenshot of the Images tab inside the Dataset page with an arrow pointing to the expand icon](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_8.jpg)
86+
![Ultralytics HUB screenshot of the Images tab inside the Dataset page with an arrow pointing to the expand icon](https://github.com/ultralytics/ultralytics/assets/19519529/26f411a0-5153-4805-a8c1-cbd379708e28)
9387

94-
![Ultralytics HUB screenshot of the Images tab inside the Dataset page with one of the images expanded](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_9.jpg)
88+
![Ultralytics HUB screenshot of the Images tab inside the Dataset page with one of the images expanded](https://github.com/ultralytics/ultralytics/assets/19519529/7d5e0d50-85e5-4014-9f5b-464284e5b291)
9589

9690
Also, you can analyze your dataset by click on the **Overview** tab.
9791

98-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Overview tab](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_10.jpg)
92+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Overview tab](https://github.com/ultralytics/ultralytics/assets/19519529/5eaacd5d-fedf-4332-9091-1418c9f333cb)
9993

10094
Next, [train a model](https://docs.ultralytics.com/hub/models/#train-model) on your dataset.
10195

102-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Train Model button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_upload_dataset_11.jpg)
96+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Train Model button](https://github.com/ultralytics/ultralytics/assets/19519529/cb709e5f-a10b-478f-a81d-a48f61c193fe)
10397

10498
## Share Dataset
10599

@@ -115,7 +109,7 @@ Next, [train a model](https://docs.ultralytics.com/hub/models/#train-model) on y
115109

116110
Navigate to the Dataset page of the dataset you want to share, open the dataset actions dropdown and click on the **Share** option. This action will trigger the **Share Dataset** dialog.
117111

118-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Share option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_share_dataset_1.jpg)
112+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Share option](https://github.com/ultralytics/ultralytics/assets/19519529/9a0e61e7-2838-42b3-8abe-a22980e6c680)
119113

120114
??? tip "Tip"
121115

@@ -125,46 +119,28 @@ Navigate to the Dataset page of the dataset you want to share, open the dataset
125119

126120
Set the general access to "Unlisted" and click **Save**.
127121

128-
![Ultralytics HUB screenshot of the Share Dataset dialog with an arrow pointing to the dropdown and one to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_share_dataset_3.jpg)
122+
![Ultralytics HUB screenshot of the Share Dataset dialog with an arrow pointing to the dropdown and one to the Save button](https://github.com/ultralytics/ultralytics/assets/19519529/5818b928-19a3-48a8-892d-27ac1dc684dd)
129123

130124
Now, anyone who has the direct link to your dataset can view it.
131125

132126
??? tip "Tip"
133127

134128
You can easily click on the dataset's link shown in the **Share Dataset** dialog to copy it.
135129

136-
![Ultralytics HUB screenshot of the Share Dataset dialog with an arrow pointing to the dataset's link](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_share_dataset_4.jpg)
130+
![Ultralytics HUB screenshot of the Share Dataset dialog with an arrow pointing to the dataset's link](https://github.com/ultralytics/ultralytics/assets/19519529/8ede7d20-2a68-411d-9de5-3175b5ba7038)
137131

138-
## Edit Dataset
132+
## Edit / Delete Dataset
139133

140134
Navigate to the Dataset page of the dataset you want to edit, open the dataset actions dropdown and click on the **Edit** option. This action will trigger the **Update Dataset** dialog.
141135

142-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Edit option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_edit_dataset_1.jpg)
143-
144-
??? tip "Tip"
145-
146-
You can also edit a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
147-
148-
![Ultralytics HUB screenshot of the Datasets page with an arrow pointing to the Edit option of one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_edit_dataset_2.jpg)
136+
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Edit and Delete option](https://github.com/ultralytics/ultralytics/assets/19519529/6c248c8c-29cd-4bd5-b33d-43e90aa1d000)
149137

150138
Apply the desired modifications to your dataset and then confirm the changes by clicking **Save**.
151139

152-
![Ultralytics HUB screenshot of the Update Dataset dialog with an arrow pointing to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_edit_dataset_3.jpg)
153-
154-
## Delete Dataset
155-
156140
Navigate to the Dataset page of the dataset you want to delete, open the dataset actions dropdown and click on the **Delete** option. This action will delete the dataset.
157141

158-
![Ultralytics HUB screenshot of the Dataset page with an arrow pointing to the Delete option](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_delete_dataset_1.jpg)
159-
160-
??? tip "Tip"
161-
162-
You can also delete a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
163-
164-
![Ultralytics HUB screenshot of the Datasets page with an arrow pointing to the Delete option of one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_delete_dataset_2.jpg)
165-
166142
??? note "Note"
167143

168144
If you change your mind, you can restore the dataset from the [Trash](https://hub.ultralytics.com/trash) page.
169145

170-
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the datasets](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/hub_delete_dataset_3.jpg)
146+
![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the datasets](https://github.com/ultralytics/ultralytics/assets/19519529/56a9460c-0e06-4659-989d-715211b9d7ce)

docs/en/hub/inference-api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ keywords: Ultralytics, YOLOv8, Inference API, object detection, RESTful API, Pyt
88

99
The YOLO Inference API allows you to access the YOLOv8 object detection capabilities via a RESTful API. This enables you to run object detection on images without the need to install and set up the YOLOv8 environment locally.
1010

11-
![Inference API Screenshot](https://github.com/ultralytics/ultralytics/assets/26833433/c0109ec0-7bb0-46e1-b0d2-bae687960a01) Screenshot of the Inference API section in the trained model Preview tab.
11+
![Inference API Screenshot](https://github.com/ultralytics/ultralytics/assets/19519529/a8c00e55-1590-403b-bdee-ed456c60af4d) Screenshot of the Inference API section in the trained model Preview tab.
1212

1313
## API URL
1414

@@ -88,7 +88,7 @@ In this example, the `data` dictionary contains the query arguments `size`, `con
8888
This will send the query parameters along with the file in the POST request. See the table below for a full list of available inference arguments.
8989

9090
| Inference Argument | Default | Type | Notes |
91-
|--------------------|---------|---------|------------------------------------------------|
91+
| ------------------ | ------- | ------- | ---------------------------------------------- |
9292
| `size` | `640` | `int` | valid range is `32` - `1280` pixels |
9393
| `confidence` | `0.25` | `float` | valid range is `0.01` - `1.0` |
9494
| `iou` | `0.45` | `float` | valid range is `0.0` - `0.95` |

0 commit comments

Comments
 (0)