Welcome to the Ultralytics Handbook repository! This repository houses the source files for the official Ultralytics Handbook - your comprehensive guide to our mission, vision, values, and operational practices. Zensical validates and previews the content locally; Ultralytics' centralized publishing service renders and deploys the production site.
This Handbook serves as a living document, evolving alongside Ultralytics' growth. It aims to align team members, contributors, and the wider community with the core principles guiding our work in artificial intelligence (AI) and computer vision. Whether you're new to Ultralytics or a seasoned team member, this resource provides insights into everything from our company philosophy to detailed workflows and operational processes, including our approach to machine learning operations (MLOps).
New team members? Start with our Onboarding Guide for your first 90 days roadmap.
- Zensical - Modern static site generator (by the creators of Material for MkDocs)
- Ultralytics Chat - Realtime conversational AI with open-source chat.js implementation
- Ultralytics publishing service - Production rendering and deployment
- GitHub Actions - CI/CD automation
The Handbook supports the broader Ultralytics ecosystem, including the core Ultralytics Python package:
To build and develop the Handbook locally, install dependencies:
uv pip install -r requirements.txtThis installs Zensical, the local preview and validation tool used in CI.
Build and serve the Handbook locally with live reload:
zensical serveThe site will be available at http://127.0.0.1:8000. Changes to source files trigger automatic rebuilds. The local preview intentionally omits production-owned banners, analytics, and other site chrome.
zensical serve- Start development server with live reloadzensical build --strict- Validate all content and fail on warnings
After validation, every push to main triggers the production publisher through a deploy hook. A daily scheduled run provides a backstop.
We welcome contributions to the Ultralytics Handbook! Your input helps keep our documentation accurate, comprehensive, and useful.
- Fork the repository and create a feature branch
- Make your changes to Markdown files in
docs/en/ - Test locally with
zensical serve - Submit a pull request with clear description of changes
- Follow our style guide (consistent with existing pages)
- Use clear, concise language aligned with the handbook's professional tone
- Follow the existing structure and formatting (120-character lines, emoji usage)
- Include proper frontmatter (description and keywords) on all pages
- Test all internal links and ensure proper navigation
- Use tables, admonitions, and formatting consistently with other pages
See our Contributing Guide for detailed information.
handbook/
├── docs/
│ └── en/ # Handbook source content
├── .github/
│ └── workflows/ # CI/CD automation
├── mkdocs.yml # Transitional Zensical-compatible content manifest
├── requirements.txt # Zensical validation dependency
└── README.md # This file
Ultralytics offers two licensing options:
- AGPL-3.0 License: Ideal for students, researchers, and enthusiasts passionate about open collaboration. This OSI-approved open-source license promotes transparency and community involvement. See the LICENSE file for details.
- Enterprise License: For commercial applications, this license permits seamless integration of Ultralytics software into commercial products, bypassing AGPL-3.0 copyleft requirements. Inquire about an Ultralytics Enterprise License.
For bug reports and feature requests related to the Ultralytics Handbook, please visit GitHub Issues. For questions, discussions, and community support, join our active communities on Discord, Reddit, and the Ultralytics Community Forums. We're here to help with all things Ultralytics!
