From 5c276f66ad2efd94409b549a68ec92ded4df718e Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Sat, 5 Apr 2025 19:12:16 +0200 Subject: [PATCH] Truncate long Docs meta titles (#20030) Signed-off-by: Glenn Jocher Co-authored-by: UltralyticsAssistant --- docs/build_docs.py | 22 ++++++++++++------- docs/coming_soon_template.md | 12 +++++----- docs/en/datasets/detect/globalwheat2020.md | 2 +- docs/en/datasets/detect/xview.md | 2 +- docs/en/datasets/explorer/api.md | 2 +- docs/en/datasets/explorer/dashboard.md | 4 +--- docs/en/datasets/explorer/index.md | 2 +- docs/en/datasets/pose/coco8-pose.md | 4 ++-- docs/en/datasets/pose/dog-pose.md | 2 +- docs/en/datasets/segment/coco8-seg.md | 4 ++-- docs/en/datasets/segment/package-seg.md | 2 +- docs/en/guides/azureml-quickstart.md | 2 +- docs/en/guides/model-deployment-practices.md | 2 +- docs/en/guides/model-training-tips.md | 2 +- docs/en/guides/nvidia-jetson.md | 6 ++--- docs/en/guides/parking-management.md | 3 ++- docs/en/guides/streamlit-live-inference.md | 2 +- docs/en/hub/api/index.md | 14 +++++------- docs/en/hub/app/android.md | 2 +- docs/en/hub/integrations.md | 12 +++++----- docs/en/integrations/edge-tpu.md | 2 +- docs/en/integrations/mnn.md | 2 +- docs/en/integrations/ncnn.md | 2 +- docs/en/integrations/neural-magic.md | 2 +- docs/en/integrations/paddlepaddle.md | 4 ++-- docs/en/integrations/paperspace.md | 2 +- docs/en/integrations/tensorrt.md | 2 +- docs/en/integrations/tf-graphdef.md | 2 +- docs/en/integrations/tf-savedmodel.md | 2 +- docs/en/integrations/tfjs.md | 2 +- docs/en/integrations/tflite.md | 4 ++-- docs/en/integrations/torchscript.md | 2 +- docs/en/integrations/weights-biases.md | 2 +- docs/en/models/mobile-sam.md | 4 ++-- docs/en/models/rtdetr.md | 2 +- docs/en/models/sam.md | 2 +- .../tutorials/clearml_logging_integration.md | 2 +- .../tutorials/test_time_augmentation.md | 2 +- 38 files changed, 74 insertions(+), 71 deletions(-) diff --git a/docs/build_docs.py b/docs/build_docs.py index 4e5949d0..03053927 100644 --- a/docs/build_docs.py +++ b/docs/build_docs.py @@ -188,22 +188,28 @@ def update_docs_html(): shutil.rmtree(macros_dir) -def convert_plaintext_links_to_html(content: str) -> str: - """Convert plaintext links to HTML hyperlinks in the main content area only.""" +def convert_plaintext_links_to_html(content: str, max_title_length: int = 70) -> str: + """Convert plaintext links to HTML hyperlinks and truncate long meta titles.""" soup = BeautifulSoup(content, "html.parser") + modified = False - # Find the main content area (adjust this selector based on your HTML structure) + # Truncate long meta title if needed + title_tag = soup.find("title") + if title_tag and len(title_tag.text) > max_title_length and "-" in title_tag.text: + title_tag.string = title_tag.text.rsplit("-", 1)[0].strip() + modified = True + + # Find the main content area main_content = soup.find("main") or soup.find("div", class_="md-content") if not main_content: - return content # Return original content if main content area not found + return str(soup) if modified else content - modified = False - for paragraph in main_content.find_all(["p", "li"]): # Focus on paragraphs and list items + # Convert plaintext links to HTML hyperlinks + for paragraph in main_content.find_all(["p", "li"]): for text_node in paragraph.find_all(string=True, recursive=False): - if text_node.parent.name not in {"a", "code"}: # Ignore links and code blocks + if text_node.parent.name not in {"a", "code"}: new_text = LINK_PATTERN.sub(r'\1', str(text_node)) if ". This file contains necessary information about dataset paths, classes, and other configuration details needed for model training in [Ultralytics YOLO](https://docs.ultralytics.com/models/yolo11/). ### Why is wheat head detection important in crop management? diff --git a/docs/en/datasets/detect/xview.md b/docs/en/datasets/detect/xview.md index ef1c9e45..9aae550b 100644 --- a/docs/en/datasets/detect/xview.md +++ b/docs/en/datasets/detect/xview.md @@ -155,7 +155,7 @@ The xView dataset stands out due to its comprehensive set of features: ### What is the dataset structure of xView, and how is it annotated? -The xView dataset comprises high-resolution satellite images collected from WorldView-3 satellites at a 0.3m ground sample distance. It encompasses over 1 million objects across 60 classes in approximately 1,400 km² of imagery. Each object within the dataset is annotated with bounding boxes, making it ideal for training and evaluating [deep learning](https://www.ultralytics.com/glossary/deep-learning-dl) models for object detection in overhead imagery. For a detailed overview, you can look at the dataset structure section [here](#dataset-structure). +The xView dataset contains high-resolution satellite imagery captured by WorldView-3 satellites at a 0.3m ground sample distance, covering over 1 million objects across 60 distinct classes within approximately 1,400 km² of annotated imagery. Each object is labeled with bounding boxes, making the dataset highly suitable for training and evaluating [deep learning](https://www.ultralytics.com/glossary/deep-learning-dl) models for object detection in overhead views. For a detailed breakdown, refer to the [Dataset Structure section](#dataset-structure). ### How do I cite the xView dataset in my research? diff --git a/docs/en/datasets/explorer/api.md b/docs/en/datasets/explorer/api.md index ca2e6d5b..cade58f3 100644 --- a/docs/en/datasets/explorer/api.md +++ b/docs/en/datasets/explorer/api.md @@ -256,7 +256,7 @@ When using large datasets, you can also create a dedicated vector index for fast table.create_index(num_partitions=..., num_sub_vectors=...) ``` -Find more details on the type vector indices available and parameters [here](https://lancedb.github.io/lancedb/ann_indexes/#types-of-index) In the future, we will add support for creating vector indices directly from Explorer API. +Find more details on the available vector index types and configuration parameters in the [LanceDB indexing documentation](https://lancedb.github.io/lancedb/ann_indexes/#types-of-index). In the future, we plan to support creating vector indices directly through the Explorer API. ## 5. Embeddings Applications diff --git a/docs/en/datasets/explorer/dashboard.md b/docs/en/datasets/explorer/dashboard.md index 3d7ee548..d1c212ad 100644 --- a/docs/en/datasets/explorer/dashboard.md +++ b/docs/en/datasets/explorer/dashboard.md @@ -77,7 +77,7 @@ WHERE labels LIKE '%person%' AND labels LIKE '%dog%' Explorer Dashboard Screenshot 5

-This is a Demo built using the Explorer API. You can use the API to build your own exploratory notebooks or scripts to get insights into your datasets. Learn more about the Explorer API [here](api.md). +This demo was built using the Explorer API, which you can use to create your own exploratory notebooks or scripts for gaining insights into your datasets. To get started, check out the [Explorer API documentation](api.md). ## FAQ @@ -103,8 +103,6 @@ Learn more about semantic search and other features by visiting the [Feature Ove Yes, with the Ask AI feature powered by large language models (LLMs), you can filter your datasets using natural language queries. You don't need to be proficient in SQL. For instance, you can ask "Show me 100 images with exactly one person and 2 dogs. There can be other objects too," and the AI will generate the appropriate query under the hood to deliver the desired results. -See an example of a natural language query [here](#ask-ai). - ### How do I run SQL queries on datasets using Ultralytics Explorer GUI? Ultralytics Explorer GUI allows you to run SQL queries directly on your dataset to filter and manage data efficiently. To run a query, navigate to the SQL query section in the GUI and write your query. For example, to show images with at least one person and one dog, you could use: diff --git a/docs/en/datasets/explorer/index.md b/docs/en/datasets/explorer/index.md index c1d55c43..922231ef 100644 --- a/docs/en/datasets/explorer/index.md +++ b/docs/en/datasets/explorer/index.md @@ -45,7 +45,7 @@ pip install ultralytics[explorer] This is a Python API for exploring your datasets. It also powers the GUI Explorer. You can use this to create your own exploratory notebooks or scripts to get insights into your datasets. -Learn more about the Explorer API [here](api.md). +Explore the full capabilities and usage examples in the [Explorer API documentation](api.md). ## GUI Explorer Usage diff --git a/docs/en/datasets/pose/coco8-pose.md b/docs/en/datasets/pose/coco8-pose.md index 3bec5288..7e83cf06 100644 --- a/docs/en/datasets/pose/coco8-pose.md +++ b/docs/en/datasets/pose/coco8-pose.md @@ -82,7 +82,7 @@ We would like to acknowledge the COCO Consortium for creating and maintaining th ### What is the COCO8-Pose dataset, and how is it used with Ultralytics YOLO11? -The COCO8-Pose dataset is a small, versatile pose detection dataset that includes the first 8 images from the COCO train 2017 set, with 4 images for training and 4 for validation. It's designed for testing and debugging object detection models and experimenting with new detection approaches. This dataset is ideal for quick experiments with [Ultralytics YOLO11](../../models/yolo11.md). For more details on dataset configuration, check out the dataset YAML file [here](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-pose.yaml). +The COCO8-Pose dataset is a small, versatile pose detection dataset that includes the first 8 images from the COCO train 2017 set, with 4 images for training and 4 for validation. It's designed for testing and debugging object detection models and experimenting with new detection approaches. This dataset is ideal for quick experiments with [Ultralytics YOLO11](../../models/yolo11.md). For more details on dataset configuration, check out the [dataset YAML file](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-pose.yaml). ### How do I train a YOLO11 model using the COCO8-Pose dataset in Ultralytics? @@ -126,6 +126,6 @@ Mosaicing, demonstrated in the sample images of the COCO8-Pose dataset, combines ### Where can I find the COCO8-Pose dataset YAML file and how do I use it? -The COCO8-Pose dataset YAML file can be found [here](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-pose.yaml). This file defines the dataset configuration, including paths, classes, and other relevant information. Use this file with the YOLO11 training scripts as mentioned in the [Train Example](#how-do-i-train-a-yolo11-model-using-the-coco8-pose-dataset-in-ultralytics) section. +The COCO8-Pose dataset YAML file can be found at . This file defines the dataset configuration, including paths, classes, and other relevant information. Use this file with the YOLO11 training scripts as mentioned in the [Train Example](#how-do-i-train-a-yolo11-model-using-the-coco8-pose-dataset-in-ultralytics) section. For more FAQs and detailed documentation, visit the [Ultralytics Documentation](https://docs.ultralytics.com/). diff --git a/docs/en/datasets/pose/dog-pose.md b/docs/en/datasets/pose/dog-pose.md index 1c89b6a0..f17b87fd 100644 --- a/docs/en/datasets/pose/dog-pose.md +++ b/docs/en/datasets/pose/dog-pose.md @@ -143,7 +143,7 @@ This approach leads to more robust models that perform better in real-world scen ### Where can I find the Dog-pose dataset YAML file and how do I use it? -The Dog-pose dataset YAML file can be found [here](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/dog-pose.yaml). This file defines the dataset configuration, including paths, classes, keypoint details, and other relevant information. The YAML specifies 24 keypoints with 3 dimensions per keypoint, making it suitable for detailed pose estimation tasks. +The Dog-pose dataset YAML file can be found at . This file defines the dataset configuration, including paths, classes, keypoint details, and other relevant information. The YAML specifies 24 keypoints with 3 dimensions per keypoint, making it suitable for detailed pose estimation tasks. To use this file with YOLO11 training scripts, simply reference it in your training command as shown in the [Usage](#usage) section. The dataset will be automatically downloaded when first used, making setup straightforward. diff --git a/docs/en/datasets/segment/coco8-seg.md b/docs/en/datasets/segment/coco8-seg.md index 3fc69745..33c0bed5 100644 --- a/docs/en/datasets/segment/coco8-seg.md +++ b/docs/en/datasets/segment/coco8-seg.md @@ -113,11 +113,11 @@ For a thorough explanation of available arguments and configuration options, you ### Why is the COCO8-Seg dataset important for model development and debugging? -The **COCO8-Seg dataset** is ideal for its manageability and diversity within a small size. It consists of only 8 images, providing a quick way to test and debug segmentation models or new detection approaches without the overhead of larger datasets. This makes it an efficient tool for sanity checks and pipeline error identification before committing to extensive training on large datasets. Learn more about dataset formats [here](https://docs.ultralytics.com/datasets/segment/). +The **COCO8-Seg dataset** offers a compact yet diverse set of 8 images, making it perfect for quickly testing and debugging segmentation models or experimenting with new detection techniques. Its small size allows for fast sanity checks and early pipeline validation, helping identify issues before scaling to larger datasets. Learn more about supported dataset formats in the [Ultralytics segmentation dataset guide](https://docs.ultralytics.com/datasets/segment/). ### Where can I find the YAML configuration file for the COCO8-Seg dataset? -The YAML configuration file for the **COCO8-Seg dataset** is available in the Ultralytics repository. You can access the file directly [here](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/coco8-seg.yaml). The YAML file includes essential information about dataset paths, classes, and configuration settings required for model training and validation. +The YAML configuration file for the **COCO8-Seg dataset** is available in the Ultralytics repository. You can access the file directly at . The YAML file includes essential information about dataset paths, classes, and configuration settings required for model training and validation. ### What are some benefits of using mosaicing during training with the COCO8-Seg dataset? diff --git a/docs/en/datasets/segment/package-seg.md b/docs/en/datasets/segment/package-seg.md index 7ca6afc3..747b9f47 100644 --- a/docs/en/datasets/segment/package-seg.md +++ b/docs/en/datasets/segment/package-seg.md @@ -162,4 +162,4 @@ We express our gratitude to the creators of the Package Segmentation dataset for ### How can I access and use the package-seg.yaml file for the Package Segmentation Dataset? -- The `package-seg.yaml` file is hosted on Ultralytics' GitHub repository and contains essential information about the dataset's paths, classes, and configuration. You can view or download it from [here](https://github.com/ultralytics/ultralytics/blob/main/ultralytics/cfg/datasets/package-seg.yaml). This file is crucial for configuring your models to utilize the dataset efficiently. For more insights and practical examples, explore our [Python Usage](https://docs.ultralytics.com/usage/python/) section. +- The `package-seg.yaml` file is hosted on Ultralytics' GitHub repository and contains essential information about the dataset's paths, classes, and configuration. You can view or download it at . This file is crucial for configuring your models to utilize the dataset efficiently. For more insights and practical examples, explore our [Python Usage](https://docs.ultralytics.com/usage/python/) section. diff --git a/docs/en/guides/azureml-quickstart.md b/docs/en/guides/azureml-quickstart.md index 5e70ca57..a9ac77e2 100644 --- a/docs/en/guides/azureml-quickstart.md +++ b/docs/en/guides/azureml-quickstart.md @@ -215,7 +215,7 @@ Yes, AzureML allows you to use both the Ultralytics CLI and the Python interface model.train(data="coco8.yaml", epochs=3) ``` -Refer to the quickstart guides for more detailed instructions [here](../quickstart.md#use-ultralytics-with-cli) and [here](../quickstart.md#use-ultralytics-with-python). +For step-by-step instructions, refer to the [CLI quickstart guide](../quickstart.md#use-ultralytics-with-cli) and the [Python quickstart guide](../quickstart.md#use-ultralytics-with-python). ### What is the advantage of using Ultralytics YOLO11 over other [object detection](https://www.ultralytics.com/glossary/object-detection) models? diff --git a/docs/en/guides/model-deployment-practices.md b/docs/en/guides/model-deployment-practices.md index ed608ba0..25b5917e 100644 --- a/docs/en/guides/model-deployment-practices.md +++ b/docs/en/guides/model-deployment-practices.md @@ -27,7 +27,7 @@ It's also important to follow best practices when deploying a model because depl Often times, once a model is [trained](./model-training-tips.md), [evaluated](./model-evaluation-insights.md), and [tested](./model-testing.md), it needs to be converted into specific formats to be deployed effectively in various environments, such as cloud, edge, or local devices. -With respect to YOLO11, you can [export your model](../modes/export.md) to different formats. For example, when you need to transfer your model between different frameworks, ONNX is an excellent tool and [exporting to YOLO11 to ONNX](../integrations/onnx.md) is easy. You can check out more options about integrating your model into different environments smoothly and effectively [here](../integrations/index.md). +With YOLO11, you can [export your model to various formats](../modes/export.md) depending on your deployment needs. For instance, [exporting YOLO11 to ONNX](../integrations/onnx.md) is straightforward and ideal for transferring models between frameworks. To explore more integration options and ensure a smooth deployment across different environments, visit our [model integration hub](../integrations/index.md). ### Choosing a Deployment Environment diff --git a/docs/en/guides/model-training-tips.md b/docs/en/guides/model-training-tips.md index 3caf68bc..5c25a9de 100644 --- a/docs/en/guides/model-training-tips.md +++ b/docs/en/guides/model-training-tips.md @@ -197,7 +197,7 @@ Multiscale training enhances model performance by training on images of varying ### How can I use pre-trained weights to speed up training in YOLO11? -Using pre-trained weights can significantly reduce training times and improve model performance by starting from a model that already understands basic features. In YOLO11, you can set the `pretrained` parameter to `True` or specify a path to custom pre-trained weights in your training configuration. This approach, known as transfer learning, leverages knowledge from large datasets to adapt to your specific task. Learn more about pre-trained weights and their advantages [here](../modes/train.md). +Using pre-trained weights can greatly accelerate training and enhance model accuracy by leveraging a model already familiar with foundational visual features. In YOLO11, simply set the `pretrained` parameter to `True` or provide a path to your custom pre-trained weights in the training configuration. This method, called transfer learning, allows models trained on large datasets to be effectively adapted to your specific application. Learn more about how to use pre-trained weights and their benefits in the [training configuration guide](../modes/train.md). ### What is the recommended number of epochs for training a model, and how do I set this in YOLO11? diff --git a/docs/en/guides/nvidia-jetson.md b/docs/en/guides/nvidia-jetson.md index 2be67670..774c0e07 100644 --- a/docs/en/guides/nvidia-jetson.md +++ b/docs/en/guides/nvidia-jetson.md @@ -165,7 +165,7 @@ sudo apt-get -y install libcusparselt0 libcusparselt-dev The [onnxruntime-gpu](https://pypi.org/project/onnxruntime-gpu/) package hosted in PyPI does not have `aarch64` binaries for the Jetson. So we need to manually install this package. This package is needed for some of the exports. -All different `onnxruntime-gpu` packages corresponding to different JetPack and Python versions are listed [here](https://elinux.org/Jetson_Zoo#ONNX_Runtime). However, here we will download and install `onnxruntime-gpu 1.20.0` with `Python3.10` support. +You can find all available `onnxruntime-gpu` packages—organized by JetPack version, Python version, and other compatibility details—in the [Jetson Zoo ONNX Runtime compatibility matrix](https://elinux.org/Jetson_Zoo#ONNX_Runtime). Here we will download and install `onnxruntime-gpu 1.20.0` with `Python3.10` support. ```bash pip install https://github.com/ultralytics/assets/releases/download/v0.0.0/onnxruntime_gpu-1.20.0-cp310-cp310-linux_aarch64.whl @@ -228,7 +228,7 @@ The above ultralytics installation will install Torch and Torchvision. However, The [onnxruntime-gpu](https://pypi.org/project/onnxruntime-gpu/) package hosted in PyPI does not have `aarch64` binaries for the Jetson. So we need to manually install this package. This package is needed for some of the exports. -All different `onnxruntime-gpu` packages corresponding to different JetPack and Python versions are listed [here](https://elinux.org/Jetson_Zoo#ONNX_Runtime). However, here we will download and install `onnxruntime-gpu 1.17.0` with `Python3.8` support. +You can find all available `onnxruntime-gpu` packages—organized by JetPack version, Python version, and other compatibility details—in the [Jetson Zoo ONNX Runtime compatibility matrix](https://elinux.org/Jetson_Zoo#ONNX_Runtime). Here we will download and install `onnxruntime-gpu 1.17.0` with `Python3.8` support. ```bash wget https://nvidia.box.com/shared/static/zostg6agm00fb6t5uisw51qi6kpcuwzd.whl -O onnxruntime_gpu-1.17.0-cp38-cp38-linux_aarch64.whl @@ -243,7 +243,7 @@ pip install onnxruntime_gpu-1.17.0-cp38-cp38-linux_aarch64.whl ## Use TensorRT on NVIDIA Jetson -Out of all the model export formats supported by Ultralytics, TensorRT delivers the best inference performance when working with NVIDIA Jetson devices and our recommendation is to use TensorRT with Jetson. We also have a detailed document on TensorRT [here](../integrations/tensorrt.md). +Among all the model export formats supported by Ultralytics, TensorRT offers the highest inference performance on NVIDIA Jetson devices, making it our top recommendation for Jetson deployments. For setup instructions and advanced usage, see our [dedicated TensorRT integration guide](../integrations/tensorrt.md). ### Convert Model to TensorRT and Run Inference diff --git a/docs/en/guides/parking-management.md b/docs/en/guides/parking-management.md index cb933d7f..93959583 100644 --- a/docs/en/guides/parking-management.md +++ b/docs/en/guides/parking-management.md @@ -138,7 +138,8 @@ Using Ultralytics YOLO11 for smart parking yields numerous benefits: - **Efficiency**: Optimizes the use of parking spaces and decreases congestion. - **Safety and Security**: Enhances surveillance and ensures the safety of vehicles and pedestrians. -- **Environmental Impact**: Helps in reducing emissions by minimizing vehicle idle times. More details on the advantages can be seen [here](#advantages-of-parking-management-system). +- **Environmental Impact**: Helps reduce emissions by minimizing vehicle idle times. Explore more benefits in the [Advantages of Parking Management System section](#advantages-of-parking-management-system). +- ### How can I define parking spaces using Ultralytics YOLO11? diff --git a/docs/en/guides/streamlit-live-inference.md b/docs/en/guides/streamlit-live-inference.md index 1eecb3a6..65cfe090 100644 --- a/docs/en/guides/streamlit-live-inference.md +++ b/docs/en/guides/streamlit-live-inference.md @@ -157,7 +157,7 @@ Using Ultralytics YOLO11 with Streamlit for real-time object detection offers se - **User-Friendly Interface**: Streamlit's intuitive interface allows easy use and deployment without extensive technical knowledge. - **Resource Efficiency**: YOLO11's optimized algorithms ensure high-speed processing with minimal computational resources. -Discover more about these advantages [here](#advantages-of-live-inference). +Learn more about these benefits in the [Advantages of Live Inference section](#advantages-of-live-inference). ### How do I deploy a Streamlit object detection application in my web browser? diff --git a/docs/en/hub/api/index.md b/docs/en/hub/api/index.md index 9ae12c3d..ba93c7d4 100644 --- a/docs/en/hub/api/index.md +++ b/docs/en/hub/api/index.md @@ -15,20 +15,18 @@ Welcome to the Ultralytics "Under Construction" page! Here, we're hard at work d ## Stay Updated 🚧 -This placeholder page is your first stop for upcoming developments. Keep an eye out for: +This page is your go-to resource for the latest integration updates and feature rollouts. Stay connected through: -- **Newsletter:** Subscribe [here](https://www.ultralytics.com/#newsletter) for the latest news. -- **Social Media:** Follow us [here](https://www.linkedin.com/company/ultralytics) for updates and teasers. -- **Blog:** Visit our [blog](https://www.ultralytics.com/blog) for detailed insights. +- **Newsletter:** Subscribe to [our Ultralytics newsletter](https://www.ultralytics.com/#newsletter) for announcements, releases, and early access updates. +- **Social Media:** Follow [Ultralytics on LinkedIn](https://www.linkedin.com/company/ultralytics) for behind-the-scenes content, product news, and community highlights. +- **Blog:** Dive into the [Ultralytics AI blog](https://www.ultralytics.com/blog) for in-depth articles, tutorials, and use-case spotlights. ## We Value Your Input 🗣️ -Your feedback shapes our future releases. Share your thoughts and suggestions [here](https://www.ultralytics.com/contact). +Help shape the future of Ultralytics HUB by sharing your ideas, feedback, and integration requests through our [official contact form](https://www.ultralytics.com/contact). ## Thank You, Community! 🌍 -Your [contributions](../../help/contributing.md) 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! - ---- +## Your [contributions](../../help/contributing.md) and ongoing support fuel our commitment to pushing the boundaries of [AI innovation](https://github.com/ultralytics/ultralytics). Stay tuned—exciting things are just around the corner! Excited for what's coming? Bookmark this page and get ready for a transformative AI and ML journey with Ultralytics! 🛠️🤖 diff --git a/docs/en/hub/app/android.md b/docs/en/hub/app/android.md index 83f3e70b..d7a4efb3 100644 --- a/docs/en/hub/app/android.md +++ b/docs/en/hub/app/android.md @@ -87,7 +87,7 @@ To get started with the Ultralytics Android App, follow these steps: 1. Download the Ultralytics App from the [Google Play Store](https://play.google.com/store/apps/details?id=com.ultralytics.ultralytics_app). -2. Launch the app on your Android device and sign in with your Ultralytics account. If you don't have an account yet, create one [here](https://hub.ultralytics.com/). +2. Launch the app on your Android device and sign in with your Ultralytics account. If you don't have an account yet, create one at . 3. Once signed in, you will see a list of your trained YOLO models. Select a model to use for object detection. diff --git a/docs/en/hub/integrations.md b/docs/en/hub/integrations.md index e2494c93..f5296782 100644 --- a/docs/en/hub/integrations.md +++ b/docs/en/hub/integrations.md @@ -114,16 +114,16 @@ We are continuously working to expand Ultralytics HUB's integration capabilities ## Stay Updated 🚧 -Keep an eye on this integrations page for the latest developments. Stay informed through our: +This page is your go-to resource for the latest integration updates and feature rollouts. Stay connected through: -- **Newsletter:** Subscribe [here](https://www.ultralytics.com/#newsletter) for major announcements. -- **Social Media:** Follow us on [LinkedIn](https://www.linkedin.com/company/ultralytics) for updates and insights. -- **Blog:** Visit our [blog](https://www.ultralytics.com/blog) for detailed articles and use cases. +- **Newsletter:** Subscribe to [our Ultralytics newsletter](https://www.ultralytics.com/#newsletter) for announcements, releases, and early access updates. +- **Social Media:** Follow [Ultralytics on LinkedIn](https://www.linkedin.com/company/ultralytics) for behind-the-scenes content, product news, and community highlights. +- **Blog:** Dive into the [Ultralytics AI blog](https://www.ultralytics.com/blog) for in-depth articles, tutorials, and use-case spotlights. ## We Value Your Input 🗣️ -Your feedback is crucial in shaping the future of Ultralytics HUB. Share your thoughts, suggestions, and integration requests [here](https://www.ultralytics.com/survey). +Help shape the future of Ultralytics HUB by sharing your ideas, feedback, and integration requests through our [official contact form](https://www.ultralytics.com/contact). ## Thank You, Community! 🌍 -Your [contributions](../help/contributing.md) and engagement inspire our continuous innovation in AI and [machine learning](https://www.ultralytics.com/glossary/machine-learning-ml). Stay tuned for more exciting updates from Ultralytics! +Your [contributions](../help/contributing.md) and ongoing support fuel our commitment to pushing the boundaries of [AI innovation](https://github.com/ultralytics/ultralytics). Stay tuned—exciting things are just around the corner! diff --git a/docs/en/integrations/edge-tpu.md b/docs/en/integrations/edge-tpu.md index ceef5930..64a29370 100644 --- a/docs/en/integrations/edge-tpu.md +++ b/docs/en/integrations/edge-tpu.md @@ -63,7 +63,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/mnn.md b/docs/en/integrations/mnn.md index 9b404d45..d0131a30 100644 --- a/docs/en/integrations/mnn.md +++ b/docs/en/integrations/mnn.md @@ -34,7 +34,7 @@ To install the required packages, run: ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/ncnn.md b/docs/en/integrations/ncnn.md index 855cf4e6..46773af9 100644 --- a/docs/en/integrations/ncnn.md +++ b/docs/en/integrations/ncnn.md @@ -65,7 +65,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/neural-magic.md b/docs/en/integrations/neural-magic.md index 6619bab8..c0641a20 100644 --- a/docs/en/integrations/neural-magic.md +++ b/docs/en/integrations/neural-magic.md @@ -157,7 +157,7 @@ After running the eval command, you will receive detailed output metrics such as This guide explored integrating Ultralytics' YOLO11 with Neural Magic's DeepSparse Engine. It highlighted how this integration enhances YOLO11's performance on CPU platforms, offering GPU-level efficiency and advanced neural network sparsity techniques. -For more detailed information and advanced usage, visit [Neural Magic's DeepSparse documentation](https://docs.neuralmagic.com/products/deepsparse/). Also, check out Neural Magic's documentation on the integration with YOLO11 [here](https://github.com/neuralmagic/deepsparse/tree/main/src/deepsparse/yolov8#yolov8-inference-pipelines) and watch a great session on it [here](https://www.youtube.com/watch?v=qtJ7bdt52x8). +For more detailed information and advanced usage, visit the [DeepSparse documentation by Neural Magic](https://docs.neuralmagic.com/products/deepsparse/). You can also [explore the YOLO11 integration guide](https://github.com/neuralmagic/deepsparse/tree/main/src/deepsparse/yolov8#yolov8-inference-pipelines) and [watch a walkthrough session on YouTube](https://www.youtube.com/watch?v=qtJ7bdt52x8). Additionally, for a broader understanding of various YOLO11 integrations, visit the [Ultralytics integration guide page](../integrations/index.md), where you can discover a range of other exciting integration possibilities. diff --git a/docs/en/integrations/paddlepaddle.md b/docs/en/integrations/paddlepaddle.md index 53c7c4a8..e2bc5a65 100644 --- a/docs/en/integrations/paddlepaddle.md +++ b/docs/en/integrations/paddlepaddle.md @@ -78,7 +78,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/yolo11.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/yolo11.md) support export, and you can [browse the full list of export formats and options](../modes/export.md) to find the best fit for your deployment needs. !!! example "Usage" @@ -187,7 +187,7 @@ PaddlePaddle offers several key advantages for model deployment: - **Operator Fusion**: By merging compatible operations, it reduces computational overhead. - **Quantization Techniques**: Supports both post-training and quantization-aware training, enabling lower-[precision](https://www.ultralytics.com/glossary/precision) data representations for improved performance. -You can achieve enhanced results by exporting your Ultralytics YOLO11 models to PaddlePaddle, ensuring flexibility and high performance across various applications and hardware platforms. Learn more about PaddlePaddle's features [here](https://www.paddlepaddle.org.cn/en). +You can achieve enhanced results by exporting your Ultralytics YOLO11 models to PaddlePaddle, ensuring flexibility and high performance across various applications and hardware platforms. Explore PaddlePaddle's key features and capabilities in the [official PaddlePaddle documentation](https://www.paddlepaddle.org.cn/en).. ### Why should I choose PaddlePaddle for deploying my YOLO11 models? diff --git a/docs/en/integrations/paperspace.md b/docs/en/integrations/paperspace.md index b64c49f6..193e7f32 100644 --- a/docs/en/integrations/paperspace.md +++ b/docs/en/integrations/paperspace.md @@ -104,7 +104,7 @@ Paperspace Gradient offers several unique advantages for training and deploying ### Why should I choose Ultralytics YOLO11 over other object detection models? -Ultralytics YOLO11 stands out for its real-time object detection capabilities and high [accuracy](https://www.ultralytics.com/glossary/accuracy). Its seamless integration with platforms like Paperspace Gradient enhances productivity by simplifying the training and deployment process. YOLO11 supports various use cases, from security systems to retail inventory management. Explore more about YOLO11's advantages [here](https://www.ultralytics.com/yolo). +Ultralytics YOLO11 stands out for its real-time object detection capabilities and high [accuracy](https://www.ultralytics.com/glossary/accuracy). Its seamless integration with platforms like Paperspace Gradient enhances productivity by simplifying the training and deployment process. YOLO11 supports various use cases, from security systems to retail inventory management. Discover the full range of YOLO11's capabilities and benefits in our [YOLO11 overview](https://www.ultralytics.com/yolo). ### Can I deploy my YOLO11 model on edge devices using Paperspace Gradient? diff --git a/docs/en/integrations/tensorrt.md b/docs/en/integrations/tensorrt.md index dfd7ba81..e89cd3f0 100644 --- a/docs/en/integrations/tensorrt.md +++ b/docs/en/integrations/tensorrt.md @@ -506,7 +506,7 @@ Using TensorRT to optimize YOLO11 models offers several benefits: - **Layer Fusion**: Combines multiple layers into single operations, reducing computational complexity. - **Kernel Auto-Tuning**: Automatically selects optimized GPU kernels for each model layer, ensuring maximum performance. -For more information, explore the detailed features of TensorRT [here](https://developer.nvidia.com/tensorrt) and read our [TensorRT overview section](#tensorrt). +To learn more, explore the [official TensorRT documentation from NVIDIA](https://developer.nvidia.com/tensorrt) and our [in-depth TensorRT overview](#tensorrt). ### Can I use INT8 quantization with TensorRT for YOLO11 models? diff --git a/docs/en/integrations/tf-graphdef.md b/docs/en/integrations/tf-graphdef.md index 4939b5ca..4a04fe9d 100644 --- a/docs/en/integrations/tf-graphdef.md +++ b/docs/en/integrations/tf-graphdef.md @@ -71,7 +71,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/tf-savedmodel.md b/docs/en/integrations/tf-savedmodel.md index 09a3d88a..9d9dbcfa 100644 --- a/docs/en/integrations/tf-savedmodel.md +++ b/docs/en/integrations/tf-savedmodel.md @@ -65,7 +65,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/tfjs.md b/docs/en/integrations/tfjs.md index e7bc273b..aaae1508 100644 --- a/docs/en/integrations/tfjs.md +++ b/docs/en/integrations/tfjs.md @@ -63,7 +63,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/tflite.md b/docs/en/integrations/tflite.md index 965f57fe..1963351b 100644 --- a/docs/en/integrations/tflite.md +++ b/docs/en/integrations/tflite.md @@ -69,7 +69,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" @@ -201,7 +201,7 @@ For more information on deployment options, see our detailed [deployment guide]( If you encounter errors while exporting YOLO11 models to TFLite, common solutions include: - **Check package compatibility**: Ensure you're using compatible versions of Ultralytics and TensorFlow. Refer to our [installation guide](../quickstart.md). -- **Model support**: Verify that the specific YOLO11 model supports TFLite export by checking [here](../modes/export.md). +- **Model support**: Verify that the specific YOLO11 model supports TFLite export by checking the Ultralytics [export documentation page](../modes/export.md). - **Quantization issues**: When using INT8 quantization, make sure your dataset path is correctly specified in the `data` parameter. For additional troubleshooting tips, visit our [Common Issues guide](../guides/yolo-common-issues.md). diff --git a/docs/en/integrations/torchscript.md b/docs/en/integrations/torchscript.md index 74452737..78c2df66 100644 --- a/docs/en/integrations/torchscript.md +++ b/docs/en/integrations/torchscript.md @@ -73,7 +73,7 @@ For detailed instructions and best practices related to the installation process ### Usage -Before diving into the usage instructions, it's important to note that while all [Ultralytics YOLO11 models](../models/index.md) are available for exporting, you can ensure that the model you select supports export functionality [here](../modes/export.md). +All [Ultralytics YOLO11 models](../models/index.md) are designed to support export out of the box, making it easy to integrate them into your preferred deployment workflow. You can [view the full list of supported export formats and configuration options](../modes/export.md) to choose the best setup for your application. !!! example "Usage" diff --git a/docs/en/integrations/weights-biases.md b/docs/en/integrations/weights-biases.md index 887f3ab7..1602c6f3 100644 --- a/docs/en/integrations/weights-biases.md +++ b/docs/en/integrations/weights-biases.md @@ -151,7 +151,7 @@ After running the usage code snippet, you can access the Weights & Biases (W&B) - **Model Artifacts Management**: Access and share model checkpoints, facilitating easy deployment and collaboration with team members on complex projects. -- **Viewing Inference Results with Image Overlay**: Visualize the prediction results on images using interactive overlays in Weights & Biases, providing a clear and detailed view of model performance on real-world data. For more detailed information on Weights & Biases' image overlay capabilities, check out this [link](https://docs.wandb.ai/guides/track/log/media/#image-overlays). [See how Weights & Biases' image overlays helps visualize model inferences](https://imgur.com/a/UTSiufs). +- **Viewing Inference Results with Image Overlay**: Visualize the prediction results on images using interactive overlays in Weights & Biases, providing a clear and detailed view of model performance on real-world data. For more detailed information see Weights & Biases' [image overlay capabilities](https://docs.wandb.ai/guides/track/log/media/#image-overlays). By using these features, you can effectively track, analyze, and optimize your YOLO11 model's training, ensuring the best possible performance and efficiency for your [object detection](https://www.ultralytics.com/glossary/object-detection) tasks. diff --git a/docs/en/models/mobile-sam.md b/docs/en/models/mobile-sam.md index 386e2abb..c00dec02 100644 --- a/docs/en/models/mobile-sam.md +++ b/docs/en/models/mobile-sam.md @@ -119,7 +119,7 @@ Just like the original [SAM](sam.md), we offer a straightforward testing method ### Model Download -You can download the model [here](https://github.com/ChaoningZhang/MobileSAM/blob/master/weights/mobile_sam.pt). +You can download the MobileSAM pretrained weights at . ### Point Prompt @@ -210,7 +210,7 @@ If you find MobileSAM useful in your research or development work, please consid ### What is MobileSAM and how does it differ from the original SAM model? -MobileSAM is a lightweight, fast [image segmentation](https://www.ultralytics.com/glossary/image-segmentation) model designed for mobile applications. It retains the same pipeline as the original SAM but replaces the heavyweight ViT-H encoder (632M parameters) with a smaller Tiny-ViT encoder (5M parameters). This change results in MobileSAM being approximately 5 times smaller and 7 times faster than the original SAM. For instance, MobileSAM operates at about 12ms per image, compared to the original SAM's 456ms. You can learn more about the MobileSAM implementation in various projects [here](https://github.com/ChaoningZhang/MobileSAM). +MobileSAM is a lightweight, fast [image segmentation](https://www.ultralytics.com/glossary/image-segmentation) model designed for mobile applications. It retains the same pipeline as the original SAM but replaces the heavyweight ViT-H encoder (632M parameters) with a smaller Tiny-ViT encoder (5M parameters). This change results in MobileSAM being approximately 5 times smaller and 7 times faster than the original SAM. For instance, MobileSAM operates at about 12ms per image, compared to the original SAM's 456ms. You can learn more about the MobileSAM implementation in various projects at the [MobileSAM GitHub repository](https://github.com/ChaoningZhang/MobileSAM). ### How can I test MobileSAM using Ultralytics? diff --git a/docs/en/models/rtdetr.md b/docs/en/models/rtdetr.md index 6c729f63..83ca531f 100644 --- a/docs/en/models/rtdetr.md +++ b/docs/en/models/rtdetr.md @@ -140,7 +140,7 @@ We would like to acknowledge Baidu and the [PaddlePaddle](https://github.com/Pad ### What is Baidu's RT-DETR model and how does it work? -Baidu's RT-DETR (Real-Time Detection Transformer) is an advanced real-time object detector built upon the Vision Transformer architecture. It efficiently processes multiscale features by decoupling intra-scale interaction and cross-scale fusion through its efficient hybrid encoder. By employing IoU-aware query selection, the model focuses on the most relevant objects, enhancing detection accuracy. Its adaptable inference speed, achieved by adjusting decoder layers without retraining, makes RT-DETR suitable for various real-time object detection scenarios. Learn more about RT-DETR features [here](https://arxiv.org/pdf/2304.08069). +Baidu's RT-DETR (Real-Time Detection Transformer) is an advanced real-time object detector built upon the Vision Transformer architecture. It efficiently processes multiscale features by decoupling intra-scale interaction and cross-scale fusion through its efficient hybrid encoder. By employing IoU-aware query selection, the model focuses on the most relevant objects, enhancing detection accuracy. Its adaptable inference speed, achieved by adjusting decoder layers without retraining, makes RT-DETR suitable for various real-time object detection scenarios. Learn more about RT-DETR features in the [RT-DETR Arxiv paper](https://arxiv.org/pdf/2304.08069). ### How can I use the pre-trained RT-DETR models provided by Ultralytics? diff --git a/docs/en/models/sam.md b/docs/en/models/sam.md index 7ce6987b..e4d8b476 100644 --- a/docs/en/models/sam.md +++ b/docs/en/models/sam.md @@ -243,7 +243,7 @@ We would like to express our gratitude to Meta AI for creating and maintaining t ### What is the Segment Anything Model (SAM) by Ultralytics? -The Segment Anything Model (SAM) by Ultralytics is a revolutionary image segmentation model designed for promptable segmentation tasks. It leverages advanced architecture, including image and prompt encoders combined with a lightweight mask decoder, to generate high-quality segmentation masks from various prompts such as spatial or text cues. Trained on the expansive [SA-1B dataset](https://ai.meta.com/datasets/segment-anything/), SAM excels in zero-shot performance, adapting to new image distributions and tasks without prior knowledge. Learn more [here](#introduction-to-sam-the-segment-anything-model). +The Segment Anything Model (SAM) by Ultralytics is a revolutionary image segmentation model designed for promptable segmentation tasks. It leverages advanced architecture, including image and prompt encoders combined with a lightweight mask decoder, to generate high-quality segmentation masks from various prompts such as spatial or text cues. Trained on the expansive [SA-1B dataset](https://ai.meta.com/datasets/segment-anything/), SAM excels in zero-shot performance, adapting to new image distributions and tasks without prior knowledge. ### How can I use the Segment Anything Model (SAM) for image segmentation? diff --git a/docs/en/yolov5/tutorials/clearml_logging_integration.md b/docs/en/yolov5/tutorials/clearml_logging_integration.md index 5b50dfa8..0ea19424 100644 --- a/docs/en/yolov5/tutorials/clearml_logging_integration.md +++ b/docs/en/yolov5/tutorials/clearml_logging_integration.md @@ -36,7 +36,7 @@ And so much more. It's up to you how many of these tools you want to use, you ca To keep track of your experiments and/or data, ClearML needs to communicate with a server. You have 2 options to get one: -Either sign up for free to the [ClearML Hosted Service](https://clear.ml/) or you can set up your own server, see [here](https://clear.ml/docs/latest/docs/deploying_clearml/clearml_server). Even the server is open-source, so even if you're dealing with sensitive data, you should be good to go! +Either sign up for free to the [ClearML Hosted Service](https://clear.ml/) or you can set up your own [ClearML server](https://clear.ml/docs/latest/docs/deploying_clearml/clearml_server). Even the server is open-source, so even if you're dealing with sensitive data, you should be good to go! - Install the `clearml` python package: diff --git a/docs/en/yolov5/tutorials/test_time_augmentation.md b/docs/en/yolov5/tutorials/test_time_augmentation.md index ba67e8ae..980d0006 100644 --- a/docs/en/yolov5/tutorials/test_time_augmentation.md +++ b/docs/en/yolov5/tutorials/test_time_augmentation.md @@ -145,7 +145,7 @@ results.print() # or .show(), .save(), .crop(), .pandas(), etc. ### Customize -You can customize the TTA operations applied in the YOLOv5 `forward_augment()` method [here](https://github.com/ultralytics/yolov5/blob/8c6f9e15bfc0000d18b976a95b9d7c17d407ec91/models/yolo.py#L125-L137). +You can customize the TTA operations applied in the [YOLOv5 `forward_augment()` method](https://github.com/ultralytics/yolov5/blob/8c6f9e15bfc0000d18b976a95b9d7c17d407ec91/models/yolo.py#L125-L137). ## Benefits of Test-Time Augmentation