Sync fork

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -2,13 +2,13 @@
 
 name: 🐛 Bug Report
 # title: " "
-description: Problems with YOLOv8
+description: Problems with Ultralytics YOLO
 labels: [bug, triage]
 body:
  - type: markdown
  attributes:
  value: |
- Thank you for submitting a YOLOv8 🐛 Bug Report!
+ Thank you for submitting an Ultralytics YOLO 🐛 Bug Report!
 
  - type: checkboxes
  attributes:
@@ -17,14 +17,14 @@ body:
  Please search the Ultralytics [Docs](https://docs.ultralytics.com) and [issues](https://github.com/ultralytics/ultralytics/issues) to see if a similar bug report already exists.
  options:
  - label: >
- I have searched the YOLOv8 [issues](https://github.com/ultralytics/ultralytics/issues) and found no similar bug report.
+ I have searched the Ultralytics YOLO [issues](https://github.com/ultralytics/ultralytics/issues) and found no similar bug report.
  required: true
 
  - type: dropdown
  attributes:
- label: YOLOv8 Component
+ label: Ultralytics YOLO Component
  description: |
- Please select the part of YOLOv8 where you found the bug.
+ Please select the Ultralytics YOLO component where you found the bug.
  multiple: true
  options:
  - "Install"
@@ -43,16 +43,16 @@ body:
  - type: textarea
  attributes:
  label: Bug
- description: Provide console output with error messages and/or screenshots of the bug.
+ description: Please provide as much information as possible. Copy and paste console output and error messages. Use [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to format text, code and logs. If necessary, include screenshots for visual elements only. Providing detailed information will help us resolve the issue more efficiently.
  placeholder: |
- 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response.
+ 💡 ProTip! Include as much information as possible (logs, tracebacks, screenshots, etc.) to receive the most helpful response.
  validations:
  required: true
 
  - type: textarea
  attributes:
  label: Environment
- description: Please specify the software and hardware you used to produce the bug.
+ description: Many issues are often related to dependency versions and hardware. Please provide the output of `yolo checks` or `ultralytics.checks()` command to help us diagnose the problem.
  placeholder: |
  Paste output of `yolo checks` or `ultralytics.checks()` command, i.e.:
  ```
@@ -68,20 +68,19 @@ body:
  CUDA None
  ```
  validations:
- required: false
+ required: true
 
  - type: textarea
  attributes:
  label: Minimal Reproducible Example
  description: >
- When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem.
- This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/).
+ When asking a question, people will be better able to provide help if you provide code that they can easily understand and use to **reproduce** the problem. This is referred to by community members as creating a [minimal reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/).
  placeholder: |
  ```
  # Code to reproduce your issue here
  ```
  validations:
- required: false
+ required: true
 
  - type: textarea
  attributes:
@@ -92,7 +91,7 @@ body:
  attributes:
  label: Are you willing to submit a PR?
  description: >
- (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/ultralytics/pulls) (PR) to help improve YOLOv8 for everyone, especially if you have a good understanding of how to implement a fix or feature.
- See the YOLOv8 [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started.
+ (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/ultralytics/pulls) (PR) to help improve Ultralytics YOLO for everyone, especially if you have a good understanding of how to implement a fix or feature.
+ See the Ultralytics YOLO [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started.
  options:
  - label: Yes I'd like to help by submitting a PR!

.github/ISSUE_TEMPLATE/config.yml

@@ -11,3 +11,6 @@ contact_links:
  - name: 🎧 Discord
  url: https://ultralytics.com/discord
  about: Ask on Ultralytics Discord
+ - name: ⌨️ Reddit
+ url: https://reddit.com/r/ultralytics
+ about: Ask on Ultralytics Subreddit

.github/ISSUE_TEMPLATE/question.yml

@@ -1,14 +1,14 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
 
 name: ❓ Question
-description: Ask a YOLOv8 question
+description: Ask an Ultralytics YOLO question
 # title: " "
 labels: [question]
 body:
  - type: markdown
  attributes:
  value: |
- Thank you for asking a YOLOv8 ❓ Question!
+ Thank you for asking an Ultralytics YOLO ❓ Question!
 
  - type: checkboxes
  attributes:
@@ -17,15 +17,15 @@ body:
  Please search the Ultralytics [Docs](https://docs.ultralytics.com), [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) to see if a similar question already exists.
  options:
  - label: >
- I have searched the YOLOv8 [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) and found no similar questions.
+ I have searched the Ultralytics YOLO [issues](https://github.com/ultralytics/ultralytics/issues) and [discussions](https://github.com/ultralytics/ultralytics/discussions) and found no similar questions.
  required: true
 
  - type: textarea
  attributes:
  label: Question
- description: What is your question?
+ description: What is your question? Please provide as much information as possible. Include detailed code examples to reproduce the problem and describe the context in which the issue occurs. Format your text and code using [Markdown](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) for clarity and readability. Following these guidelines will help us assist you more effectively.
  placeholder: |
- 💡 ProTip! Include as much information as possible (screenshots, logs, tracebacks etc.) to receive the most helpful response.
+ 💡 ProTip! Include as much information as possible (logs, tracebacks, screenshots etc.) to receive the most helpful response.
  validations:
  required: true
 

.github/workflows/ci.yaml

@@ -38,56 +38,6 @@ on:
  type: boolean
 
 jobs:
- Docs:
- # TODO: break this job out into it's own action with pull_request_target to allow changes to user forks
- if: github.repository == 'ultralytics/ultralytics'
- runs-on: macos-14
- steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
- with:
- repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
- token: ${{ secrets.GITHUB_TOKEN }}
- ref: ${{ github.head_ref || github.ref }}
- fetch-depth: 0
- - name: Set up Python
- uses: actions/setup-python@v5
- with:
- python-version: "3.x"
- cache: "pip" # caching pip dependencies
- - name: Install Dependencies
- run: pip install tqdm mkdocs-material "mkdocstrings[python]" mkdocs-jupyter mkdocs-redirects mkdocs-ultralytics-plugin
- - name: Update Docs Reference Section
- run: python docs/build_reference.py
- - name: Commit and Push Reference Section Changes
- run: |
- git pull origin ${{ github.head_ref || github.ref }}
- git add .
- git reset HEAD -- .github/workflows/ # workflow changes are not permitted with default token
- git config --global user.name "UltralyticsAssistant"
- git config --global user.email "[email protected]"
- if ! git diff --staged --quiet; then
- git commit -m "Auto-update Ultralytics Docs Reference Section by https://ultralytics.com/actions"
- git push
- else
- echo "No changes to commit"
- fi
- - name: Build Docs and Check for Warnings
- run: python docs/build_docs.py
- - name: Commit and Push Docs changes
- continue-on-error: true
- if: always() && github.event_name == 'pull_request'
- run: |
- git pull origin ${{ github.head_ref || github.ref }}
- git add --update # only add updated files
- git reset HEAD -- .github/workflows/ # workflow changes are not permitted with default token
- if ! git diff --staged --quiet; then
- git commit -m "Auto-update Ultralytics Docs by https://ultralytics.com/actions"
- git push
- else
- echo "No changes to commit"
- fi
-
  HUB:
  if: github.repository == 'ultralytics/ultralytics' && (github.event_name == 'schedule' || github.event_name == 'push' || (github.event_name == 'workflow_dispatch' && github.event.inputs.hub == 'true'))
  runs-on: ${{ matrix.os }}
@@ -206,7 +156,7 @@ jobs:
  strategy:
  fail-fast: false
  matrix:
- os: [ubuntu-latest, windows-latest, macos-14]
+ os: [ubuntu-latest, macos-14]
  python-version: ["3.11"]
  torch: [latest]
  include:
@@ -336,6 +286,13 @@ jobs:
  channels: conda-forge,defaults
  channel-priority: true
  activate-environment: anaconda-client-env
+ - name: Cleanup toolcache
+ run: |
+ echo "Free space before deletion:"
+ df -h /
+ rm -rf /opt/hostedtoolcache
+ echo "Free space after deletion:"
+ df -h /
  - name: Install Linux packages
  run: |
  # Fix cv2 ImportError: 'libEGL.so.1: cannot open shared object file: No such file or directory'
@@ -361,6 +318,7 @@ jobs:
  yolo val model=yolov8n.pt data=coco8.yaml imgsz=32
  yolo export model=yolov8n.pt format=torchscript imgsz=160
  - name: Test Python
+ # Note this step must use the updated default bash environment, not a python environment
  run: |
  python -c "
  from ultralytics import YOLO

.github/workflows/cla.yml

@@ -26,7 +26,7 @@ jobs:
  steps:
  - name: CLA Assistant
  if: (github.event.comment.body == 'recheck' || github.event.comment.body == 'I have read the CLA Document and I sign the CLA') || github.event_name == 'pull_request_target'
- uses: contributor-assistant/github-action@v2.4.0
+ uses: contributor-assistant/github-action@v2.5.1
  env:
  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  # Must be repository secret PAT

.github/workflows/docker.yaml

@@ -23,6 +23,10 @@ on:
  type: boolean
  description: Use Dockerfile-arm64
  default: true
+ Dockerfile-jetson-jetpack6:
+ type: boolean
+ description: Use Dockerfile-jetson-jetpack6
+ default: true
  Dockerfile-jetson-jetpack5:
  type: boolean
  description: Use Dockerfile-jetson-jetpack5
@@ -50,7 +54,7 @@ jobs:
  runs-on: ubuntu-latest
  strategy:
  fail-fast: false
- max-parallel: 6
+ max-parallel: 10
  matrix:
  include:
  - dockerfile: "Dockerfile"
@@ -62,6 +66,9 @@ jobs:
  - dockerfile: "Dockerfile-arm64"
  tags: "latest-arm64"
  platforms: "linux/arm64"
+ - dockerfile: "Dockerfile-jetson-jetpack6"
+ tags: "latest-jetson-jetpack6"
+ platforms: "linux/arm64"
  - dockerfile: "Dockerfile-jetson-jetpack5"
  tags: "latest-jetson-jetpack5"
  platforms: "linux/arm64"
@@ -75,6 +82,12 @@ jobs:
  # tags: "latest-conda"
  # platforms: "linux/amd64"
  steps:
+ - name: Cleanup disk
+ # Free up to 30GB of disk space per https://github.com/ultralytics/ultralytics/pull/15848
+ uses: jlumbroso/[email protected]
+ with:
+ tool-cache: true
+
  - name: Checkout repo
  uses: actions/checkout@v4
  with:
@@ -126,7 +139,7 @@ jobs:
  uses: nick-invision/retry@v3
  with:
  timeout_minutes: 120
- retry_wait_seconds: 30
+ retry_wait_seconds: 60
  max_attempts: 2 # retry once
  command: |
  docker build \

.github/workflows/docs.yml

@@ -0,0 +1,101 @@
+# Ultralytics YOLO 🚀, AGPL-3.0 license
+# Test and publish docs to https://docs.ultralytics.com
+# Ignores the following Docs rules to match Google-style docstrings:
+# D100: Missing docstring in public module
+# D104: Missing docstring in public package
+# D203: 1 blank line required before class docstring
+# D205: 1 blank line required between summary line and description
+# D212: Multi-line docstring summary should start at the first line
+# D213: Multi-line docstring summary should start at the second line
+# D401: First line of docstring should be in imperative mood
+# D406: Section name should end with a newline
+# D407: Missing dashed underline after section
+# D413: Missing blank line after last section
+
+name: Publish Docs
+
+on:
+ push:
+ branches: [main]
+ pull_request_target:
+ branches: [main]
+ workflow_dispatch:
+
+jobs:
+ Docs:
+ if: github.repository == 'ultralytics/ultralytics'
+ runs-on: macos-14
+ steps:
+ - name: Git config
+ run: |
+ git config --global user.name "UltralyticsAssistant"
+ git config --global user.email "[email protected]"
+ - name: Checkout Repository
+ uses: actions/checkout@v4
+ with:
+ repository: ${{ github.event.pull_request.head.repo.full_name || github.repository }}
+ token: ${{ secrets.PERSONAL_ACCESS_TOKEN || secrets.GITHUB_TOKEN }}
+ ref: ${{ github.head_ref || github.ref }}
+ fetch-depth: 0
+ - name: Set up Python
+ uses: actions/setup-python@v5
+ with:
+ python-version: "3.x"
+ cache: "pip" # caching pip dependencies
+ - name: Install Dependencies
+ run: pip install ruff black tqdm mkdocs-material "mkdocstrings[python]" mkdocs-jupyter mkdocs-redirects mkdocs-ultralytics-plugin mkdocs-macros-plugin
+ - name: Ruff fixes
+ continue-on-error: true
+ run: ruff check --fix --fix-unsafe --select D --ignore=D100,D104,D203,D205,D212,D213,D401,D406,D407,D413 .
+ - name: Update Docs Reference Section and Push Changes
+ if: github.event_name == 'pull_request_target'
+ run: |
+ python docs/build_reference.py
+ git pull origin ${{ github.head_ref || github.ref }}
+ git add .
+ git reset HEAD -- .github/workflows/ # workflow changes are not permitted with default token
+ if ! git diff --staged --quiet; then
+ git commit -m "Auto-update Ultralytics Docs Reference by https://ultralytics.com/actions"
+ git push
+ else
+ echo "No changes to commit"
+ fi
+ - name: Ruff checks
+ run: ruff check --select D --ignore=D100,D104,D203,D205,D212,D213,D401,D406,D407,D413 .
+ - name: Build Docs and Check for Warnings
+ run: |
+ export JUPYTER_PLATFORM_DIRS=1
+ python docs/build_docs.py
+ - name: Commit and Push Docs changes
+ continue-on-error: true
+ if: always() && github.event_name == 'pull_request_target'
+ run: |
+ git pull origin ${{ github.head_ref || github.ref }}
+ git add --update # only add updated files
+ git reset HEAD -- .github/workflows/ # workflow changes are not permitted with default token
+ if ! git diff --staged --quiet; then
+ git commit -m "Auto-update Ultralytics Docs by https://ultralytics.com/actions"
+ git push
+ else
+ echo "No changes to commit"
+ fi
+ - name: Publish Docs to https://docs.ultralytics.com
+ if: github.event_name == 'push'
+ env:
+ PERSONAL_ACCESS_TOKEN: ${{ secrets.PERSONAL_ACCESS_TOKEN }}
+ INDEXNOW_KEY: ${{ secrets.INDEXNOW_KEY_DOCS }}
+ run: |
+ git clone https://github.com/ultralytics/docs.git docs-repo
+ cd docs-repo
+ git checkout gh-pages || git checkout -b gh-pages
+ rm -rf *
+ cp -R ../site/* .
+ echo "$INDEXNOW_KEY" > "$INDEXNOW_KEY.txt"
+ git add .
+ if git diff --staged --quiet; then
+ echo "No changes to commit"
+ else
+ LATEST_HASH=$(git rev-parse --short=7 HEAD)
+ git commit -m "Update Docs for 'ultralytics ${{ steps.check_pypi.outputs.version }} - $LATEST_HASH'"
+ git push https://[email protected]/ultralytics/docs.git gh-pages
+ fi