+ - **Google Cloud** Deep Learning VM. See [GCP Quickstart Guide](https://docs.ultralytics.com/yolov5/environments/google_cloud_quickstart_tutorial/)
+ - **Amazon** Deep Learning AMI. See [AWS Quickstart Guide](https://docs.ultralytics.com/yolov5/environments/aws_quickstart_tutorial/)
+ - **Docker Image**. See [Docker Quickstart Guide](https://docs.ultralytics.com/yolov5/environments/docker_image_quickstart_tutorial/) 
+
+ ## Status
+
+ 
+
+ If this badge is green, all [Ultralytics CI](https://github.com/ultralytics/ultralytics/actions/workflows/ci.yml?query=event%3Aschedule) tests are currently passing. CI tests verify correct operation of all YOLO [Modes](https://docs.ultralytics.com/modes/) and [Tasks](https://docs.ultralytics.com/tasks/) on macOS, Windows, and Ubuntu every 24 hours and on every commit.
diff --git a/ultralytics-main/.github/workflows/links.yml b/ultralytics-main/.github/workflows/links.yml
new file mode 100644
index 0000000000000000000000000000000000000000..23645a6559cb8641e45f14dbba38419a09d0c732
--- /dev/null
+++ b/ultralytics-main/.github/workflows/links.yml
@@ -0,0 +1,104 @@
+# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
+
+# Continuous Integration (CI) GitHub Actions tests broken link checker using https://github.com/lycheeverse/lychee
+# Ignores the following status codes to reduce false positives:
+# - 401(Vimeo, 'unauthorized')
+# - 403(OpenVINO, 'forbidden')
+# - 429(Instagram, 'too many requests')
+# - 500(Zenodo, 'cached')
+# - 502(Zenodo, 'bad gateway')
+# - 999(LinkedIn, 'unknown status code')
+
+name: Check Broken links
+
+permissions:
+ contents: read
+
+on:
+ workflow_dispatch:
+ schedule:
+ - cron: "0 0 * * *" # runs at 00:00 UTC every day
+
+jobs:
+ Links:
+ if: github.repository == 'ultralytics/ultralytics'
+ runs-on: ubuntu-latest
+ steps:
+ - uses: actions/checkout@v6
+
+ - name: Install lychee
+ run: curl -sSfL "https://github.com/lycheeverse/lychee/releases/latest/download/lychee-x86_64-unknown-linux-gnu.tar.gz" | sudo tar xz -C /usr/local/bin
+
+ - name: Test Markdown and HTML links with retry
+ uses: ultralytics/actions/retry@main
+ with:
+ timeout_minutes: 60
+ retry_delay_seconds: 1800
+ retries: 2
+ run: |
+ lychee \
+ --scheme https \
+ --timeout 60 \
+ --insecure \
+ --accept 100..=103,200..=299,401,403,429,500,502,999 \
+ --exclude-all-private \
+ --exclude 'https?://(www\.)?(linkedin\.com|twitter\.com|instagram\.com|kaggle\.com|fonts\.gstatic\.com|url\.com)' \
+ --exclude-path docs/zh \
+ --exclude-path docs/es \
+ --exclude-path docs/ru \
+ --exclude-path docs/pt \
+ --exclude-path docs/fr \
+ --exclude-path docs/de \
+ --exclude-path docs/ja \
+ --exclude-path docs/ko \
+ --exclude-path docs/hi \
+ --exclude-path docs/ar \
+ --github-token ${{ secrets.GITHUB_TOKEN }} \
+ --header "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.183 Safari/537.36" \
+ './**/*.md' \
+ './**/*.html' | tee -a $GITHUB_STEP_SUMMARY
+
+ # Raise error if broken links found
+ if ! grep -q "0 Errors" $GITHUB_STEP_SUMMARY; then
+ exit 1
+ fi
+
+ - name: Test Markdown, HTML, YAML, Python and Notebook links with retry
+ if: github.event_name == 'workflow_dispatch'
+ uses: ultralytics/actions/retry@main
+ with:
+ timeout_minutes: 60
+ retry_delay_seconds: 1800
+ retries: 2
+ run: |
+ lychee \
+ --scheme https \
+ --timeout 60 \
+ --insecure \
+ --accept 100..=103,200..=299,401,403,429,500,502,999 \
+ --exclude-all-private \
+ --exclude 'https?://(www\.)?(linkedin\.com|twitter\.com|instagram\.com|kaggle\.com|fonts\.gstatic\.com|url\.com)' \
+ --exclude-path './**/ci.yml' \
+ --exclude-path docs/zh \
+ --exclude-path docs/es \
+ --exclude-path docs/ru \
+ --exclude-path docs/pt \
+ --exclude-path docs/fr \
+ --exclude-path docs/de \
+ --exclude-path docs/ja \
+ --exclude-path docs/ko \
+ --exclude-path docs/hi \
+ --exclude-path docs/ar \
+ --github-token ${{ secrets.GITHUB_TOKEN }} \
+ --header "User-Agent: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/126.0.6478.183 Safari/537.36" \
+ './**/*.md' \
+ './**/*.html' \
+ './**/*.yml' \
+ './**/*.yaml' \
+ './**/*.py' \
+ './**/*.ipynb' | tee -a $GITHUB_STEP_SUMMARY
+
+ # Raise error if broken links found
+ if ! grep -q "0 Errors" $GITHUB_STEP_SUMMARY; then
+ exit 1
+ fi
diff --git a/ultralytics-main/.github/workflows/merge-main-into-prs.yml b/ultralytics-main/.github/workflows/merge-main-into-prs.yml
new file mode 100644
index 0000000000000000000000000000000000000000..54fcb420de31d63168136b807dcbe6f500421a91
--- /dev/null
+++ b/ultralytics-main/.github/workflows/merge-main-into-prs.yml
@@ -0,0 +1,91 @@
+# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
+
+# Automatically merges repository 'main' branch into all open PRs to keep them up-to-date
+# Action runs on updates to main branch so when one PR merges to main all others update
+
+name: Merge main into PRs
+
+on:
+ workflow_dispatch:
+ # push:
+ # branches:
+ # - ${{ github.event.repository.default_branch }}
+
+permissions:
+ contents: write # Modify code in PRs
+
+jobs:
+ Merge:
+ if: github.repository == 'ultralytics/ultralytics'
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout repository
+ uses: actions/checkout@v6
+ with:
+ fetch-depth: 0
+ - uses: actions/setup-python@v6
+ with:
+ python-version: "3.x"
+ cache: "pip"
+ - name: Install requirements
+ run: |
+ pip install pygithub
+ - name: Merge default branch into PRs
+ shell: python
+ run: |
+ from github import Github
+ import os
+ import time
+
+ g = Github("${{ secrets._GITHUB_TOKEN }}")
+ repo = g.get_repo("${{ github.repository }}")
+
+ # Fetch the default branch name
+ default_branch_name = repo.default_branch
+ default_branch = repo.get_branch(default_branch_name)
+
+ # Initialize counters
+ updated_branches = 0
+ up_to_date_branches = 0
+ errors = 0
+
+ for pr in repo.get_pulls(state='open', sort='created'):
+ try:
+ # Label PRs as popular for positive reactions
+ reactions = pr.as_issue().get_reactions()
+ if sum([(1 if r.content not in {"-1", "confused"} else 0) for r in reactions]) > 5:
+ pr.set_labels(*("popular",) + tuple(l.name for l in pr.get_labels()))
+
+ # Get full names for repositories and branches
+ base_repo_name = repo.full_name
+ head_repo_name = pr.head.repo.full_name
+ base_branch_name = pr.base.ref
+ head_branch_name = pr.head.ref
+
+ # Check if PR is behind the default branch
+ comparison = repo.compare(default_branch.commit.sha, pr.head.sha)
+ if comparison.behind_by > 0:
+ print(f"⚠️ PR #{pr.number} ({head_repo_name}:{head_branch_name} -> {base_repo_name}:{base_branch_name}) is behind {default_branch_name} by {comparison.behind_by} commit(s).")
+
+ # Attempt to update the branch
+ try:
+ success = pr.update_branch()
+ assert success, "Branch update failed"
+ print(f"✅ Successfully merged '{default_branch_name}' into PR #{pr.number} ({head_repo_name}:{head_branch_name} -> {base_repo_name}:{base_branch_name}).")
+ updated_branches += 1
+ time.sleep(10) # rate limit merges
+ except Exception as update_error:
+ print(f"❌ Could not update PR #{pr.number} ({head_repo_name}:{head_branch_name} -> {base_repo_name}:{base_branch_name}): {update_error}")
+ errors += 1
+ else:
+ print(f"✅ PR #{pr.number} ({head_repo_name}:{head_branch_name} -> {base_repo_name}:{base_branch_name}) is already up to date with {default_branch_name}, no merge required.")
+ up_to_date_branches += 1
+ except Exception as e:
+ print(f"❌ Could not process PR #{pr.number}: {e}")
+ errors += 1
+
+ # Print summary
+ print("\n\nSummary:")
+ print(f"Branches updated: {updated_branches}")
+ print(f"Branches already up-to-date: {up_to_date_branches}")
+ print(f"Total errors: {errors}")
diff --git a/ultralytics-main/.github/workflows/mirror.yml b/ultralytics-main/.github/workflows/mirror.yml
new file mode 100644
index 0000000000000000000000000000000000000000..6fb89cd31342d30738af2a2638363e32361234b8
--- /dev/null
+++ b/ultralytics-main/.github/workflows/mirror.yml
@@ -0,0 +1,46 @@
+# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
+
+# This action mirrors the Ultralytics repository to other platforms like GitLab.
+# It runs only when the main branch is updated by the repository owner.
+# Additional platforms can be added by uncommenting the relevant sections.
+
+name: Mirror Repository
+
+permissions:
+ contents: read
+
+on:
+ # push:
+ # branches:
+ # - main
+ workflow_dispatch:
+
+jobs:
+ mirror:
+ runs-on: ubuntu-latest
+ if: github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher'
+ steps:
+ - name: Checkout Source Repository (${{ github.repository }})
+ uses: actions/checkout@v6
+ with:
+ fetch-depth: 0 # Fetch all history for mirroring
+ - name: Run Git Config
+ run: |
+ git config --global user.name "UltralyticsAssistant"
+ git config --global user.email "web@ultralytics.com"
+ - name: Push to DagsHub
+ run: |
+ git remote add dagshub https://glenn-jocher:${{ secrets.DAGSHUB_TOKEN }}@dagshub.com/Ultralytics/ultralytics.git
+ git push dagshub main --force
+ # - name: Push to Gitee
+ # run: |
+ # git remote add gitee https://ultralytics:${{ secrets.GITEE_TOKEN }}@gitee.com/ultralytics/ultralytics.git
+ # git push gitee main --force
+ # - name: Push to GitCode
+ # run: |
+ # git remote add gitcode https://ultralytics:${{ secrets.GITCODE_TOKEN }}@gitcode.net/ultralytics/ultralytics.git
+ # git push gitcode main --force
+ # - name: Push to Bitbucket
+ # run: |
+ # git remote add bitbucket https://ultralytics:${{ secrets.BITBUCKET_APP_PASSWORD }}@bitbucket.org/ultralytics/ultralytics.git
+ # git push bitbucket main --force
diff --git a/ultralytics-main/.github/workflows/publish.yml b/ultralytics-main/.github/workflows/publish.yml
new file mode 100644
index 0000000000000000000000000000000000000000..79aaddf3b979c82e64a7cb7ba6993965c873388b
--- /dev/null
+++ b/ultralytics-main/.github/workflows/publish.yml
@@ -0,0 +1,153 @@
+# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license
+
+# Publish pip package to PyPI https://pypi.org/project/ultralytics/
+
+name: Publish to PyPI
+
+on:
+ push:
+ branches: [main]
+ workflow_dispatch:
+ inputs:
+ pypi:
+ type: boolean
+ description: Publish to PyPI
+
+jobs:
+ check:
+ if: github.repository == 'ultralytics/ultralytics' && github.actor == 'glenn-jocher'
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ outputs:
+ increment: ${{ steps.check_pypi.outputs.increment }}
+ current_tag: ${{ steps.check_pypi.outputs.current_tag }}
+ previous_tag: ${{ steps.check_pypi.outputs.previous_tag }}
+ steps:
+ - uses: actions/checkout@v6
+ - uses: actions/setup-python@v6
+ with:
+ python-version: "3.x"
+ - uses: astral-sh/setup-uv@v7
+ - run: uv pip install --system --no-cache ultralytics-actions
+ - id: check_pypi
+ shell: python
+ run: |
+ import os
+ from actions.utils import check_pypi_version
+ local_version, online_version, publish = check_pypi_version()
+ os.system(f'echo "increment={publish}" >> $GITHUB_OUTPUT')
+ os.system(f'echo "current_tag=v{local_version}" >> $GITHUB_OUTPUT')
+ os.system(f'echo "previous_tag=v{online_version}" >> $GITHUB_OUTPUT')
+ if publish:
+ print('Ready to publish new version to PyPI ✅.')
+ - name: Tag and Release
+ if: steps.check_pypi.outputs.increment == 'True'
+ env:
+ GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ CURRENT_TAG: ${{ steps.check_pypi.outputs.current_tag }}
+ PREVIOUS_TAG: ${{ steps.check_pypi.outputs.previous_tag }}
+ OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+ run: |
+ git config --global user.name "UltralyticsAssistant"
+ git config --global user.email "web@ultralytics.com"
+ git tag -a "$CURRENT_TAG" -m "$(git log -1 --pretty=%B)"
+ git push origin "$CURRENT_TAG"
+ ultralytics-actions-summarize-release
+ uv cache prune --ci
+
+ build:
+ needs: check
+ if: needs.check.outputs.increment == 'True'
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ steps:
+ - uses: actions/checkout@v6
+ - uses: actions/setup-python@v6
+ with:
+ python-version: "3.x"
+ - uses: astral-sh/setup-uv@v7
+ - run: uv pip install --system --no-cache build
+ - run: python -m build
+ - uses: actions/upload-artifact@v5
+ with:
+ name: dist
+ path: dist/
+ - run: uv cache prune --ci
+
+ publish:
+ needs: [check, build]
+ if: needs.check.outputs.increment == 'True'
+ runs-on: ubuntu-latest
+ environment: # for GitHub Deployments tab
+ name: Release - PyPI
+ url: https://pypi.org/p/ultralytics
+ permissions:
+ id-token: write # for PyPI trusted publishing
+ steps:
+ - uses: actions/download-artifact@v6
+ with:
+ name: dist
+ path: dist/
+ - uses: pypa/gh-action-pypi-publish@release/v1
+
+ sbom:
+ needs: [check, build, publish]
+ if: needs.check.outputs.increment == 'True'
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ steps:
+ - uses: actions/checkout@v6
+ - uses: actions/setup-python@v6
+ with:
+ python-version: "3.x"
+ - uses: astral-sh/setup-uv@v7
+ - run: |
+ uv venv sbom-env
+ uv pip install -e .
+ env:
+ VIRTUAL_ENV: sbom-env
+ - uses: anchore/sbom-action@v0
+ with:
+ format: spdx-json
+ output-file: sbom.spdx.json
+ path: sbom-env
+ - run: gh release upload ${{ needs.check.outputs.current_tag }} sbom.spdx.json
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+ notify:
+ needs: [check, publish]
+ if: always() && needs.check.outputs.increment == 'True'
+ runs-on: ubuntu-latest
+ permissions:
+ contents: read
+ steps:
+ - uses: actions/checkout@v6
+ - name: Extract PR Details
+ env:
+ GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+ run: |
+ PR_JSON=$(gh pr list --search "${GITHUB_SHA}" --state merged --json number,title --jq '.[0]')
+ PR_NUMBER=$(echo "${PR_JSON}" | jq -r '.number')
+ PR_TITLE=$(echo "${PR_JSON}" | jq -r '.title' | sed 's/"/\\"/g')
+ echo "PR_NUMBER=${PR_NUMBER}" >> "${GITHUB_ENV}"
+ echo "PR_TITLE=${PR_TITLE}" >> "${GITHUB_ENV}"
+ - name: Notify Success
+ if: needs.publish.result == 'success' && github.event_name == 'push'
+ uses: slackapi/slack-github-action@v2.1.1
+ with:
+ webhook-type: incoming-webhook
+ webhook: ${{ secrets.SLACK_WEBHOOK_URL_YOLO }}
+ payload: |
+ text: " GitHub Actions success for ${{ github.workflow }} ✅\n\n\n*Repository:* https://github.com/${{ github.repository }}\n*Action:* https://github.com/${{ github.repository }}/actions/runs/${{ github.run_id }}\n*Author:* ${{ github.actor }}\n*Event:* NEW `${{ github.repository }} ${{ needs.check.outputs.current_tag }}` pip package published 😃\n*Job Status:* ${{ job.status }}\n*Pull Request:* 
+
+# Contributing to Ultralytics Open-Source Projects
+
+Welcome! We're thrilled that you're considering contributing to our [Ultralytics](https://www.ultralytics.com/) [open-source](https://github.com/ultralytics) projects. Your involvement not only helps enhance the quality of our repositories but also benefits the entire [computer vision](https://www.ultralytics.com/glossary/computer-vision-cv) community. This guide provides clear guidelines and best practices to help you get started.
+
+[](https://github.com/ultralytics/ultralytics/graphs/contributors)
+
+## 🤝 Code of Conduct
+
+To ensure a welcoming and inclusive environment for everyone, all contributors must adhere to our [Code of Conduct](https://docs.ultralytics.com/help/code-of-conduct/). **Respect**, **kindness**, and **professionalism** are at the heart of our community.
+
+## 🚀 Contributing via Pull Requests
+
+We greatly appreciate contributions in the form of [pull requests (PRs)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). To make the review process as smooth as possible, please follow these steps:
+
+1. **[Fork the repository](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/working-with-forks/fork-a-repo):** Start by forking the relevant Ultralytics repository (e.g., [ultralytics/ultralytics](https://github.com/ultralytics/ultralytics)) to your GitHub account.
+2. **[Create a branch](https://docs.github.com/en/desktop/making-changes-in-a-branch/managing-branches-in-github-desktop):** Create a new branch in your forked repository with a clear, descriptive name reflecting your changes (e.g., `fix-issue-123`, `add-feature-xyz`).
+3. **Make your changes:** Implement your improvements or fixes. Ensure your code adheres to the project's style guidelines and doesn't introduce new errors or warnings.
+4. **Test your changes:** Before submitting, test your changes locally to confirm they work as expected and don't cause [regressions](https://en.wikipedia.org/wiki/Software_regression). Add tests if you're introducing new functionality.
+5. **[Commit your changes](https://docs.github.com/en/desktop/making-changes-in-a-branch/committing-and-reviewing-changes-to-your-project-in-github-desktop):** Commit your changes with concise and descriptive commit messages. If your changes address a specific issue, include the issue number (e.g., `Fix #123: Corrected calculation error.`).
+6. **[Create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request):** Submit a pull request from your branch to the `main` branch of the original Ultralytics repository. Provide a clear title and a detailed description explaining the purpose and scope of your changes.
+
+### 📝 CLA Signing
+
+Before we can merge your pull request, you must sign our [Contributor License Agreement (CLA)](https://docs.ultralytics.com/help/CLA/). This legal agreement ensures that your contributions are properly licensed, allowing the project to continue being distributed under the [AGPL-3.0 license](https://www.ultralytics.com/legal/agpl-3-0-software-license).
+
+After submitting your pull request, the CLA bot will guide you through the signing process. To sign the CLA, simply add a comment in your PR stating:
+
+```text
+I have read the CLA Document and I sign the CLA
+```
+
+### ✍️ Google-Style Docstrings
+
+When adding new functions or classes, please include [Google-style docstrings](https://google.github.io/styleguide/pyguide.html). These docstrings provide clear, standardized documentation that helps other developers understand and maintain your code.
+
+#### Example Google-style
+
+This example illustrates a Google-style docstring. Ensure that both input and output `types` are always enclosed in parentheses, e.g., `(bool)`.
+
+```python
+def example_function(arg1, arg2=4):
+ """Example function demonstrating Google-style docstrings.
+
+ Args:
+ arg1 (int): The first argument.
+ arg2 (int): The second argument, with a default value of 4.
+
+ Returns:
+ (bool): True if successful, False otherwise.
+
+ Examples:
+ >>> result = example_function(1, 2) # returns False
+ """
+ if arg1 == arg2:
+ return True
+ return False
+```
+
+#### Example Google-style with type hints
+
+This example includes both a Google-style docstring and [type hints](https://docs.python.org/3/library/typing.html) for arguments and returns, though using either independently is also acceptable.
+
+```python
+def example_function(arg1: int, arg2: int = 4) -> bool:
+ """Example function demonstrating Google-style docstrings.
+
+ Args:
+ arg1: The first argument.
+ arg2: The second argument, with a default value of 4.
+
+ Returns:
+ True if successful, False otherwise.
+
+ Examples:
+ >>> result = example_function(1, 2) # returns False
+ """
+ if arg1 == arg2:
+ return True
+ return False
+```
+
+#### Example Single-line
+
+For smaller or simpler functions, a single-line docstring may be sufficient. The docstring must use three double-quotes, be a complete sentence, start with a capital letter, and end with a period.
+
+```python
+def example_small_function(arg1: int, arg2: int = 4) -> bool:
+ """Example function with a single-line docstring."""
+ return arg1 == arg2
+```
+
+### ✅ GitHub Actions CI Tests
+
+All pull requests must pass the [GitHub Actions](https://github.com/features/actions) [Continuous Integration](https://docs.ultralytics.com/help/CI/) (CI) tests before they can be merged. These tests include linting, unit tests, and other checks to ensure that your changes meet the project's quality standards. Review the CI output and address any issues that arise.
+
+## ✨ Best Practices for Code Contributions
+
+When contributing code to Ultralytics projects, keep these best practices in mind:
+
+- **Avoid code duplication:** Reuse existing code wherever possible and minimize unnecessary arguments.
+- **Make smaller, focused changes:** Focus on targeted modifications rather than large-scale changes.
+- **Simplify when possible:** Look for opportunities to simplify the code or remove unnecessary parts.
+- **Consider compatibility:** Before making changes, consider whether they might break existing code using Ultralytics.
+- **Use consistent formatting:** Tools like [Ruff Formatter](https://github.com/astral-sh/ruff) can help maintain stylistic consistency.
+- **Add appropriate tests:** Include [tests](https://docs.ultralytics.com/guides/model-testing/) for new features to ensure they work as expected.
+
+## 👀 Reviewing Pull Requests
+
+Reviewing pull requests is another valuable way to contribute. When reviewing PRs:
+
+- **Check for unit tests:** Verify that the PR includes tests for new features or changes.
+- **Review documentation updates:** Ensure [documentation](https://docs.ultralytics.com/) is updated to reflect changes.
+- **Evaluate performance impact:** Consider how changes might affect [performance](https://docs.ultralytics.com/guides/yolo-performance-metrics/).
+- **Verify CI tests:** Confirm all [Continuous Integration tests](https://docs.ultralytics.com/help/CI/) are passing.
+- **Provide constructive feedback:** Offer specific, clear feedback about any issues or concerns.
+- **Recognize effort:** Acknowledge the author's work to maintain a positive collaborative atmosphere.
+
+## 🐞 Reporting Bugs
+
+We highly value bug reports as they help us improve the quality and reliability of our projects. When reporting a bug via [GitHub Issues](https://github.com/ultralytics/ultralytics/issues):
+
+- **Check existing issues:** Search first to see if the bug has already been reported.
+- **Provide a [Minimum Reproducible Example](https://docs.ultralytics.com/help/minimum-reproducible-example/):** Create a small, self-contained code snippet that consistently reproduces the issue. This is crucial for efficient debugging.
+- **Describe the environment:** Specify your operating system, Python version, relevant library versions (e.g., [`torch`](https://pytorch.org/), [`ultralytics`](https://github.com/ultralytics/ultralytics)), and hardware ([CPU](https://en.wikipedia.org/wiki/Central_processing_unit)/[GPU](https://www.ultralytics.com/glossary/gpu-graphics-processing-unit)).
+- **Explain expected vs. actual behavior:** Clearly state what you expected to happen and what actually occurred. Include any error messages or tracebacks.
+
+## 📜 License
+
+Ultralytics uses the [GNU Affero General Public License v3.0 (AGPL-3.0)](https://www.ultralytics.com/legal/agpl-3-0-software-license) for its repositories. This license promotes [openness](https://en.wikipedia.org/wiki/Openness), [transparency](https://www.ultralytics.com/glossary/transparency-in-ai), and [collaborative improvement](https://en.wikipedia.org/wiki/Collaborative_software) in software development. It ensures that all users have the freedom to use, modify, and share the software, fostering a strong community of collaboration and innovation.
+
+We encourage all contributors to familiarize themselves with the terms of the [AGPL-3.0 license](https://opensource.org/license/agpl-v3) to contribute effectively and ethically to the Ultralytics open-source community.
+
+## 🌍 Open-Sourcing Your YOLO Project Under AGPL-3.0
+
+Using Ultralytics YOLO models or code in your project? The [AGPL-3.0 license](https://opensource.org/license/agpl-v3) requires that your entire derivative work also be open-sourced under AGPL-3.0. This ensures modifications and larger projects built upon open-source foundations remain open.
+
+### Why AGPL-3.0 Compliance Matters
+
+- **Keeps Software Open:** Ensures that improvements and derivative works benefit the community.
+- **Legal Requirement:** Using AGPL-3.0 licensed code binds your project to its terms.
+- **Fosters Collaboration:** Encourages sharing and transparency.
+
+If you prefer not to open-source your project, consider obtaining an [Enterprise License](https://www.ultralytics.com/license).
+
+### How to Comply with AGPL-3.0
+
+Complying means making the **complete corresponding source code** of your project publicly available under the AGPL-3.0 license.
+
+1. **Choose Your Starting Point:**
+ - **Fork Ultralytics YOLO:** Directly fork the [Ultralytics YOLO repository](https://github.com/ultralytics/ultralytics) if building closely upon it.
+ - **Use Ultralytics Template:** Start with the [Ultralytics template repository](https://github.com/ultralytics/template) for a clean, modular setup integrating YOLO.
+
+2. **License Your Project:**
+ - Add a `LICENSE` file containing the full text of the [AGPL-3.0 license](https://opensource.org/license/agpl-v3).
+ - Add a notice at the top of each source file indicating the license.
+
+3. **Publish Your Source Code:**
+ - Make your **entire project's source code** publicly accessible (e.g., on GitHub). This includes:
+ - The complete larger application or system that incorporates the YOLO model or code.
+ - Any modifications made to the original Ultralytics YOLO code.
+ - Scripts for training, validation, inference.
+ - [Model weights](https://www.ultralytics.com/glossary/model-weights) if modified or fine-tuned.
+ - [Configuration files](https://docs.ultralytics.com/usage/cfg/), environment setups (`requirements.txt`, [`Dockerfiles`](https://docs.docker.com/reference/dockerfile/)).
+ - Backend and frontend code if it's part of a [web application](https://en.wikipedia.org/wiki/Web_application).
+ - Any [third-party libraries](
+
+ 
+
+ 
+ 
+ 
+ 
+ 
+
+
+
+ 
+
+
+
+
+ 
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+ 
+
+
+
+
+
+
+## 🤝 Contribute
+
+We thrive on community collaboration! Ultralytics YOLO wouldn't be the SOTA framework it is without contributions from developers like you. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started. We also welcome your feedback—share your experience by completing our [Survey](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey). A huge **Thank You** 🙏 to everyone who contributes!
+
+
+
+[](https://github.com/ultralytics/ultralytics/graphs/contributors)
+
+We look forward to your contributions to help make the Ultralytics ecosystem even better!
+
+## 📜 License
+
+Ultralytics offers two licensing options to suit different needs:
+
+- **AGPL-3.0 License**: This [OSI-approved](https://opensource.org/license/agpl-v3) open-source license is perfect for students, researchers, and enthusiasts. It encourages open collaboration and knowledge sharing. See the [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) file for full details.
+- **Ultralytics Enterprise License**: Designed for commercial use, this license allows for the seamless integration of Ultralytics software and AI models into commercial products and services, bypassing the open-source requirements of AGPL-3.0. If your use case involves commercial deployment, please contact us via [Ultralytics Licensing](https://www.ultralytics.com/license).
+
+## 📞 Contact
+
+For bug reports and feature requests related to Ultralytics software, please visit [GitHub Issues](https://github.com/ultralytics/ultralytics/issues). For questions, discussions, and community support, join our active communities on [Discord](https://discord.com/invite/ultralytics), [Reddit](https://www.reddit.com/r/ultralytics/), and the [Ultralytics Community Forums](https://community.ultralytics.com/). We're here to help with all things Ultralytics!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+## 🤝 贡献
+
+我们依靠社区协作蓬勃发展！没有像您这样的开发者的贡献，Ultralytics YOLO 就不会成为如今最先进的框架。请参阅我们的[贡献指南](https://docs.ultralytics.com/help/contributing/)开始贡献。我们也欢迎您的反馈——通过完成我们的[调查问卷](https://www.ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey)分享您的体验。非常**感谢** 🙏 每一位贡献者！
+
+
+
+[](https://github.com/ultralytics/ultralytics/graphs/contributors)
+
+我们期待您的贡献，帮助 Ultralytics 生态系统变得更好！
+
+## 📜 许可证
+
+Ultralytics 提供两种许可选项以满足不同需求：
+
+- **AGPL-3.0 许可证**：这种经 [OSI 批准](https://opensource.org/license/agpl-v3)的开源许可证非常适合学生、研究人员和爱好者。它鼓励开放协作和知识共享。有关完整详细信息，请参阅 [LICENSE](https://github.com/ultralytics/ultralytics/blob/main/LICENSE) 文件。
+- **Ultralytics 企业许可证**：专为商业用途设计，此许可证允许将 Ultralytics 软件和 AI 模型无缝集成到商业产品和服务中，绕过 AGPL-3.0 的开源要求。如果您的使用场景涉及商业部署，请通过 [Ultralytics 授权许可](https://www.ultralytics.com/license)与我们联系。
+
+## 📞 联系方式
+
+有关 Ultralytics 软件的错误报告和功能请求，请访问 [GitHub Issues](https://github.com/ultralytics/ultralytics/issues)。如有疑问、讨论和社区支持，请加入我们在 [Discord](https://discord.com/invite/ultralytics)、[Reddit](https://www.reddit.com/r/ultralytics/?rdt=44154) 和 [Ultralytics 社区论坛](https://community.ultralytics.com/)上的活跃社区。我们随时为您提供有关 Ultralytics 的所有帮助！
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+# 📚 Ultralytics Docs
+
+Welcome 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/yolo11/). These documents are actively maintained and deployed to [https://docs.ultralytics.com](https://docs.ultralytics.com/) for easy access.
+
+[](https://github.com/ultralytics/docs/actions/workflows/pages/pages-build-deployment)
+[](https://github.com/ultralytics/docs/actions/workflows/links.yml)
+[](https://github.com/ultralytics/docs/actions/workflows/check_domains.yml)
+[](https://github.com/ultralytics/docs/actions/workflows/format.yml)
+
+
+
+## 🛠️ Installation
+
+[](https://pypi.org/project/ultralytics/)
+[](https://clickpy.clickhouse.com/dashboard/ultralytics)
+[](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.8 or later installed on your system. Then, follow these steps:
+
+1. Clone the `ultralytics` repository to your local machine using Git:
+
+ ```bash
+ git clone https://github.com/ultralytics/ultralytics.git
+ ```
+
+2. Navigate to the cloned repository's root directory:
+
+ ```bash
+ cd ultralytics
+ ```
+
+3. Install the package in editable mode (`-e`) along with its development dependencies (`[dev]`) using [pip](https://pip.pypa.io/en/stable/):
+
+ ```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.
+
+## 🚀 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.
+
+```bash
+mkdocs serve
+```
+
+- **Command Breakdown:**
+ - `mkdocs`: The main MkDocs command-line interface tool.
+ - `serve`: The subcommand used to build and locally serve your documentation site.
+- **Note:**
+ - `mkdocs serve` includes live reloading, automatically updating the preview in your browser as you save changes to the documentation files.
+ - To stop the local server, simply press `CTRL+C` in your terminal.
+
+## 🌍 Building and Serving Multi-Language
+
+If your documentation supports multiple languages, follow these steps to build and preview all versions:
+
+1. Stage all new or modified language Markdown (`.md`) files using Git:
+
+ ```bash
+ git add docs/**/*.md -f
+ ```
+
+2. Build all language versions into the `/site` directory. This script ensures that relevant root-level files are included and clears the previous build:
+
+ ```bash
+ # Clear existing /site directory to prevent conflicts
+ rm -rf site
+
+ # Build the default language site using the primary config file
+ mkdocs build -f docs/mkdocs.yml
+
+ # Loop through each language-specific config file and build its site
+ for file in docs/mkdocs_*.yml; do
+ echo "Building MkDocs site with $file"
+ mkdocs build -f "$file"
+ done
+ ```
+
+3. 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):
+ ```bash
+ cd site
+ python -m http.server
+ # Open http://localhost:8000 in your preferred web browser
+ ```
+ Access the live preview site at `http://localhost:8000`.
+
+## 📤 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.
+
+- Configure deployment settings within your `mkdocs.yml` file.
+- Use your hosting provider's recommended workflow (for example running `mkdocs build` in CI or `mkdocs gh-deploy` for GitHub Pages) to publish the generated `site/` directory.
+
+* **GitHub Pages Deployment Example:**
+ If deploying to GitHub Pages, you can use the built-in command:
+
+ ```bash
+ mkdocs gh-deploy
+ ```
+
+ 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.
+
+ 
+
+- For detailed instructions on various deployment methods, consult the official [MkDocs Deploying your docs guide](https://www.mkdocs.org/user-guide/deploying-your-docs/).
+
+## 💡 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 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.
+
+## ✉️ 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)!
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
, ,