{"id":19454122,"url":"https://github.com/ultralytics/docs","last_synced_at":"2025-07-11T12:34:03.660Z","repository":{"id":103258137,"uuid":"600207364","full_name":"ultralytics/docs","owner":"ultralytics","description":"Ultralytics Docs at https://docs.ultralytics.com","archived":false,"fork":false,"pushed_at":"2025-07-05T10:16:09.000Z","size":901771,"stargazers_count":60,"open_issues_count":2,"forks_count":6,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-07-05T11:27:28.318Z","etag":null,"topics":["docs","documentation","guides","hub","quickstart","tutorials","ultralytics","yolo","yolov10","yolov8","yolov9"],"latest_commit_sha":null,"homepage":"https://docs.ultralytics.com","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ultralytics.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"glenn-jocher","patreon":"ultralytics","open_collective":"ultralytics"}},"created_at":"2023-02-10T20:35:32.000Z","updated_at":"2025-07-04T00:16:10.000Z","dependencies_parsed_at":null,"dependency_job_id":"6fb7df4e-58b4-430f-878d-acc7fd6a2c8e","html_url":"https://github.com/ultralytics/docs","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/ultralytics/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ultralytics","download_url":"https://codeload.github.com/ultralytics/docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ultralytics%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264806685,"owners_count":23666674,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docs","documentation","guides","hub","quickstart","tutorials","ultralytics","yolo","yolov10","yolov8","yolov9"],"created_at":"2024-11-10T17:08:02.775Z","updated_at":"2025-07-11T12:34:03.641Z","avatar_url":"https://github.com/ultralytics.png","language":null,"readme":"\u003ca href=\"https://www.ultralytics.com/\" target=\"_blank\"\u003e\u003cimg src=\"https://raw.githubusercontent.com/ultralytics/assets/main/logo/Ultralytics_Logotype_Original.svg\" width=\"320\" alt=\"Ultralytics logo\"\u003e\u003c/a\u003e\n\n# 📚 Ultralytics Docs\n\nWelcome to Ultralytics Docs, your comprehensive resource for understanding and utilizing our state-of-the-art [machine learning](https://www.ultralytics.com/glossary/machine-learning-ml) tools and models, including [Ultralytics YOLO](https://docs.ultralytics.com/models/yolov8/). These documents are actively maintained and deployed to [https://docs.ultralytics.com](https://docs.ultralytics.com/) for easy access.\n\n[![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)\n[![Check Broken links](https://github.com/ultralytics/docs/actions/workflows/links.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/links.yml)\n[![Check Domains](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml)\n\n[![Ultralytics Actions](https://github.com/ultralytics/docs/actions/workflows/format.yml/badge.svg)](https://github.com/ultralytics/docs/actions/workflows/format.yml)\n[![Ultralytics Discord](https://img.shields.io/discord/1089800235347353640?logo=discord\u0026logoColor=white\u0026label=Discord\u0026color=blue)](https://discord.com/invite/ultralytics)\n[![Ultralytics Forums](https://img.shields.io/discourse/users?server=https%3A%2F%2Fcommunity.ultralytics.com\u0026logo=discourse\u0026label=Forums\u0026color=blue)](https://community.ultralytics.com/)\n[![Ultralytics Reddit](https://img.shields.io/reddit/subreddit-subscribers/ultralytics?style=flat\u0026logo=reddit\u0026logoColor=white\u0026label=Reddit\u0026color=blue)](https://reddit.com/r/ultralytics)\n\n## 🛠️ Installation\n\n[![PyPI - Version](https://img.shields.io/pypi/v/ultralytics?logo=pypi\u0026logoColor=white)](https://pypi.org/project/ultralytics/)\n[![Downloads](https://static.pepy.tech/badge/ultralytics)](https://www.pepy.tech/projects/ultralytics)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/ultralytics?logo=python\u0026logoColor=gold)](https://pypi.org/project/ultralytics/)\n\nTo 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:\n\n1.  Clone the `ultralytics` repository to your local machine using Git:\n\n    ```bash\n    git clone https://github.com/ultralytics/ultralytics.git\n    ```\n\n2.  Navigate to the cloned repository's root directory:\n\n    ```bash\n    cd ultralytics\n    ```\n\n3.  Install the package in editable mode (`-e`) along with its development dependencies (`[dev]`) using [pip](https://pip.pypa.io/en/stable/installation/):\n\n    ```bash\n    pip install -e '.[dev]'\n    ```\n\n    This command installs the `ultralytics` package such that changes to the source code are immediately reflected in your environment, ideal for development and contributing.\n\n## 🚀 Building and Serving Locally\n\nThe `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.\n\n```bash\nmkdocs serve\n```\n\n- **Command Breakdown:**\n  - `mkdocs`: The main MkDocs command-line interface tool.\n  - `serve`: The subcommand used to build and locally serve your documentation site.\n- **Note:**\n  - `mkdocs serve` includes live reloading, automatically updating the preview in your browser as you save changes to the documentation files.\n  - To stop the local server, simply press `CTRL+C` in your terminal.\n\n## 🌍 Building and Serving Multi-Language\n\nIf your documentation supports multiple languages, follow these steps to build and preview all versions:\n\n1.  Stage all new or modified language Markdown (`.md`) files using Git:\n\n    ```bash\n    git add docs/**/*.md -f\n    ```\n\n2.  Build all language versions into the `/site` directory. This script ensures that relevant root-level files are included and clears the previous build:\n\n    ```bash\n    # Clear existing /site directory to prevent conflicts\n    rm -rf site\n\n    # Build the default language site using the primary config file\n    mkdocs build -f docs/mkdocs.yml\n\n    # Loop through each language-specific config file and build its site\n    for file in docs/mkdocs_*.yml; do\n      echo \"Building MkDocs site with $file\"\n      mkdocs build -f \"$file\"\n    done\n    ```\n\n3.  To preview the complete multi-language site locally, navigate into the build output directory and start a simple [Python HTTP server](https://docs.python.org/3/library/http.server.html):\n    ```bash\n    cd site\n    python -m http.server\n    # Open http://localhost:8000 in your preferred web browser\n    ```\n    Access the live preview site at `http://localhost:8000`.\n\n## 📤 Deploying Your Documentation Site\n\nTo 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/).\n\n- Configure deployment settings within your `mkdocs.yml` file.\n- Use the `mkdocs deploy` command specific to your chosen provider to build and deploy your site.\n\n* **GitHub Pages Deployment Example:**\n  If deploying to GitHub Pages, you can use the built-in command:\n\n  ```bash\n  mkdocs gh-deploy\n  ```\n\n  After deployment, you might need to update the \"Custom domain\" settings in your repository's settings page if you wish to use a personalized URL.\n\n  ![GitHub Pages Custom Domain Setting](https://user-images.githubusercontent.com/26833433/210150206-9e86dcd7-10af-43e4-9eb2-9518b3799eac.png)\n\n- For detailed instructions on various deployment methods, consult the official [MkDocs Deploying your docs guide](https://www.mkdocs.org/user-guide/deploying-your-docs/).\n\n## 💡 Contribute\n\nWe 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\u0026utm_medium=social\u0026utm_campaign=Survey). A heartfelt thank you 🙏 to all our contributors for their dedication and support!\n\n[![Ultralytics open-source contributors](https://raw.githubusercontent.com/ultralytics/assets/main/im/image-contributors.png)](https://github.com/ultralytics/ultralytics/graphs/contributors)\n\nWe look forward to your contributions!\n\n## 📜 License\n\nUltralytics Docs are available under two licensing options to accommodate different usage scenarios:\n\n- **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.\n- **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.\n\n## ✉️ Contact\n\nFor 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)!\n\n\u003cbr\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003ca href=\"https://github.com/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-github.png\" width=\"3%\" alt=\"Ultralytics GitHub\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://www.linkedin.com/company/ultralytics/\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-linkedin.png\" width=\"3%\" alt=\"Ultralytics LinkedIn\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://twitter.com/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-twitter.png\" width=\"3%\" alt=\"Ultralytics Twitter\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://youtube.com/ultralytics?sub_confirmation=1\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-youtube.png\" width=\"3%\" alt=\"Ultralytics YouTube\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://www.tiktok.com/@ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-tiktok.png\" width=\"3%\" alt=\"Ultralytics TikTok\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://ultralytics.com/bilibili\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-bilibili.png\" width=\"3%\" alt=\"Ultralytics BiliBili\"\u003e\u003c/a\u003e\n  \u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png\" width=\"3%\" alt=\"space\"\u003e\n  \u003ca href=\"https://discord.com/invite/ultralytics\"\u003e\u003cimg src=\"https://github.com/ultralytics/assets/raw/main/social/logo-social-discord.png\" width=\"3%\" alt=\"Ultralytics Discord\"\u003e\u003c/a\u003e\n\u003c/div\u003e\n","funding_links":["https://github.com/sponsors/glenn-jocher","https://patreon.com/ultralytics","https://opencollective.com/ultralytics"],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultralytics%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fultralytics%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fultralytics%2Fdocs/lists"}