ultralytics/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.

🛠️ Installation

To install the ultralytics 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.

🚀 Building and Serving Locally

Full Build (Recommended)

The build_docs.py script runs the full documentation build pipeline — the same process used for production deployments. It renders Jinja macros, generates API reference pages, pulls in model comparison pages, and applies HTML postprocessing.

# Requires Python >= 3.10
pip install -e '.[dev]'

cd docs
python build_docs.py

The script builds the site into the site/ directory and automatically serves it at http://localhost:8000. Press CTRL+C to stop.

Quick Preview

For quick edits to pages that don't use {% include %} macros, you can use zensical serve for faster iteration with live reloading:

zensical serve

Note that zensical serve does not render Jinja macros or include compare pages, so some pages (train, predict, val, export, tasks, and others) will display raw {% include %} tags instead of their actual content. Use the full build above to verify these pages.

📤 Deploying Your Documentation Site

Documentation is automatically built and deployed to docs.ultralytics.com via the CI pipeline in .github/workflows/docs.yml on every push to main.

💡 Contribute

We deeply value contributions from the open-source community to enhance Ultralytics projects. Your input helps drive innovation! Please review our Contributing Guide for detailed information on how to get involved. You can also share your feedback and ideas through our 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.
• Enterprise License: Designed for commercial applications, this license allows seamless integration of Ultralytics software and AI models into commercial products and services. 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, join the conversation with peers and the Ultralytics team on our Discord server!