docs

📚 Ultralytics Docs

Welcome to Ultralytics Docs, your comprehensive resource for understanding and utilizing our state-of-the-art machine learning tools and models, including Ultralytics YOLO. These documents are actively maintained and deployed to https://docs.ultralytics.com for easy access.

🛠️ Ultralytics Package

The badges above track the core ultralytics Python package documented by this site. To install that package in developer mode, which allows you to modify the source code directly, ensure you have Git and Python 3.8 or later installed on your system. Then, follow these steps:

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

   git clone https://github.com/ultralytics/ultralytics.git
   

2. Navigate to the cloned repository’s root directory:

   cd ultralytics
   

3. Install the package in editable mode (-e) along with its development dependencies ([dev]) using pip:

   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 and contributing.

🧰 Technology Stack

• Next.js - Framework that renders the published documentation site
• Ultralytics Chat - Realtime conversational AI with open-source chat.js implementation
• Vercel - Hosting and deployment
• GitHub Actions - CI/CD automation

🔧 Repository Tooling

This repository contains documentation source plus maintenance workflows for published-site checks. Install the lightweight Python dependencies before running repository utilities locally:

uv pip install -r requirements.txt

For example, utils/check_image_sizes.py is used by the website link-check workflow to flag oversized images in downloaded pages.

🌍 Website Checks

The live documentation at docs.ultralytics.com is maintained with scheduled and manual workflows in .github/workflows/:

• links.yml downloads rendered pages for www.ultralytics.com, docs.ultralytics.com, academy.ultralytics.com, and handbook.ultralytics.com, then checks links, spelling, and large images.
• links_local.yml checks repository Markdown and HTML links, with an optional broader link scan on manual runs.
• download_websites.yml can download public website pages for inspection.

Production combines this repository’s content with the other documentation sources, validates the complete tree with zensical build --strict, and renders it through Ultralytics’ centralized publishing service. This repository therefore has no standalone site build; use the workflows above to check published pages.

💡 Contribute

We deeply value contributions from the open-source community to enhance Ultralytics projects. Your input helps drive innovation in computer vision and AI! Please review our Contributing Guide for detailed information on how to get involved. You can also share your feedback and ideas through our quick Survey. A heartfelt thank you 🙏 to all our contributors for their dedication and support!

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 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 into commercial products and services without the open-source requirements of AGPL-3.0. Visit Ultralytics Licensing 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. For discussions, questions, and community support regarding Ultralytics software, the Ultralytics Platform, and more, join the conversation with peers and the Ultralytics team on our Discord server!