Merge branch 'ultralytics:master' into master

.github/ISSUE_TEMPLATE/bug-report.yml

@@ -62,7 +62,7 @@ body:
  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://stackoverflow.com/help/minimal-reproducible-example).
+ 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
@@ -80,6 +80,6 @@ body:
  label: Are you willing to submit a PR?
  description: >
  (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/yolov5/pulls) (PR) to help improve YOLOv5 for everyone, especially if you have a good understanding of how to implement a fix or feature.
- See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started.
+ See the YOLOv5 [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/feature-request.yml

@@ -45,6 +45,6 @@ body:
  label: Are you willing to submit a PR?
  description: >
  (Optional) We encourage you to submit a [Pull Request](https://github.com/ultralytics/yolov5/pulls) (PR) to help improve YOLOv5 for everyone, especially if you have a good understanding of how to implement a fix or feature.
- See the YOLOv5 [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) to get started.
+ See the YOLOv5 [Contributing Guide](https://docs.ultralytics.com/help/contributing) to get started.
  options:
  - label: Yes I'd like to help by submitting a PR!

.github/PULL_REQUEST_TEMPLATE.md

@@ -5,7 +5,7 @@ Thank you for submitting a YOLOv5 🚀 Pull Request! We want to make contributin
 - Link this PR to a YOLOv5 [issue](https://github.com/ultralytics/yolov5/issues) to help us understand what bug fix or feature is being implemented.
 - Provide before and after profiling/inference/training results to help us quantify the improvement your PR provides (if applicable).
 
-Please see our ✅ [Contributing Guide](https://github.com/ultralytics/yolov5/blob/master/CONTRIBUTING.md) for more details.
+Please see our ✅ [Contributing Guide](https://docs.ultralytics.com/help/contributing) for more details.
 
 Note that Copilot will summarize this PR below, do not modify the 'copilot:all' line.
 -->

.github/workflows/ci-testing.yml

@@ -45,14 +45,6 @@ jobs:
  python detect.py --weights ${{ matrix.model }}.onnx --img 320
  python segment/predict.py --weights ${{ matrix.model }}-seg.onnx --img 320
  python classify/predict.py --weights ${{ matrix.model }}-cls.onnx --img 224
- - name: Notify on failure
- if: failure() && github.repository == 'ultralytics/yolov5' && (github.event_name == 'schedule' || github.event_name == 'push')
- uses: slackapi/[email protected]
- with:
- payload: |
- {"text": "<!channel> GitHub Actions error 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:* ${{ github.event_name }}\n*Job Status:* ${{ job.status }}\n"}
- env:
- SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_YOLO }}
 
  Tests:
  timeout-minutes: 60
@@ -159,11 +151,17 @@ jobs:
  for path in '$m', '$b':
  model = torch.hub.load('.', 'custom', path=path, source='local')
  EOF
- - name: Notify on failure
- if: failure() && github.repository == 'ultralytics/yolov5' && (github.event_name == 'schedule' || github.event_name == 'push')
- uses: slackapi/[email protected]
+
+ Summary:
+ runs-on: ubuntu-latest
+ needs: [Benchmarks, Tests] # Add job names that you want to check for failure
+ if: always() # This ensures the job runs even if previous jobs fail
+ steps:
+ - name: Check for failure and notify
+ if: (needs.Benchmarks.result == 'failure' || needs.Tests.result == 'failure') && github.repository == 'ultralytics/yolov5' && (github.event_name == 'schedule' || github.event_name == 'push')
+ uses: slackapi/[email protected]
  with:
  payload: |
- {"text": "<!channel> GitHub Actions error 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:* ${{ github.event_name }}\n*Job Status:* ${{ job.status }}\n"}
+ {"text": "<!channel> GitHub Actions error 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:* ${{ github.event_name }}\n"}
  env:
  SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL_YOLO }}

.github/workflows/codeql-analysis.yml

@@ -6,6 +6,7 @@ name: "CodeQL"
 on:
  schedule:
  - cron: '0 0 1 * *' # Runs at 00:00 UTC on the 1st of every month
+ workflow_dispatch:
 
 jobs:
  analyze:

.github/workflows/docker.yml

@@ -6,6 +6,7 @@ name: Publish Docker Images
 on:
  push:
  branches: [ master ]
+ workflow_dispatch:
 
 jobs:
  docker:

.github/workflows/links.yml

@@ -1,13 +1,10 @@
 # Ultralytics YOLO 🚀, AGPL-3.0 license
-# YOLO Continuous Integration (CI) GitHub Actions tests
+# YOLO Continuous Integration (CI) GitHub Actions tests broken link checker
+# Accept 429(Instagram, 'too many requests'), 999(LinkedIn, 'unknown status code'), Timeout(Twitter)
 
 name: Check Broken links
 
 on:
- push:
- branches: [master]
- pull_request:
- branches: [master]
  workflow_dispatch:
  schedule:
  - cron: '0 0 * * *' # runs at 00:00 UTC every day
@@ -18,21 +15,26 @@ jobs:
  steps:
  - uses: actions/checkout@v3
 
- - name: Test Markdown and HTML links
- uses: lycheeverse/[email protected]
+ - name: Download and install lychee
+ run: |
+ LYCHEE_URL=$(curl -s https://api.github.com/repos/lycheeverse/lychee/releases/latest | grep "browser_download_url" | grep "x86_64-unknown-linux-gnu.tar.gz" | cut -d '"' -f 4)
+ curl -L $LYCHEE_URL -o lychee.tar.gz
+ tar xzf lychee.tar.gz
+ sudo mv lychee /usr/local/bin
+
+ - name: Test Markdown and HTML links with retry
+ uses: nick-invision/retry@v2
  with:
- fail: true
- # accept 429(Instagram, 'too many requests'), 999(LinkedIn, 'unknown status code'), Timeout(Twitter)
- args: --accept 429,999 --exclude-loopback --exclude twitter.com --exclude-path '**/ci-testing.yaml' --exclude-mail './**/*.md' './**/*.html'
- env:
- GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+ timeout_minutes: 5
+ retry_wait_seconds: 60
+ max_attempts: 3
+ command: lychee --accept 429,999 --exclude-loopback --exclude 'https?://(www\.)?(twitter\.com|instagram\.com)' --exclude-path '**/ci.yaml' --exclude-mail --github-token ${{ secrets.GITHUB_TOKEN }} './**/*.md' './**/*.html'
 
- - name: Test Markdown, HTML, YAML, Python and Notebook links
+ - name: Test Markdown, HTML, YAML, Python and Notebook links with retry
  if: github.event_name == 'workflow_dispatch'
- uses: lycheeverse/[email protected]
+ uses: nick-invision/retry@v2
  with:
- fail: true
- # accept 429(Instagram, 'too many requests'), 999(LinkedIn, 'unknown status code'), Timeout(Twitter)
- args: --accept 429,999 --exclude-loopback --exclude twitter.com,url.com --exclude-path '**/ci-testing.yaml' --exclude-mail './**/*.md' './**/*.html' './**/*.yml' './**/*.yaml' './**/*.py' './**/*.ipynb'
- env:
- GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}
+ timeout_minutes: 5
+ retry_wait_seconds: 60
+ max_attempts: 3
+ command: lychee --accept 429,999 --exclude-loopback --exclude 'https?://(www\.)?(twitter\.com|instagram\.com|url\.com)' --exclude-path '**/ci.yaml' --exclude-mail --github-token ${{ secrets.GITHUB_TOKEN }} './**/*.md' './**/*.html' './**/*.yml' './**/*.yaml' './**/*.py' './**/*.ipynb'

.pre-commit-config.yaml

@@ -22,7 +22,7 @@ repos:
  - id: detect-private-key
 
  - repo: https://github.com/asottile/pyupgrade
- rev: v3.3.1
+ rev: v3.3.2
  hooks:
  - id: pyupgrade
  name: Upgrade code
@@ -35,7 +35,7 @@ repos:
  name: Sort imports
 
  - repo: https://github.com/google/yapf
- rev: v0.32.0
+ rev: v0.33.0
  hooks:
  - id: yapf
  name: YAPF formatting

CONTRIBUTING.md

@@ -66,7 +66,7 @@ short guidelines below to help users provide what we need to get started.
 
 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 [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example). Your code that reproduces
+a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/). Your code that reproduces
 the problem should be:
 
 - ✅ **Minimal** – Use as little code as possible that still produces the same problem
@@ -84,7 +84,7 @@ should be:
 
 If you believe your problem meets all of the above criteria, please close this issue and raise a new one using the 🐛
 **Bug Report** [template](https://github.com/ultralytics/yolov5/issues/new/choose) and provide
-a [minimum reproducible example](https://stackoverflow.com/help/minimal-reproducible-example) to help us better
+a [minimum reproducible example](https://docs.ultralytics.com/help/minimum_reproducible_example/) to help us better
 understand and diagnose your problem.
 
 ## License

README.md

@@ -20,7 +20,9 @@
 
 YOLOv5 🚀 is the world's most loved vision AI, representing <a href="https://ultralytics.com">Ultralytics</a> open-source research into future vision AI methods, incorporating lessons learned and best practices evolved over thousands of hours of research and development.
 
-To request an Enterprise License please complete the form at <a href="https://ultralytics.com/license">Ultralytics Licensing</a>.
+We hope that the resources here will help you get the most out of YOLOv5. Please browse the YOLOv5 <a href="https://docs.ultralytics.com/yolov5">Docs</a> for details, raise an issue on <a href="https://github.com/ultralytics/yolov5/issues/new/choose">GitHub</a> for support, and join our <a href="https://discord.gg/n6cFeSPZdD">Discord</a> community for questions and discussions!
+
+To request an Enterprise License please complete the form at [Ultralytics Licensing](https://ultralytics.com/license).
 
 <div align="center">
  <a href="https://github.com/ultralytics" style="text-decoration:none;">
@@ -40,6 +42,9 @@ To request an Enterprise License please complete the form at <a href="https://ul
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
  <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="2%" alt="" /></a>
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
+ <a href="https://discord.gg/n6cFeSPZdD" style="text-decoration:none;">
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="2%" alt="" /></a>
 </div>
 
 </div>
@@ -445,7 +450,7 @@ Get started in seconds with our verified environments. Click each icon below for
 
 ## <div align="center">Contribute</div>
 
-We love your input! We want to make contributing to YOLOv5 as easy and transparent as possible. Please see our [Contributing Guide](CONTRIBUTING.md) to get started, and fill out the [YOLOv5 Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) to send us feedback on your experiences. Thank you to all our contributors!
+We love your input! We want to make contributing to YOLOv5 as easy and transparent as possible. Please see our [Contributing Guide](https://docs.ultralytics.com/help/contributing/) to get started, and fill out the [YOLOv5 Survey](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) to send us feedback on your experiences. Thank you to all our contributors!
 
 <!-- SVG image from https://opencollective.com/ultralytics/contributors.svg?width=990 -->
 
@@ -461,7 +466,7 @@ YOLOv5 is available under two different licenses:
 
 ## <div align="center">Contact</div>
 
-For YOLOv5 bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/yolov5/issues) or the [Ultralytics Community Forum](https://community.ultralytics.com/).
+For YOLOv5 bug reports and feature requests please visit [GitHub Issues](https://github.com/ultralytics/yolov5/issues), and join our [Discord](https://discord.gg/n6cFeSPZdD) community for questions and discussions!
 
 <br>
 <div align="center">
@@ -482,6 +487,9 @@ For YOLOv5 bug reports and feature requests please visit [GitHub Issues](https:/
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
  <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="" /></a>
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
+ <a href="https://discord.gg/n6cFeSPZdD" style="text-decoration:none;">
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="3%" alt="" /></a>
 </div>
 
 [tta]: https://docs.ultralytics.com/yolov5/tutorials/test_time_augmentation

README.zh-CN.md

@@ -19,7 +19,9 @@
 
 YOLOv5 🚀 是世界上最受欢迎的视觉 AI，代表<a href="https://ultralytics.com"> Ultralytics </a>对未来视觉 AI 方法的开源研究，结合在数千小时的研究和开发中积累的经验教训和最佳实践。
 
-如果要申请企业许可证，请填写表格<a href="https://ultralytics.com/license">Ultralytics 许可</a>.
+我们希望这里的资源能帮助您充分利用 YOLOv5。请浏览 YOLOv5 <a href="https://docs.ultralytics.com/">文档</a> 了解详细信息，在 <a href="https://github.com/ultralytics/yolov5/issues/new/choose">GitHub</a> 上提交问题以获得支持，并加入我们的 <a href="https://discord.gg/n6cFeSPZdD">Discord</a> 社区进行问题和讨论！
+
+如需申请企业许可，请在 [Ultralytics Licensing](https://ultralytics.com/license) 处填写表格
 
 <div align="center">
  <a href="https://github.com/ultralytics" style="text-decoration:none;">
@@ -39,6 +41,9 @@ YOLOv5 🚀 是世界上最受欢迎的视觉 AI，代表<a href="https://ultral
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
  <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="2%" alt="" /></a>
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="2%" alt="" />
+ <a href="https://discord.gg/n6cFeSPZdD" style="text-decoration:none;">
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="2%" alt="" /></a>
 </div>
 </div>
 
@@ -440,7 +445,7 @@ python export.py --weights yolov5s-cls.pt resnet50.pt efficientnet_b0.pt --inclu
 
 ## <div align="center">贡献</div>
 
-我们喜欢您的意见或建议！我们希望尽可能简单和透明地为 YOLOv5 做出贡献。请看我们的 [投稿指南](CONTRIBUTING.md)，并填写 [YOLOv5调查](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) 向我们发送您的体验反馈。感谢我们所有的贡献者！
+我们喜欢您的意见或建议！我们希望尽可能简单和透明地为 YOLOv5 做出贡献。请看我们的 [投稿指南](https://docs.ultralytics.com/help/contributing/)，并填写 [YOLOv5调查](https://ultralytics.com/survey?utm_source=github&utm_medium=social&utm_campaign=Survey) 向我们发送您的体验反馈。感谢我们所有的贡献者！
 
 <!-- SVG image from https://opencollective.com/ultralytics/contributors.svg?width=990 -->
 
@@ -456,7 +461,7 @@ YOLOv5 在两种不同的 License 下可用：
 
 ## <div align="center">联系我们</div>
 
-请访问 [GitHub Issues](https://github.com/ultralytics/yolov5/issues) 或 [Ultralytics Community Forum](https://community.ultralytics.com) 以报告 YOLOv5 错误和请求功能。
+对于 YOLOv5 的错误报告和功能请求，请访问 [GitHub Issues](https://github.com/ultralytics/yolov5/issues)，并加入我们的 [Discord](https://discord.gg/n6cFeSPZdD) 社区进行问题和讨论！
 
 <br>
 <div align="center">
@@ -477,6 +482,9 @@ YOLOv5 在两种不同的 License 下可用：
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
  <a href="https://www.instagram.com/ultralytics/" style="text-decoration:none;">
  <img src="https://github.com/ultralytics/assets/raw/main/social/logo-social-instagram.png" width="3%" alt="" /></a>
+ <img src="https://github.com/ultralytics/assets/raw/main/social/logo-transparent.png" width="3%" alt="" />
+ <a href="https://discord.gg/n6cFeSPZdD" style="text-decoration:none;">
+ <img src="https://github.com/ultralytics/assets/blob/main/social/logo-social-discord.png" width="3%" alt="" /></a>
 </div>
 
 [tta]: https://docs.ultralytics.com/yolov5/tutorials/test_time_augmentation

classify/predict.py

@@ -217,7 +217,7 @@ def parse_opt():
 
 
 def main(opt):
- check_requirements(exclude=('tensorboard', 'thop'))
+ check_requirements(ROOT / 'requirements.txt', exclude=('tensorboard', 'thop'))
  run(**vars(opt))
 
 

classify/train.py

@@ -300,7 +300,7 @@ def main(opt):
  if RANK in {-1, 0}:
  print_args(vars(opt))
  check_git_status()
- check_requirements()
+ check_requirements(ROOT / 'requirements.txt')
 
  # DDP mode
  device = select_device(opt.device, batch_size=opt.batch_size)

classify/tutorial.ipynb

@@ -1255,16 +1255,17 @@
  "outputs": [],
  "source": [
  "#@title Select YOLOv5 🚀 logger {run: 'auto'}\n",
- "logger = 'TensorBoard' #@param ['TensorBoard', 'Comet', 'ClearML']\n",
+ "logger = 'Comet' #@param ['Comet', 'ClearML', 'TensorBoard']\n",
  "\n",
- "if logger == 'TensorBoard':\n",
- " %load_ext tensorboard\n",
- " %tensorboard --logdir runs/train\n",
- "elif logger == 'Comet':\n",
+ "if logger == 'Comet':\n",
  " %pip install -q comet_ml\n",
  " import comet_ml; comet_ml.init()\n",
  "elif logger == 'ClearML':\n",
- " import clearml; clearml.browser_login()"
+ " %pip install -q clearml\n",
+ " import clearml; clearml.browser_login()\n",
+ "elif logger == 'TensorBoard':\n",
+ " %load_ext tensorboard\n",
+ " %tensorboard --logdir runs/train"
  ]
  },
  {

classify/val.py

@@ -161,7 +161,7 @@ def parse_opt():
 
 
 def main(opt):
- check_requirements(exclude=('tensorboard', 'thop'))
+ check_requirements(ROOT / 'requirements.txt', exclude=('tensorboard', 'thop'))
  run(**vars(opt))
 
 

data/Objects365.yaml

@@ -388,7 +388,7 @@ download: |
 
  from utils.general import Path, check_requirements, download, np, xyxy2xywhn
 
- check_requirements(('pycocotools>=2.0',))
+ check_requirements('pycocotools>=2.0')
  from pycocotools.coco import COCO
 
  # Make Directories

detect.py

@@ -252,7 +252,7 @@ def parse_opt():
 
 
 def main(opt):
- check_requirements(exclude=('tensorboard', 'thop'))
+ check_requirements(ROOT / 'requirements.txt', exclude=('tensorboard', 'thop'))
  run(**vars(opt))