Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 14 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,19 @@ Welcome to Ultralytics Docs, your comprehensive resource for understanding and u
[![pages-build-deployment](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment)
[![Check Broken links](https://github.com/ultralytics/docs/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/links.yml)
[![Check Domains](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml)
[![Ultralytics Actions](https://github.com/ultralytics/docs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/format.yml)

<a href="https://discord.com/invite/ultralytics"><img alt="Discord" src="https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue"></a> <a href="https://community.ultralytics.com/"><img alt="Ultralytics Forums" src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue"></a> <a href="https://reddit.com/r/ultralytics"><img alt="Ultralytics Reddit" src="https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue"></a>
[![Ultralytics Actions](https://github.com/ultralytics/docs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/format.yml)
[![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord&logoColor=white&label=Discord&color=blue)](https://discord.com/invite/ultralytics)
[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com&logo=discourse&label=Forums&color=blue)](https://community.ultralytics.com/)
[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat&logo=reddit&logoColor=white&label=Reddit&color=blue)](https://reddit.com/r/ultralytics)

## πŸ› οΈ Installation

[![PyPI - Version](https://img.shields.io/pypi/v/ultralytics?logo=pypi&logoColor=white)](https://pypi.org/project/ultralytics/)
[![Downloads](https://static.pepy.tech/badge/ultralytics)](https://www.pepy.tech/projects/ultralytics)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ultralytics?logo=python&logoColor=gold)](https://pypi.org/project/ultralytics/)

To install the `ultralytics` package in developer mode, which allows you to modify the source code directly, ensure you have [Git](https://git-scm.com/) and [Python](https://www.python.org/) 3.9 or later installed on your system. Then, follow these steps:
To install the `ultralytics` package in developer mode, which allows you to modify the source code directly, ensure you have [Git](https://git-scm.com/downloads) and [Python](https://www.python.org/downloads/) 3.9 or later installed on your system. Then, follow these steps:

1. Clone the `ultralytics` repository to your local machine using Git:

Expand All @@ -31,17 +33,17 @@ To install the `ultralytics` package in developer mode, which allows you to modi
cd ultralytics
```

3. Install the package in editable mode (`-e`) along with its development dependencies (`[dev]`) using [pip](https://pip.pypa.io/en/stable/):
3. Install the package in editable mode (`-e`) along with its development dependencies (`[dev]`) using [pip](https://pip.pypa.io/en/stable/installation/):

```bash
pip install -e '.[dev]'
```

This command installs the `ultralytics` package such that changes to the source code are immediately reflected in your environment, ideal for development.
This command installs the `ultralytics` package such that changes to the source code are immediately reflected in your environment, ideal for development and contributing.

## πŸš€ Building and Serving Locally

The `mkdocs serve` command builds and serves a local version of your [MkDocs](https://www.mkdocs.org/) documentation. This is highly useful during development and testing to preview changes.
The `mkdocs serve` command builds and serves a local version of your [MkDocs](https://www.mkdocs.org/) documentation. This is highly useful during development and testing to preview changes in real-time.

```bash
mkdocs serve
Expand Down Expand Up @@ -90,7 +92,7 @@ If your documentation supports multiple languages, follow these steps to build a

## πŸ“€ Deploying Your Documentation Site

To deploy your MkDocs documentation site, choose a hosting provider and configure your deployment method. Common options include [GitHub Pages](https://pages.github.com/), GitLab Pages, or other static site hosting services.
To deploy your MkDocs documentation site, choose a hosting provider and configure your deployment method. Common options include [GitHub Pages](https://pages.github.com/), GitLab Pages, or other static site hosting services like [Netlify](https://www.netlify.com/) or [Vercel](https://vercel.com/).

- Configure deployment settings within your `mkdocs.yml` file.
- Use the `mkdocs deploy` command specific to your chosen provider to build and deploy your site.
Expand All @@ -110,22 +112,22 @@ To deploy your MkDocs documentation site, choose a hosting provider and configur

## πŸ’‘ Contribute

We deeply value contributions from the open-source community to enhance Ultralytics projects. Your input helps drive innovation! Please review our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed information on how to get involved. You can also share your feedback and ideas through our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you πŸ™ to all our contributors for their dedication and support!
We deeply value contributions from the open-source community to enhance Ultralytics projects. Your input helps drive innovation in [computer vision](https://www.ultralytics.com/glossary/computer-vision-cv) and [AI](https://www.ultralytics.com/glossary/artificial-intelligence-ai)! Please review our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) for detailed information on how to get involved. You can also share your feedback and ideas through our quick [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A heartfelt thank you πŸ™ to all our contributors for their dedication and support!

![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)
[![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)

We look forward to your contributions!

## πŸ“œ License

Ultralytics Docs are available under two licensing options to accommodate different usage scenarios:

- **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts involved in academic pursuits and open collaboration. See the [LICENSE](https://github.com/ultralytics/docs/blob/main/LICENSE) file for full details. This license promotes sharing improvements back with the community.
- **Enterprise License**: Designed for commercial applications, this license allows seamless integration of Ultralytics software and [AI models](https://docs.ultralytics.com/models/) into commercial products and services. Visit [Ultralytics Licensing](https://www.ultralytics.com/license) for more information on obtaining an Enterprise License.
- **AGPL-3.0 License**: Ideal for students, researchers, and enthusiasts involved in academic pursuits and open collaboration. See the [LICENSE](https://github.com/ultralytics/docs/blob/main/LICENSE) file for full details. This license promotes sharing improvements back with the community, fostering an open and collaborative environment.
- **Enterprise License**: Designed for commercial applications, this license allows seamless integration of Ultralytics software and [AI models](https://docs.ultralytics.com/models/) into commercial products and services without the open-source requirements of AGPL-3.0. Visit [Ultralytics Licensing](https://www.ultralytics.com/license) for more information on obtaining an Enterprise License.

## βœ‰οΈ Contact

For bug reports, feature requests, and other issues related to the documentation, please use [GitHub Issues](https://github.com/ultralytics/docs/issues). For discussions, questions, and community support, join the conversation with peers and the Ultralytics team on our [Discord server](https://discord.com/invite/ultralytics)!
For bug reports, feature requests, and other issues related to the documentation, please use [GitHub Issues](https://github.com/ultralytics/docs/issues). For discussions, questions, and community support regarding Ultralytics software, [Ultralytics HUB](https://docs.ultralytics.com/hub/), and more, join the conversation with peers and the Ultralytics team on our [Discord server](https://discord.com/invite/ultralytics)!

<br>
<div align="center">
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-pp-yoloe.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ DAMO-YOLO is particularly effective in scenarios demanding high detection accura

- **High-Precision Object Detection**: Applications requiring meticulous object detection, such as detailed [industrial inspection](https://www.ultralytics.com/solutions/ai-in-manufacturing) or [medical image analysis](https://www.ultralytics.com/glossary/medical-image-analysis).
- **Surveillance and Security**: Scenarios where accurate detection of small or occluded objects is critical for effective monitoring and security.
- **Autonomous Driving**: Applications like [self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving) where precise environmental perception is crucial for safety and navigation.
- **Autonomous Driving**: Applications like [self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive) where precise environmental perception is crucial for safety and navigation.

[Learn more about DAMO-YOLO](https://github.com/tinyvision/DAMO-YOLO){ .md-button }

Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-rtdetr.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ As indicated in the comparison table below, RTDETRv2 models offer impressive mAP

RTDETRv2 is ideally suited for applications where high accuracy is paramount and sufficient computational resources are available. These include:

- **Autonomous Vehicles:** For reliable and precise perception of the environment. Learn more about [AI in self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving).
- **Autonomous Vehicles:** For reliable and precise perception of the environment. Learn more about [AI in self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive).
- **Robotics:** Enabling robots to accurately interact with and manipulate objects in complex settings. Explore the role of [AI in Robotics](https://www.ultralytics.com/blog/from-algorithms-to-automation-ais-role-in-robotics).
- **Medical Imaging:** For precise detection of anomalies in medical images, aiding in diagnostics. Discover more about [AI in Healthcare](https://www.ultralytics.com/solutions/ai-in-healthcare).
- **High-Resolution Image Analysis:** Applications requiring detailed analysis of large images, such as satellite imagery or industrial inspection. See how to [analyse satellite imagery using computer vision](https://www.ultralytics.com/blog/using-computer-vision-to-analyse-satellite-imagery).
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-yolo11.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ As shown in the comparison table, YOLO11 offers a range of models (n, s, m, l, x

YOLO11 excels in applications requiring real-time object detection, such as:

- **Autonomous systems**: [Self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving), robotics.
- **Autonomous systems**: [Self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive), robotics.
- **Security and surveillance**: [Security alarm systems](https://docs.ultralytics.com/guides/security-alarm-system/), [theft prevention](https://www.ultralytics.com/blog/computer-vision-for-theft-prevention-enhancing-security).
- **Industrial automation**: Quality control in [manufacturing](https://www.ultralytics.com/solutions/ai-in-manufacturing), [recycling efficiency](https://www.ultralytics.com/blog/recycling-efficiency-the-power-of-vision-ai-in-automated-sorting).
- **Retail analytics**: [Inventory management](https://www.ultralytics.com/blog/ai-for-smarter-retail-inventory-management), [customer behavior analysis](https://www.ultralytics.com/blog/achieving-retail-efficiency-with-ai).
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-yolov10.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ YOLOv10 excels in both speed and accuracy:
YOLOv10 is ideally suited for applications where real-time performance and efficiency are paramount:

- **Edge AI Applications**: Deployment on edge devices like [Raspberry Pi](https://docs.ultralytics.com/guides/raspberry-pi/) and [NVIDIA Jetson](https://docs.ultralytics.com/guides/nvidia-jetson/) for real-time processing.
- **High-Throughput Video Processing**: Applications requiring rapid analysis of video streams, such as [traffic monitoring](https://www.ultralytics.com/blog/ai-in-traffic-management-from-congestion-to-coordination/) and [queue management](https://docs.ultralytics.com/guides/queue-management/).
- **High-Throughput Video Processing**: Applications requiring rapid analysis of video streams, such as [traffic monitoring](https://www.ultralytics.com/blog/ai-in-traffic-management-from-congestion-to-coordination) and [queue management](https://docs.ultralytics.com/guides/queue-management/).
- **Mobile and Web Deployments**: Object detection in web and mobile applications where low latency is critical.

[Learn more about YOLOv10](https://docs.ultralytics.com/models/yolov10/){ .md-button }
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-yolov5.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,7 @@ Ultralytics YOLOv5, developed by Glenn Jocher and Ultralytics, is renowned for i

- **Real-time Object Detection:** Ideal for applications requiring rapid detection, such as robotics, security systems, and autonomous vehicles.
- **Edge Deployment:** Smaller YOLOv5 models are well-suited for deployment on resource-constrained edge devices like [Raspberry Pi](https://docs.ultralytics.com/guides/raspberry-pi/) and [NVIDIA Jetson](https://docs.ultralytics.com/guides/nvidia-jetson/).
- **Industrial Automation:** Applications in manufacturing and quality control where speed and reliability are crucial, such as automating [recycling efficiency](https://www.ultralytics.com/blog/recycling-efficiency-the-power-of-vision-ai-in-automated-sorting/).
- **Industrial Automation:** Applications in manufacturing and quality control where speed and reliability are crucial, such as automating [recycling efficiency](https://www.ultralytics.com/blog/recycling-efficiency-the-power-of-vision-ai-in-automated-sorting).

**Authors and Information:**

Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-yolov7.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ DAMO-YOLO offers various model sizes (tiny, small, medium, large), each providin

DAMO-YOLO is well-suited for applications that require a balance of high accuracy and real-time performance:

- **Autonomous Driving**: Object detection is crucial in [self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving) for perceiving the environment in real-time.
- **Autonomous Driving**: Object detection is crucial in [self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive) for perceiving the environment in real-time.
- **Robotics**: For tasks like navigation and object manipulation in [robotics](https://www.ultralytics.com/glossary/robotics) applications, fast and accurate detection is essential.
- **Surveillance Systems**: In [security systems](https://www.ultralytics.com/blog/security-alarm-system-projects-with-ultralytics-yolov8), real-time object detection is vital for timely threat detection.
- **Industrial Inspection**: For [manufacturing quality control](https://www.ultralytics.com/solutions/ai-in-manufacturing), DAMO-YOLO can be used for fast defect detection.
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/damo-yolo-vs-yolov8.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ YOLOv8 is designed to strike a balance between speed and accuracy. Performance m
YOLOv8 is ideally suited for applications demanding real-time object detection, such as:

- **Real-time Analytics**: For [queue management](https://docs.ultralytics.com/guides/queue-management/), [traffic monitoring](https://www.ultralytics.com/blog/ultralytics-yolov8-for-smarter-parking-management-systems), and [security systems](https://www.ultralytics.com/blog/security-alarm-system-projects-with-ultralytics-yolov8).
- **Autonomous Navigation**: In [robotics](https://www.ultralytics.com/glossary/robotics) and [self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving).
- **Autonomous Navigation**: In [robotics](https://www.ultralytics.com/glossary/robotics) and [self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive).
- **Industrial Quality Control**: For [manufacturing quality control](https://www.ultralytics.com/solutions/ai-in-manufacturing) and [automation](https://www.ultralytics.com/blog/recycling-efficiency-the-power-of-vision-ai-in-automated-sorting).

[Learn more about YOLOv8](https://docs.ultralytics.com/models/yolov8/){ .md-button }
Expand Down
4 changes: 2 additions & 2 deletions docs/en/compare/efficientdet-vs-rtdetr.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ EfficientDet is well-suited for applications where efficiency and good accuracy

- **Mobile Applications:** Deployment on smartphones and tablets where computational resources are limited. [Edge AI](https://www.ultralytics.com/glossary/edge-ai)
- **Edge Devices:** Running object detection on edge devices like Raspberry Pi or NVIDIA Jetson for real-time processing. [NVIDIA Jetson](https://docs.ultralytics.com/guides/nvidia-jetson/)
- **Real-time Systems:** Applications requiring fast inference, such as robotics and surveillance. [AI in Robotics](https://www.ultralytics.com/solutions/ai-in-self-driving)
- **Real-time Systems:** Applications requiring fast inference, such as robotics and surveillance. [AI in Robotics](https://www.ultralytics.com/solutions/ai-in-automotive)
- **Resource-Constrained Environments:** Scenarios where computational resources are limited or cost-sensitive.

[Learn more about EfficientDet](https://github.com/google/automl/tree/master/efficientdet#readme){ .md-button }
Expand Down Expand Up @@ -85,7 +85,7 @@ RTDETRv2 models, particularly larger variants like RTDETRv2-x, achieve impressiv

RTDETRv2 is ideally suited for applications where top-tier accuracy is paramount and sufficient computational resources are available:

- **Autonomous Vehicles:** For reliable and precise environmental perception in self-driving systems. [AI in self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving)
- **Autonomous Vehicles:** For reliable and precise environmental perception in self-driving systems. [AI in self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive)
- **Advanced Robotics:** Enabling robots to perform complex tasks requiring accurate object recognition and interaction. [From Algorithms to Automation: AI's Role in Robotics](https://www.ultralytics.com/blog/from-algorithms-to-automation-ais-role-in-robotics)
- **High-Precision Medical Imaging:** For critical applications in medical diagnostics where accuracy is essential. [AI in Healthcare](https://www.ultralytics.com/solutions/ai-in-healthcare)
- **Detailed Surveillance Systems:** Scenarios requiring high accuracy in monitoring and analysis. [Shattering the Surveillance Status Quo with Vision AI](https://www.ultralytics.com/blog/shattering-the-surveillance-status-quo-with-vision-ai)
Expand Down
2 changes: 1 addition & 1 deletion docs/en/compare/efficientdet-vs-yolo11.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ YOLO11's speed and accuracy make it suitable for numerous real-time applications
- **Robotics**: Enabling navigation and object interaction in dynamic settings.
- **Security Systems**: Enhancing [security alarm systems](https://docs.ultralytics.com/guides/security-alarm-system/) for intrusion detection.
- **Industrial Automation**: Supporting quality control and defect detection in manufacturing.
- **Autonomous Vehicles**: Contributing to real-time perception in [self-driving cars](https://www.ultralytics.com/solutions/ai-in-self-driving).
- **Autonomous Vehicles**: Contributing to real-time perception in [self-driving cars](https://www.ultralytics.com/solutions/ai-in-automotive).

**Strengths:**

Expand Down
Loading
Loading