From be5cf7a03366a9eb7fa2ff81db3f3a4ee41a39fa Mon Sep 17 00:00:00 2001 From: Sergiu Waxmann <47978446+sergiuwaxmann@users.noreply.github.com> Date: Sun, 19 May 2024 17:40:03 +0300 Subject: [PATCH] Ultralytics HUB Docs fixes (#12808) Signed-off-by: Glenn Jocher Co-authored-by: Glenn Jocher --- docs/en/hub/cloud-training.md | 2 +- docs/en/hub/integrations.md | 34 ++++++++++++++++----------------- docs/en/hub/models.md | 8 ++++---- docs/en/hub/pro.md | 2 +- docs/mkdocs_github_authors.yaml | 2 +- 5 files changed, 23 insertions(+), 25 deletions(-) diff --git a/docs/en/hub/cloud-training.md b/docs/en/hub/cloud-training.md index 41257d9de..41d196081 100644 --- a/docs/en/hub/cloud-training.md +++ b/docs/en/hub/cloud-training.md @@ -98,6 +98,6 @@ If needed, you can stop the training by clicking on the **Stop Training** button ## Billing -At any point during training or after training, you can check the cost of your model by clicking on the **Billing** tab. Furthermore, you can download a small cost report by clicking on the **Download** button. +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. ![Ultralytics HUB screenshot of the Billing tab inside the Model page with an arrow pointing to the Billing tab and one to the Download button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/cloud-training/hub_cloud_training_billing_1.jpg) diff --git a/docs/en/hub/integrations.md b/docs/en/hub/integrations.md index 64ce84b1e..aad24d5b8 100644 --- a/docs/en/hub/integrations.md +++ b/docs/en/hub/integrations.md @@ -5,8 +5,6 @@ keywords: Ultralytics HUB, Integrations, Roboflow, Dataset, Export, YOLOv5, YOLO # Ultralytics HUB Integrations - Under Construction 🏗️🌟 -Welcome to the Integrations guide for [Ultralytics HUB](https://bit.ly/ultralytics_hub)! - We are in the process of expanding this section to provide you with comprehensive guidance on integrating your YOLOv5 and YOLOv8 models with various platforms and formats. We appreciate your patience as we work to make this section comprehensive and user-friendly. Stay tuned for updates! @@ -22,22 +20,22 @@ We appreciate your patience as we work to make this section comprehensive and us Available export formats are in the table below. You can predict or validate directly on exported models using the `ultralytics` Python package, i.e. `yolo predict model=yolov8n.onnx`. | Format | `format` Argument | Model | Metadata | Arguments | -|---------------------------------------------------|-------------------|---------------------------|----------|----------------------------------------------------------------------| -| [PyTorch](https://pytorch.org/) | - | `yolov8n.pt` | ✅ | - | -| [TorchScript](../integrations/torchscript.md) | `torchscript` | `yolov8n.torchscript` | ✅ | `imgsz`, `optimize`, `batch` | -| [ONNX](../integrations/onnx.md) | `onnx` | `yolov8n.onnx` | ✅ | `imgsz`, `half`, `dynamic`, `simplify`, `opset`, `batch` | -| [OpenVINO](../integrations/openvino.md) | `openvino` | `yolov8n_openvino_model/` | ✅ | `imgsz`, `half`, `int8`, `batch` | -| [TensorRT](../integrations/tensorrt.md) | `engine` | `yolov8n.engine` | ✅ | `imgsz`, `half`, `dynamic`, `simplify`, `workspace`, `int8`, `batch` | -| [CoreML](../integrations/coreml.md) | `coreml` | `yolov8n.mlpackage` | ✅ | `imgsz`, `half`, `int8`, `nms`, `batch` | -| [TF SavedModel](../integrations/tf-savedmodel.md) | `saved_model` | `yolov8n_saved_model/` | ✅ | `imgsz`, `keras`, `int8`, `batch` | -| [TF GraphDef](../integrations/tf-graphdef.md) | `pb` | `yolov8n.pb` | ❌ | `imgsz`, `batch` | -| [TF Lite](../integrations/tflite.md) | `tflite` | `yolov8n.tflite` | ✅ | `imgsz`, `half`, `int8`, `batch` | -| [TF Edge TPU](../integrations/edge-tpu.md) | `edgetpu` | `yolov8n_edgetpu.tflite` | ✅ | `imgsz`, `batch` | -| [TF.js](../integrations/tfjs.md) | `tfjs` | `yolov8n_web_model/` | ✅ | `imgsz`, `half`, `int8`, `batch` | -| [PaddlePaddle](../integrations/paddlepaddle.md) | `paddle` | `yolov8n_paddle_model/` | ✅ | `imgsz`, `batch` | -| [NCNN](../integrations/ncnn.md) | `ncnn` | `yolov8n_ncnn_model/` | ✅ | `imgsz`, `half`, `batch` | - -## Coming Soon 🎉 +| ------------------------------------------------- | ----------------- | ------------------------- | -------- | -------------------------------------------------------------------- | +| [PyTorch](https://pytorch.org/) | - | `yolov8n.pt` | ✅ | - | +| [TorchScript](../integrations/torchscript.md) | `torchscript` | `yolov8n.torchscript` | ✅ | `imgsz`, `optimize`, `batch` | +| [ONNX](../integrations/onnx.md) | `onnx` | `yolov8n.onnx` | ✅ | `imgsz`, `half`, `dynamic`, `simplify`, `opset`, `batch` | +| [OpenVINO](../integrations/openvino.md) | `openvino` | `yolov8n_openvino_model/` | ✅ | `imgsz`, `half`, `int8`, `batch` | +| [TensorRT](../integrations/tensorrt.md) | `engine` | `yolov8n.engine` | ✅ | `imgsz`, `half`, `dynamic`, `simplify`, `workspace`, `int8`, `batch` | +| [CoreML](../integrations/coreml.md) | `coreml` | `yolov8n.mlpackage` | ✅ | `imgsz`, `half`, `int8`, `nms`, `batch` | +| [TF SavedModel](../integrations/tf-savedmodel.md) | `saved_model` | `yolov8n_saved_model/` | ✅ | `imgsz`, `keras`, `int8`, `batch` | +| [TF GraphDef](../integrations/tf-graphdef.md) | `pb` | `yolov8n.pb` | ❌ | `imgsz`, `batch` | +| [TF Lite](../integrations/tflite.md) | `tflite` | `yolov8n.tflite` | ✅ | `imgsz`, `half`, `int8`, `batch` | +| [TF Edge TPU](../integrations/edge-tpu.md) | `edgetpu` | `yolov8n_edgetpu.tflite` | ✅ | `imgsz`, `batch` | +| [TF.js](../integrations/tfjs.md) | `tfjs` | `yolov8n_web_model/` | ✅ | `imgsz`, `half`, `int8`, `batch` | +| [PaddlePaddle](../integrations/paddlepaddle.md) | `paddle` | `yolov8n_paddle_model/` | ✅ | `imgsz`, `batch` | +| [NCNN](../integrations/ncnn.md) | `ncnn` | `yolov8n_ncnn_model/` | ✅ | `imgsz`, `half`, `batch` | + +## Exciting New Features on the Way 🎉 - Additional Dataset Integrations - Detailed Export Integration Guides diff --git a/docs/en/hub/models.md b/docs/en/hub/models.md index 028df9ce2..d57396102 100644 --- a/docs/en/hub/models.md +++ b/docs/en/hub/models.md @@ -90,7 +90,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 screenshot of the Model page with an arrow pointing to the Start Training card](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/cloud-training/hub_cloud_training_2.jpg) + ![Ultralytics HUB screenshot of the Model page with an arrow pointing to the Start Training card](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/cloud-training/hub_cloud_training_train_model_2.jpg) [Ultralytics HUB](https://bit.ly/ultralytics_hub) offers three training options: @@ -252,7 +252,7 @@ Now, anyone who has the direct link to your model can view it. ![Ultralytics HUB screenshot of the Share Model dialog with an arrow pointing to the model's link](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_share_model_4.jpg) -## Edit Project +## 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. @@ -268,7 +268,7 @@ Apply the desired modifications to your model and then confirm the changes by cl ![Ultralytics HUB screenshot of the Update Model dialog with an arrow pointing to the Save button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_edit_model_3.jpg) -## Delete Project +## 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. @@ -284,4 +284,4 @@ Navigate to the Model page of the model you want to delete, open the model actio If you change your mind, you can restore the model 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 models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_delete_model_3.jpg) \ No newline at end of file + ![Ultralytics HUB screenshot of the Trash page with an arrow pointing to the Restore option of one of the models](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/models/hub_delete_model_3.jpg) diff --git a/docs/en/hub/pro.md b/docs/en/hub/pro.md index 9bc7ccf8d..5e5fd853f 100644 --- a/docs/en/hub/pro.md +++ b/docs/en/hub/pro.md @@ -31,7 +31,7 @@ Next, select the Pro Plan. ![Ultralytics HUB screenshot of the Upgrade dialog with an arrow pointing to the Save 20% toggle and one to the Select Plan button](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/pro/hub_pro_upgrade_3.jpg) -Fill in your details during the checkout! +Fill in your details during the checkout. ![Ultralytics HUB screenshot of the Checkout with an arrow pointing to the checkbox for saving the payment information for future purchases](https://raw.githubusercontent.com/ultralytics/assets/main/docs/hub/pro/hub_pro_upgrade_4.jpg) diff --git a/docs/mkdocs_github_authors.yaml b/docs/mkdocs_github_authors.yaml index 5e5f8f439..36f86a3ef 100644 --- a/docs/mkdocs_github_authors.yaml +++ b/docs/mkdocs_github_authors.yaml @@ -9,7 +9,7 @@ 39910262+ChaoningZhang@users.noreply.github.com: ChaoningZhang 40165666+berry-ding@users.noreply.github.com: berry-ding 47978446+sergiuwaxmann@users.noreply.github.com: sergiuwaxmann -49699333+dependabot[bot]@users.noreply.github.com: dependabot[bot] +49699333+dependabot[bot]@users.noreply.github.com: dependabot 61612323+Laughing-q@users.noreply.github.com: Laughing-q 62214284+Burhan-Q@users.noreply.github.com: Burhan-Q 75611662+tensorturtle@users.noreply.github.com: tensorturtle