Optimize Docs images (#15900)
Signed-off-by: UltralyticsAssistant <web@ultralytics.com> Co-authored-by: UltralyticsAssistant <web@ultralytics.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Muhammad Rizwan Munawar
GitHub
parent
0f9f7b806c
commit
cfebb5f26b
174 changed files with 537 additions and 537 deletions
|
|
@ -7,7 +7,7 @@ keywords: Ultralytics, Android app, real-time object detection, YOLO models, Ten
|
|||
# Ultralytics Android App: Real-time Object Detection with YOLO Models
|
||||
|
||||
<a href="https://ultralytics.com/hub" target="_blank">
|
||||
<img width="100%" src="https://user-images.githubusercontent.com/26833433/281124469-6b3b0945-dbb1-44c8-80a9-ef6bc778b299.jpg" alt="Ultralytics HUB preview image"></a>
|
||||
<img width="100%" src="https://github.com/ultralytics/docs/releases/download/0/ultralytics-android-app-detection.avif" alt="Ultralytics HUB preview image"></a>
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ keywords: Ultralytics HUB, YOLO models, mobile app, iOS, Android, hardware accel
|
|||
# Ultralytics HUB App
|
||||
|
||||
<a href="https://ultralytics.com/hub" target="_blank">
|
||||
<img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png" alt="Ultralytics HUB preview image"></a>
|
||||
<img width="100%" src="https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub.avif" alt="Ultralytics HUB preview image"></a>
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ keywords: Ultralytics, iOS App, YOLO models, real-time object detection, Apple N
|
|||
# Ultralytics iOS App: Real-time Object Detection with YOLO Models
|
||||
|
||||
<a href="https://ultralytics.com/hub" target="_blank">
|
||||
<img width="100%" src="https://user-images.githubusercontent.com/26833433/281124469-6b3b0945-dbb1-44c8-80a9-ef6bc778b299.jpg" alt="Ultralytics HUB preview image"></a>
|
||||
<img width="100%" src="https://github.com/ultralytics/docs/releases/download/0/ultralytics-android-app-detection.avif" alt="Ultralytics HUB preview image"></a>
|
||||
<br>
|
||||
<div align="center">
|
||||
<a href="https://github.com/ultralytics"><img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png" width="3%" alt="Ultralytics GitHub"></a>
|
||||
|
|
|
|||
|
|
@ -26,13 +26,13 @@ In order to train models using Ultralytics Cloud Training, you need to [upgrade]
|
|||
|
||||
Follow the [Train Model](./models.md#train-model) instructions from the [Models](./models.md) page until you reach the third step ([Train](./models.md#3-train)) of the **Train Model** dialog. Once you are on this step, simply select the training duration (Epochs or Timed), the training instance, the payment method, and click the **Start Training** button. That's it!
|
||||
|
||||
|
||||
|
||||
|
||||
??? 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.
|
||||
|
||||
|
||||
|
||||
|
||||
Most of the times, you will use the Epochs training. The number of epochs can be adjusted on this step (if the training didn't start yet) and represents the number of times your dataset needs to go through the cycle of train, label, and test. The exact pricing based on the number of epochs is hard to determine, reason why we only allow the [Account Balance](./pro.md#account-balance) payment method.
|
||||
|
||||
|
|
@ -40,7 +40,7 @@ Most of the times, you will use the Epochs training. The number of epochs can be
|
|||
|
||||
When using the Epochs training, your [account balance](./pro.md#account-balance) needs to be at least US$5.00 to start training. In case you have a low balance, you can top-up directly from this step.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
|
|
@ -48,21 +48,21 @@ Most of the times, you will use the Epochs training. The number of epochs can be
|
|||
|
||||
Also, after every epoch, we check if you have enough [account balance](./pro.md#account-balance) for the next epoch. In case you don't have enough [account balance](./pro.md#account-balance) for the next epoch, we will stop the training session, allowing you to resume training your model from the last checkpoint saved.
|
||||
|
||||
|
||||
|
||||
|
||||
Alternatively, you can use the Timed training. This option allows you to set the training duration. In this case, we can determine the exact pricing. You can pay upfront or using your [account balance](./pro.md#account-balance).
|
||||
|
||||
If you have enough [account balance](./pro.md#account-balance), you can use the [Account Balance](./pro.md#account-balance) payment method.
|
||||
|
||||
|
||||
|
||||
|
||||
If you don't have enough [account balance](./pro.md#account-balance), you won't be able to use the [Account Balance](./pro.md#account-balance) payment method. You can pay upfront or top-up directly from this step.
|
||||
|
||||
|
||||
|
||||
|
||||
Before the training session starts, the initialization process spins up a dedicated instance equipped with GPU resources, which can sometimes take a while depending on the current demand and availability of GPU resources.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
|
|
@ -72,13 +72,13 @@ After the training session starts, you can monitor each step of the progress.
|
|||
|
||||
If needed, you can stop the training by clicking on the **Stop Training** button.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
You can resume training your model from the last checkpoint saved.
|
||||
|
||||
|
||||
|
||||
|
||||
<p align="center">
|
||||
<iframe loading="lazy" width="720" height="405" src="https://www.youtube.com/embed/H3qL8ImCSV8"
|
||||
|
|
@ -94,10 +94,10 @@ If needed, you can stop the training by clicking on the **Stop Training** button
|
|||
|
||||
Unfortunately, at the moment, you can only train one model at a time using Ultralytics Cloud.
|
||||
|
||||
|
||||
|
||||
|
||||
## Billing
|
||||
|
||||
During training or after training, you can check the cost of your model by clicking on the **Billing** tab. Furthermore, you can download the cost report by clicking on the **Download** button.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ zip -r coco8.zip coco8
|
|||
You can download our [COCO8](https://github.com/ultralytics/hub/blob/main/example_datasets/coco8.zip) example dataset and unzip it to see exactly how to structure your dataset.
|
||||
|
||||
<p align="center">
|
||||
<img src="https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/datasets/dataset_structure.jpg" alt="COCO8 Dataset Structure" width="80%">
|
||||
<img src="https://github.com/ultralytics/docs/releases/download/0/coco8-dataset-structure.avif" alt="COCO8 Dataset Structure" width="80%">
|
||||
</p>
|
||||
|
||||
The dataset YAML is the same standard YOLOv5 and YOLOv8 YAML format.
|
||||
|
|
@ -56,13 +56,13 @@ check_dataset("path/to/dataset.zip", task="detect")
|
|||
|
||||
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 and click on the **Upload Dataset** button on the top right of the page.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can upload a dataset directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
This action will trigger the **Upload Dataset** dialog.
|
||||
|
||||
|
|
@ -72,43 +72,43 @@ You have the additional option to set a custom name and description for your [Ul
|
|||
|
||||
When you're happy with your dataset configuration, click **Upload**.
|
||||
|
||||
|
||||
|
||||
|
||||
After your dataset is uploaded and processed, you will be able to access it from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
You can view the images in your dataset grouped by splits (Train, Validation, Test).
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
Each image can be enlarged for better visualization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Also, you can analyze your dataset by click on the **Overview** tab.
|
||||
|
||||
|
||||
|
||||
|
||||
Next, [train a model](./models.md#train-model) on your dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
## Download Dataset
|
||||
|
||||
Navigate to the Dataset page of the dataset you want to download, open the dataset actions dropdown and click on the **Download** option. This action will start downloading your dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can download a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Share Dataset
|
||||
|
||||
|
|
@ -124,17 +124,17 @@ Navigate to the Dataset page of the dataset you want to download, open the datas
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can share a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Set the general access to "Unlisted" and click **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
Now, anyone who has the direct link to your dataset can view it.
|
||||
|
||||
|
|
@ -142,38 +142,38 @@ Now, anyone who has the direct link to your dataset can view it.
|
|||
|
||||
You can easily click on the dataset's link shown in the **Share Dataset** dialog to copy it.
|
||||
|
||||
|
||||
|
||||
|
||||
## Edit Dataset
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can edit a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Apply the desired modifications to your dataset and then confirm the changes by clicking **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
## Delete Dataset
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can delete a dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
If you change your mind, you can restore the dataset from the [Trash](https://hub.ultralytics.com/trash) page.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ keywords: Ultralytics HUB, YOLO models, train YOLO, YOLOv5, YOLOv8, object detec
|
|||
# Ultralytics HUB
|
||||
|
||||
<div align="center">
|
||||
<a href="https://ultralytics.com/hub" target="_blank"><img width="100%" src="https://github.com/ultralytics/assets/raw/main/im/ultralytics-hub.png"></a>
|
||||
<a href="https://ultralytics.com/hub" target="_blank"><img width="100%" src="https://github.com/ultralytics/docs/releases/download/0/ultralytics-hub.avif"></a>
|
||||
<a href="https://docs.ultralytics.com/zh/hub/">中文</a> |
|
||||
<a href="https://docs.ultralytics.com/ko/hub/">한국어</a> |
|
||||
<a href="https://docs.ultralytics.com/ja/hub/">日本語</a> |
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ keywords: Ultralytics, HUB, Inference API, Python, cURL, REST API, YOLO, image p
|
|||
|
||||
After you [train a model](./models.md#train-model), you can use the [Shared Inference API](#shared-inference-api) for free. If you are a [Pro](./pro.md) user, you can access the [Dedicated Inference API](#dedicated-inference-api). The [Ultralytics HUB](https://ultralytics.com/hub) Inference API allows you to run inference through our REST API without the need to install and set up the Ultralytics YOLO environment locally.
|
||||
|
||||
|
||||
|
||||
|
||||
<p align="center">
|
||||
<iframe loading="lazy" width="720" height="405" src="https://www.youtube.com/embed/OpWpBI35A5Y"
|
||||
|
|
@ -35,7 +35,7 @@ In response to high demand and widespread interest, we are thrilled to unveil th
|
|||
|
||||
To use the [Ultralytics HUB](https://ultralytics.com/hub) Dedicated Inference API, click on the **Start Endpoint** button. Next, use the unique endpoint URL as described in the guides below.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip "Tip"
|
||||
|
||||
|
|
@ -43,7 +43,7 @@ To use the [Ultralytics HUB](https://ultralytics.com/hub) Dedicated Inference AP
|
|||
|
||||
To shut down the dedicated endpoint, click on the **Stop Endpoint** button.
|
||||
|
||||
|
||||
|
||||
|
||||
## Shared Inference API
|
||||
|
||||
|
|
|
|||
|
|
@ -18,7 +18,7 @@ After a dataset is imported in [Ultralytics HUB](https://ultralytics.com/hub), y
|
|||
|
||||
You can easily filter the [Roboflow](https://roboflow.com/?ref=ultralytics) datasets on the [Ultralytics HUB](https://ultralytics.com/hub) [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
[Ultralytics HUB](https://ultralytics.com/hub) supports two types of integrations with [Roboflow](https://roboflow.com/?ref=ultralytics), [Universe](#universe) and [Workspace](#workspace).
|
||||
|
||||
|
|
@ -32,23 +32,23 @@ When you export a [Roboflow](https://roboflow.com/?ref=ultralytics) dataset, sel
|
|||
|
||||
You can import your [Roboflow](https://roboflow.com/?ref=ultralytics) dataset by clicking on the **Import** button.
|
||||
|
||||
|
||||
|
||||
|
||||
Next, [train a model](./models.md#train-model) on your dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
##### Remove
|
||||
|
||||
Navigate to the Dataset page of the [Roboflow](https://roboflow.com/?ref=ultralytics) dataset you want to remove, open the dataset actions dropdown and click on the **Remove** option.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can remove an imported [Roboflow](https://roboflow.com/?ref=ultralytics) dataset directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
#### Workspace
|
||||
|
||||
|
|
@ -64,33 +64,33 @@ Type your [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace private AP
|
|||
|
||||
You can click on the **Get my API key** button which will redirect you to the settings of your [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace from where you can obtain your private API key.
|
||||
|
||||
|
||||
|
||||
|
||||
This will connect your [Ultralytics HUB](https://ultralytics.com/hub) account with your [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace and make your [Roboflow](https://roboflow.com/?ref=ultralytics) datasets available in [Ultralytics HUB](https://ultralytics.com/hub).
|
||||
|
||||
|
||||
|
||||
|
||||
Next, [train a model](./models.md#train-model) on your dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
##### Remove
|
||||
|
||||
Navigate to the [Integrations](https://hub.ultralytics.com/settings?tab=integrations) page by clicking on the **Integrations** button in the sidebar and click on the **Unlink** button of the [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace you want to remove.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can remove a connected [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace directly from the Dataset page of one of the datasets from your [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can remove a connected [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace directly from the [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Models
|
||||
|
||||
|
|
@ -98,7 +98,7 @@ Navigate to the [Integrations](https://hub.ultralytics.com/settings?tab=integrat
|
|||
|
||||
After you [train a model](./models.md#train-model), you can [export it](./models.md#deploy-model) to 13 different formats, including ONNX, OpenVINO, CoreML, TensorFlow, Paddle and many others.
|
||||
|
||||
|
||||
|
||||
|
||||
The available export formats are presented in the table below.
|
||||
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ The process is user-friendly and efficient, involving a simple three-step creati
|
|||
|
||||
Navigate to the [Models](https://hub.ultralytics.com/models) page by clicking on the **Models** button in the sidebar and click on the **Train Model** button on the top right of the page.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can train a model directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
This action will trigger the **Train Model** dialog which has three simple steps:
|
||||
|
||||
|
|
@ -38,19 +38,19 @@ This action will trigger the **Train Model** dialog which has three simple steps
|
|||
|
||||
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"
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ In this step, you have to choose the project in which you want to create your mo
|
|||
|
||||
If you opened the **Train Model** dialog from the Project page, [Ultralytics HUB](https://ultralytics.com/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.
|
||||
|
||||
|
|
@ -70,7 +70,7 @@ In this step, you have to choose the project in which you want to create your mo
|
|||
|
||||
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 behavior and tweak your model's configuration by opening the **Advanced Model Configuration** accordion.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
|
|
@ -89,7 +89,7 @@ By default, your model will use a pre-trained model (trained on the [COCO](https
|
|||
|
||||
Alternatively, you start training from one of your previously trained models by clicking on the **Custom** tab.
|
||||
|
||||
|
||||
|
||||
|
||||
When you're happy with your model configuration, click **Continue**.
|
||||
|
||||
|
|
@ -101,7 +101,7 @@ In this step, you will start training you model.
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
[Ultralytics HUB](https://ultralytics.com/hub) offers three training options:
|
||||
|
||||
|
|
@ -113,7 +113,7 @@ In this step, you will start training you model.
|
|||
|
||||
You need to [upgrade](./pro.md#upgrade) to the [Pro Plan](./pro.md) in order to access [Ultralytics Cloud](./cloud-training.md).
|
||||
|
||||
|
||||
|
||||
|
||||
To train models using our [Cloud Training](./cloud-training.md) solution, read the [Ultralytics Cloud Training](./cloud-training.md) documentation.
|
||||
|
||||
|
|
@ -125,19 +125,19 @@ To start training your model using [Google Colab](https://colab.research.google.
|
|||
<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.
|
||||
|
||||
|
||||
|
||||
|
||||
#### c. Bring your own agent
|
||||
|
||||
|
|
@ -153,7 +153,7 @@ When the training starts, you can click **Done** and monitor the training progre
|
|||
|
||||
To start training your model using your own agent, follow the instructions shown in the [Ultralytics HUB](https://ultralytics.com/hub) **Train Model** dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
Install the `ultralytics` package from [PyPI](https://pypi.org/project/ultralytics).
|
||||
|
||||
|
|
@ -165,15 +165,15 @@ Next, use the Python code provided to start training the model.
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## Analyze Model
|
||||
|
||||
|
|
@ -181,23 +181,23 @@ After you [train a model](#train-model), you can analyze the model metrics.
|
|||
|
||||
The **Train** tab presents the most important metrics carefully grouped based on the task.
|
||||
|
||||
|
||||
|
||||
|
||||
To access all model metrics, click on the **Charts** tab.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
Each chart can be enlarged for better visualization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Furthermore, to properly analyze the data, you can utilize the zoom feature.
|
||||
|
||||
|
||||
|
||||
|
||||
## Preview Model
|
||||
|
||||
|
|
@ -205,29 +205,29 @@ After you [train a model](#train-model), you can preview it by clicking on the *
|
|||
|
||||
In the **Test** card, you can select a preview image from the dataset used during training or upload an image from your device.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
You can also use your camera to take a picture and run inference on it directly.
|
||||
|
||||
|
||||
|
||||
|
||||
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 App](app/index.md).
|
||||
|
||||
|
||||
|
||||
|
||||
## Deploy Model
|
||||
|
||||
After you [train a model](#train-model), you can export it 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.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
|
|
@ -235,7 +235,7 @@ After you [train a model](#train-model), you can export it to 13 different forma
|
|||
|
||||
You can also use our [Inference API](./inference-api.md) in production.
|
||||
|
||||
|
||||
|
||||
|
||||
Read the [Ultralytics Inference API](./inference-api.md) documentation for more information.
|
||||
|
||||
|
|
@ -253,17 +253,17 @@ Read the [Ultralytics Inference API](./inference-api.md) documentation for more
|
|||
|
||||
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.
|
||||
|
||||
|
|
@ -271,38 +271,38 @@ Now, anyone who has the direct link to your model can view it.
|
|||
|
||||
You can easily click on the model's link shown in the **Share Model** dialog to copy it.
|
||||
|
||||
|
||||
|
||||
|
||||
## Edit 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.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -20,21 +20,21 @@ The Pro Plan provides early access to upcoming features and includes enhanced be
|
|||
|
||||
You can upgrade to the Pro Plan from the [Billing & License](https://hub.ultralytics.com/settings?tab=billing) tab on the [Settings](https://hub.ultralytics.com/settings) page by clicking on the **Upgrade** button.
|
||||
|
||||
|
||||
|
||||
|
||||
Next, select the Pro Plan.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip "Tip"
|
||||
|
||||
You can save 20% if you choose the annual Pro Plan.
|
||||
|
||||
|
||||
|
||||
|
||||
Fill in your details during the checkout.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! tip "Tip"
|
||||
|
||||
|
|
@ -42,7 +42,7 @@ Fill in your details during the checkout.
|
|||
|
||||
That's it!
|
||||
|
||||
|
||||
|
||||
|
||||
## Account Balance
|
||||
|
||||
|
|
@ -50,12 +50,12 @@ The account balance is used to pay for [Ultralytics Cloud Training](./cloud-trai
|
|||
|
||||
In order to top up your account balance, simply click on the **Top-Up** button.
|
||||
|
||||
|
||||
|
||||
|
||||
Next, set the amount you want to top-up.
|
||||
|
||||
|
||||
|
||||
|
||||
That's it!
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -24,13 +24,13 @@ This creates a unified and organized workspace that facilitates easier model man
|
|||
|
||||
Navigate to the [Projects](https://hub.ultralytics.com/projects) page by clicking on the **Projects** button in the sidebar and click on the **Create Project** button on the top right of the page.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can create a project directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
This action will trigger the **Create Project** dialog, opening up a suite of options for tailoring your project to your needs.
|
||||
|
||||
|
|
@ -40,15 +40,15 @@ You have the additional option to enrich your project with a description and a u
|
|||
|
||||
When you're happy with your project configuration, click **Create**.
|
||||
|
||||
|
||||
|
||||
|
||||
After your project is created, you will be able to access it from the [Projects](https://hub.ultralytics.com/projects) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Next, [train a model](./models.md#train-model) inside your project.
|
||||
|
||||
|
||||
|
||||
|
||||
## Share Project
|
||||
|
||||
|
|
@ -64,17 +64,17 @@ Next, [train a model](./models.md#train-model) inside your project.
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can share a project directly from the [Projects](https://hub.ultralytics.com/projects) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Set the general access to "Unlisted" and click **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! Warning "Warning"
|
||||
|
||||
|
|
@ -86,35 +86,35 @@ Now, anyone who has the direct link to your project can view it.
|
|||
|
||||
You can easily click on the project's link shown in the **Share Project** dialog to copy it.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can edit a project directly from the [Projects](https://hub.ultralytics.com/projects) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Apply the desired modifications to your project and then confirm the changes by clicking **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can delete a project directly from the [Projects](https://hub.ultralytics.com/projects) page.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! Warning "Warning"
|
||||
|
||||
|
|
@ -124,35 +124,35 @@ Navigate to the Project page of the project you want to delete, open the project
|
|||
|
||||
If you change your mind, you can restore the project from the [Trash](https://hub.ultralytics.com/trash) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
Each chart can be enlarged for better visualization.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Furthermore, to properly analyze the data, you can utilize the zoom feature.
|
||||
|
||||
|
||||
|
||||
|
||||
??? 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.
|
||||
|
||||
|
||||
|
||||
|
||||
## Reorder Models
|
||||
|
||||
|
|
@ -162,20 +162,20 @@ This will display all the relevant charts. Each chart corresponds to a different
|
|||
|
||||
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.
|
||||
|
||||
|
||||
|
||||
|
||||
## 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.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can also transfer a model directly from the [Models](https://hub.ultralytics.com/models) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the project you want to transfer the model to and click **Save**.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
|
|
@ -22,17 +22,17 @@ keywords: Ultralytics HUB, Quickstart, YOLO models, dataset upload, project mana
|
|||
|
||||
[Ultralytics HUB](https://ultralytics.com/hub) offers a variety easy of signup options. You can register and log in using your Google, Apple, or GitHub accounts, or simply with your email address.
|
||||
|
||||
|
||||
|
||||
|
||||
During the signup, you will be asked to complete your profile.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can update your profile from the [Account](https://hub.ultralytics.com/settings?tab=account) tab on the [Settings](https://hub.ultralytics.com/settings) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Home
|
||||
|
||||
|
|
@ -40,19 +40,19 @@ After signing in, you will be directed to the [Home](https://hub.ultralytics.com
|
|||
|
||||
The sidebar conveniently offers links to important modules of the platform, such as [Datasets](https://hub.ultralytics.com/datasets), [Projects](https://hub.ultralytics.com/projects), and [Models](https://hub.ultralytics.com/models).
|
||||
|
||||
|
||||
|
||||
|
||||
### Recent
|
||||
|
||||
You can easily search globally or directly access your last updated [Datasets](https://hub.ultralytics.com/datasets), [Projects](https://hub.ultralytics.com/projects), or [Models](https://hub.ultralytics.com/models) using the Recent card on the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
### Upload Dataset
|
||||
|
||||
You can upload a dataset directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Read more about [datasets](https://docs.ultralytics.com/hub/datasets).
|
||||
|
||||
|
|
@ -60,7 +60,7 @@ Read more about [datasets](https://docs.ultralytics.com/hub/datasets).
|
|||
|
||||
You can create a project directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Read more about [projects](https://docs.ultralytics.com/hub/projects).
|
||||
|
||||
|
|
@ -68,7 +68,7 @@ Read more about [projects](https://docs.ultralytics.com/hub/projects).
|
|||
|
||||
You can train a model directly from the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Read more about [models](https://docs.ultralytics.com/hub/models).
|
||||
|
||||
|
|
@ -76,9 +76,9 @@ Read more about [models](https://docs.ultralytics.com/hub/models).
|
|||
|
||||
We value your feedback! Feel free to leave a review at any time.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
??? info "Info"
|
||||
|
||||
|
|
@ -94,7 +94,7 @@ You can report a bug, request a feature, or ask a question on <a href="https://g
|
|||
|
||||
When reporting a bug, please include your Environment Details from the [Support](https://hub.ultralytics.com/support) page.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
|
|
|
|||
|
|
@ -20,11 +20,11 @@ Here, you'll learn how to manage team members, share resources seamlessly, and c
|
|||
|
||||
You need to [upgrade](./pro.md#upgrade) to the [Pro Plan](./pro.md) in order to create a team.
|
||||
|
||||
|
||||
|
||||
|
||||
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page by clicking on the **Teams** tab in the [Settings](https://hub.ultralytics.com/settings) page and click on the **Create Team** button.
|
||||
|
||||
|
||||
|
||||
|
||||
This action will trigger the **Create Team** dialog.
|
||||
|
||||
|
|
@ -34,27 +34,27 @@ You have the additional option to enrich your team with a description and a uniq
|
|||
|
||||
When you're happy with your team configuration, click **Create**.
|
||||
|
||||
|
||||
|
||||
|
||||
After your team is created, you will be able to access it from the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Edit Team
|
||||
|
||||
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page, open the team actions dropdown of team you want to edit and click on the **Edit** option. This action will trigger the **Update Team** dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
Apply the desired modifications to your team and then confirm the changes by clicking **Save**.
|
||||
|
||||
|
||||
|
||||
|
||||
## Delete Team
|
||||
|
||||
Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page, open the team actions dropdown of team you want to delete and click on the **Delete** option.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! Warning "Warning"
|
||||
|
||||
|
|
@ -64,23 +64,23 @@ Navigate to the [Teams](https://hub.ultralytics.com/settings?tab=teams) page, op
|
|||
|
||||
Navigate to the Team page of the team to which you want to add a new member and click on the **Invite Member** button. This action will trigger the **Invite Member** dialog.
|
||||
|
||||
|
||||
|
||||
|
||||
Type the email and select the role of the new member and click **Invite**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can cancel the invite before the new member accepts it.
|
||||
|
||||
|
||||
|
||||
|
||||
The **Pending** status disappears after the new member accepts the invite.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
|
|
@ -88,7 +88,7 @@ The **Pending** status disappears after the new member accepts the invite.
|
|||
|
||||
The **Admin** role allows inviting and removing members, as well as removing shared datasets or projects.
|
||||
|
||||
|
||||
|
||||
|
||||
### Seats
|
||||
|
||||
|
|
@ -102,13 +102,13 @@ When you remove a unique member from the last team they are a member of, the num
|
|||
|
||||
You can see the number of seats on the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Remove Member
|
||||
|
||||
Navigate to the Team page of the team from which you want to remove a member, open the member actions dropdown, and click on the **Remove** option.
|
||||
|
||||
|
||||
|
||||
|
||||
## Join Team
|
||||
|
||||
|
|
@ -116,76 +116,76 @@ When you are invited to a team, you receive an in-app notification.
|
|||
|
||||
You can view your notifications by clicking on the **View** button on the **Notifications** card on the [Home](https://hub.ultralytics.com/home) page.
|
||||
|
||||
|
||||
|
||||
|
||||
Alternatively, you can view your notifications by accessing the [Notifications](https://hub.ultralytics.com/notifications) page directly.
|
||||
|
||||
|
||||
|
||||
|
||||
You can decide whether to join the team on the Team page of the team to which you were invited.
|
||||
|
||||
If you want to join the team, click on the **Join Team** button.
|
||||
|
||||
|
||||
|
||||
|
||||
If you don't want to join the team, click on the **Reject Invitation** button.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
You can join the team directly from the [Teams](https://hub.ultralytics.com/settings?tab=teams) page.
|
||||
|
||||
|
||||
|
||||
|
||||
## Leave Team
|
||||
|
||||
Navigate to the Team page of the team you want to leave and click on the **Leave Team** button.
|
||||
|
||||
|
||||
|
||||
|
||||
## Share Dataset
|
||||
|
||||
Navigate to the Team page of the team you want to share your dataset with and click on the **Add Dataset** button.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the dataset you want to share with your team and click on the **Add** button.
|
||||
|
||||
|
||||
|
||||
|
||||
That's it! Your team now has access to your dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
As a team owner or team admin, you can remove a shared dataset.
|
||||
|
||||
|
||||
|
||||
|
||||
## Share Project
|
||||
|
||||
Navigate to the Team page of the team you want to share your project with and click on the **Add Project** button.
|
||||
|
||||
|
||||
|
||||
|
||||
Select the project you want to share with your team and click on the **Add** button.
|
||||
|
||||
|
||||
|
||||
|
||||
That's it! Your team now has access to your project.
|
||||
|
||||
|
||||
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
As a team owner or team admin, you can remove a shared project.
|
||||
|
||||
|
||||
|
||||
|
||||
!!! note "Note"
|
||||
|
||||
When you share a project with your team, all models inside the project are shared as well.
|
||||
|
||||
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue