mirror of
https://github.com/ultralytics/ultralytics.git
synced 2025-09-15 15:48:41 +08:00
Update HUB Integrations page in Docs (#13292)
Signed-off-by: Glenn Jocher <glenn.jocher@ultralytics.com> Co-authored-by: Glenn Jocher <glenn.jocher@ultralytics.com>
This commit is contained in:
Sergiu Waxmann
GitHub
parent
3f2954fbf8
commit
bddea17bf3
@ -116,10 +116,24 @@ def update_subdir_edit_links(subdir="", docs_url=""):
|
||||
file.write(str(soup))
|
||||
|
||||
|
||||
def add_frontmatter(md_filepath: Path):
|
||||
"""Creates or updates a Markdown file, ensuring frontmatter is present."""
|
||||
if md_filepath.exists():
|
||||
existing_content = md_filepath.read_text()
|
||||
if not existing_content.strip().startswith("---\n"):
|
||||
header = "---\ncomments: true\ndescription: TODO ADD DESCRIPTION\nkeywords: TODO ADD KEYWORDS\n---\n\n"
|
||||
md_filepath.write_text(header + existing_content)
|
||||
return
|
||||
|
||||
|
||||
def main():
|
||||
"""Builds docs, updates titles and edit links, and prints local server command."""
|
||||
build_docs()
|
||||
|
||||
# Add frontmatter
|
||||
for file in tqdm((DOCS / "en").rglob("*.md"), desc="Adding frontmatter"):
|
||||
add_frontmatter(file)
|
||||
|
||||
# Update titles
|
||||
update_page_title(SITE / "404.html", new_title="Ultralytics Docs - Not Found")
|
||||
|
||||
|
||||
@ -1,39 +1,122 @@
|
||||
---
|
||||
description: Explore integration options for Ultralytics HUB. Currently featuring Roboflow for dataset integration and multiple export formats for your trained models. Discover what's next for Ultralytics with our under-construction page, previewing new, groundbreaking AI and ML features coming soon.
|
||||
keywords: Ultralytics HUB, Integrations, Roboflow, Dataset, Export, YOLOv5, YOLOv8, ONNX, CoreML, TensorRT, TensorFlow, coming soon, under construction, new features, AI updates, ML advancements, YOLO, technology preview
|
||||
comments: true
|
||||
description: Master Ultralytics HUB integrations with platforms & formats for seamless dataset imports and model training.
|
||||
keywords: Ultralytics HUB, Roboflow integration, dataset import, model training, HUB integrations, export models, AI models
|
||||
---
|
||||
|
||||
# Ultralytics HUB Integrations - Under Construction 🏗️🌟
|
||||
# Ultralytics HUB Integrations
|
||||
|
||||
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.
|
||||
Learn about [Ultralytics HUB](https://bit.ly/ultralytics_hub) integrations with various platforms and formats.
|
||||
|
||||
We appreciate your patience as we work to make this section comprehensive and user-friendly. Stay tuned for updates!
|
||||
## Datasets
|
||||
|
||||
### Available Integrations
|
||||
Seamlessly import your datasets in [Ultralytics HUB](https://bit.ly/ultralytics_hub) for [model training](./models.md#train-model).
|
||||
|
||||
#### Dataset
|
||||
After a dataset is imported in [Ultralytics HUB](https://bit.ly/ultralytics_hub), you can [train a model](./models.md#train-model) on your dataset just like you would using the [Ultralytics HUB](https://bit.ly/ultralytics_hub) datasets.
|
||||
|
||||
- **Roboflow**: Seamlessly import your datasets for training.
|
||||
### Roboflow
|
||||
|
||||
#### Export
|
||||
You can easily filter the [Roboflow](https://roboflow.com/?ref=ultralytics) datasets on the [Ultralytics HUB](https://bit.ly/ultralytics_hub) [Datasets](https://hub.ultralytics.com/datasets) page.
|
||||
|
||||
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`.
|
||||
|
||||
|
||||
[Ultralytics HUB](https://bit.ly/ultralytics_hub) supports two types of integrations with [Roboflow](https://roboflow.com/?ref=ultralytics), [Universe](#universe) and [Workspace](#workspace).
|
||||
|
||||
#### Universe
|
||||
|
||||
The [Roboflow](https://roboflow.com/?ref=ultralytics) Universe integration allows you to import one dataset at a time into [Ultralytics HUB](https://bit.ly/ultralytics_hub) from [Roboflow](https://roboflow.com/?ref=ultralytics).
|
||||
|
||||
##### Import
|
||||
|
||||
When you export a [Roboflow](https://roboflow.com/?ref=ultralytics) dataset, select the [Ultralytics HUB](https://bit.ly/ultralytics_hub) format. This action will redirect you to [Ultralytics HUB](https://bit.ly/ultralytics_hub) and trigger the **Dataset Import** dialog.
|
||||
|
||||
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
|
||||
|
||||
The [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace integration allows you to import an entire [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace at once into [Ultralytics HUB](https://bit.ly/ultralytics_hub).
|
||||
|
||||
##### Import
|
||||
|
||||
Navigate to the [Integrations](https://hub.ultralytics.com/settings?tab=integrations) page by clicking on the **Integrations** button in the sidebar.
|
||||
|
||||
Type your [Roboflow](https://roboflow.com/?ref=ultralytics) Workspace private API key and click on the **Add** button.
|
||||
|
||||
??? tip "Tip"
|
||||
|
||||
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://bit.ly/ultralytics_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://bit.ly/ultralytics_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
|
||||
|
||||
### Exports
|
||||
|
||||
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.
|
||||
|
||||
| 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` |
|
||||
|---------------------------------------------------|-------------------|---------------------------|----------|----------------------------------------------------------------------|
|
||||
| [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 🎉
|
||||
|
||||
@ -43,7 +126,7 @@ Available export formats are in the table below. You can predict or validate dir
|
||||
|
||||
## Stay Updated 🚧
|
||||
|
||||
This placeholder page is your first stop for upcoming developments. Keep an eye out for:
|
||||
This integrations page is your first stop for upcoming developments. Keep an eye out with our:
|
||||
|
||||
- **Newsletter:** Subscribe [here](https://ultralytics.com/#newsletter) for the latest news.
|
||||
- **Social Media:** Follow us [here](https://www.linkedin.com/company/ultralytics) for updates and teasers.
|
||||
@ -56,7 +139,3 @@ Your feedback shapes our future releases. Share your thoughts and suggestions [h
|
||||
## Thank You, Community! 🌍
|
||||
|
||||
Your [contributions](https://docs.ultralytics.com/help/contributing) inspire our continuous [innovation](https://github.com/ultralytics/ultralytics). Stay tuned for the big reveal of what's next in AI and ML at Ultralytics!
|
||||
|
||||
---
|
||||
|
||||
Excited for what's coming? Bookmark this page and get ready for a transformative AI and ML journey with Ultralytics! 🛠️🤖
|
||||
|
||||
@ -30,3 +30,4 @@ shuizhuyuanluo@126.com: null
|
||||
stormsson@users.noreply.github.com: stormsson
|
||||
web@ultralytics.com: UltralyticsAssistant
|
||||
xinwang614@gmail.com: GreatV
|
||||
waxmann.sergiu@me.com: sergiuwaxmann
|
||||
|
||||
Loading…
Reference in New Issue
Block a user