From 6eff43882de4b6832597340973beead61e444469 Mon Sep 17 00:00:00 2001 From: Ultralytics AI Assistant <135830346+UltralyticsAssistant@users.noreply.github.com> Date: Mon, 1 Jan 2024 22:58:51 +0100 Subject: [PATCH 1/2] Update format.yml (#516) Co-authored-by: glenn-jocher --- .github/workflows/format.yml | 15 +++++++++------ README.md | 3 +-- example_datasets/coco8-pose/README.md | 18 +++++------------- example_datasets/coco8-seg/README.md | 18 +++++------------- example_datasets/coco8/README.md | 18 +++++------------- 5 files changed, 25 insertions(+), 47 deletions(-) diff --git a/.github/workflows/format.yml b/.github/workflows/format.yml index 053645d..27b2c7d 100644 --- a/.github/workflows/format.yml +++ b/.github/workflows/format.yml @@ -1,6 +1,6 @@ -# Ultralytics πŸš€, AGPL-3.0 license -# Ultralytics Format Workflow -# This workflow automatically formats code and documentation in pull requests and pushes to main branch +# Ultralytics πŸš€ - AGPL-3.0 license +# Ultralytics Actions https://github.com/ultralytics/actions +# This workflow automatically formats code and documentation in PRs to official Ultralytics standards name: Ultralytics Actions @@ -14,7 +14,10 @@ jobs: format: runs-on: ubuntu-latest steps: - - name: Checkout Repository - uses: actions/checkout@v4 - - name: Run Ultralytics Formatting Actions + - name: Run Ultralytics Formatting uses: ultralytics/actions@main + with: + python: true + docstrings: true + markdown: true + spelling: true diff --git a/README.md b/README.md index ec6cad4..e56d30e 100644 --- a/README.md +++ b/README.md @@ -91,8 +91,7 @@ Connect to the Ultralytics HUB notebook and employ your model API key to embark ## 🌐 3. Deploy to the Real World -Transition your model to 13 different formats including TensorFlow, ONNX, OpenVINO, CoreML, Paddle, and more. Operate your models directly on your [iOS](https://apps.apple.com/xk/app/ultralytics/id1583935240) or -[Android](https://play.google.com/store/apps/details?id=com.ultralytics.ultralytics_app) mobile device by downloading the [Ultralytics App](https://ultralytics.com/app_install)! +Transition your model to 13 different formats including TensorFlow, ONNX, OpenVINO, CoreML, Paddle, and more. Operate your models directly on your [iOS](https://apps.apple.com/xk/app/ultralytics/id1583935240) or [Android](https://play.google.com/store/apps/details?id=com.ultralytics.ultralytics_app) mobile device by downloading the [Ultralytics App](https://ultralytics.com/app_install)! ## ❓ Have Issues or Questions? diff --git a/example_datasets/coco8-pose/README.md b/example_datasets/coco8-pose/README.md index 2ce8428..5f86fb1 100644 --- a/example_datasets/coco8-pose/README.md +++ b/example_datasets/coco8-pose/README.md @@ -2,14 +2,9 @@ ## Introduction -[Ultralytics](https://ultralytics.com) COCO8-pose is a small, but versatile pose detection dataset composed of the first -8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and -debugging object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough -to be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before -training larger datasets. +[Ultralytics](https://ultralytics.com) COCO8-pose is a small, but versatile pose detection dataset composed of the first 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and debugging object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough to be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training larger datasets. -This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) -and [YOLOv8](https://github.com/ultralytics/ultralytics). +This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) and [YOLOv8](https://github.com/ultralytics/ultralytics). ## Sample Images and Annotations @@ -19,15 +14,12 @@ Here are some examples of images from the dataset, along with their correspondin ## Resources -We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience -with HUB and COCO8-pose. +We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience with HUB and COCO8-pose. - Browse the [Docs](https://docs.ultralytics.com/) for details on usage and implementation. - Raise an issue on [GitHub](https://github.com/ultralytics/hub/issues/new/choose) for support and troubleshooting. -- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and - developers. +- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and developers. - Learn more about Ultralytics and our work at our [Community](https://community.ultralytics.com) page. -- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools - and resources. +- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools and resources. To request an Enterprise License, please complete the form at [Ultralytics Licensing](https://ultralytics.com/license). diff --git a/example_datasets/coco8-seg/README.md b/example_datasets/coco8-seg/README.md index 2c1f07a..5a4bc9b 100644 --- a/example_datasets/coco8-seg/README.md +++ b/example_datasets/coco8-seg/README.md @@ -2,14 +2,9 @@ ## Introduction -[Ultralytics](https://ultralytics.com) COCO8-seg is a small, but versatile instance segmentation dataset composed of the -first 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and -debugging segmentation models, or for experimenting with new detection approaches. With 8 images, it is small enough to -be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training -larger datasets. +[Ultralytics](https://ultralytics.com) COCO8-seg is a small, but versatile instance segmentation dataset composed of the first 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and debugging segmentation models, or for experimenting with new detection approaches. With 8 images, it is small enough to be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training larger datasets. -This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) -and [YOLOv8](https://github.com/ultralytics/ultralytics). +This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) and [YOLOv8](https://github.com/ultralytics/ultralytics). ## Sample Images and Annotations @@ -19,15 +14,12 @@ Here are some examples of images from the dataset, along with their correspondin ## Resources -We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience -with HUB and COCO8-seg. +We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience with HUB and COCO8-seg. - Browse the [Docs](https://docs.ultralytics.com/) for details on usage and implementation. - Raise an issue on [GitHub](https://github.com/ultralytics/hub/issues/new/choose) for support and troubleshooting. -- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and - developers. +- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and developers. - Learn more about Ultralytics and our work at our [Community](https://community.ultralytics.com) page. -- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools - and resources. +- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools and resources. To request an Enterprise License, please complete the form at [Ultralytics Licensing](https://ultralytics.com/license). diff --git a/example_datasets/coco8/README.md b/example_datasets/coco8/README.md index 1cb8583..28f9a31 100644 --- a/example_datasets/coco8/README.md +++ b/example_datasets/coco8/README.md @@ -2,14 +2,9 @@ ## Introduction -[Ultralytics](https://ultralytics.com) COCO8 is a small, but versatile object detection dataset composed of the first 8 -images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and debugging -object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough to be -easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training -larger datasets. +[Ultralytics](https://ultralytics.com) COCO8 is a small, but versatile object detection dataset composed of the first 8 images of the COCO train 2017 set, 4 for training and 4 for validation. This dataset is ideal for testing and debugging object detection models, or for experimenting with new detection approaches. With 8 images, it is small enough to be easily manageable, yet diverse enough to test training pipelines for errors and act as a sanity check before training larger datasets. -This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) -and [YOLOv8](https://github.com/ultralytics/ultralytics). +This dataset is intended for use with Ultralytics [HUB](https://hub.ultralytics.com) and [YOLOv8](https://github.com/ultralytics/ultralytics). ## Sample Images and Annotations @@ -19,15 +14,12 @@ Here are some examples of images from the dataset, along with their correspondin ## Resources -We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience -with HUB and COCO8. +We hope that the variety of resources provided here will help you get the most out of HUB and maximize your experience with HUB and COCO8. - Browse the [Docs](https://docs.ultralytics.com/) for details on usage and implementation. - Raise an issue on [GitHub](https://github.com/ultralytics/hub/issues/new/choose) for support and troubleshooting. -- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and - developers. +- Join our [Discord](https://ultralytics.com/discord) community for questions and discussions with fellow users and developers. - Learn more about Ultralytics and our work at our [Community](https://community.ultralytics.com) page. -- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools - and resources. +- Explore the Ultralytics YOLOv8 [GitHub](https://github.com/ultralytics/ultralytics) repository for additional tools and resources. To request an Enterprise License, please complete the form at [Ultralytics Licensing](https://ultralytics.com/license). From 6b558782630bf1942bf5b500e20af0b660a61e73 Mon Sep 17 00:00:00 2001 From: Glenn Jocher Date: Tue, 2 Jan 2024 11:17:02 +0100 Subject: [PATCH 2/2] Delete .pre-commit-config.yaml (#518) --- .pre-commit-config.yaml | 85 ----------------------------------------- requirements.txt | 3 +- setup.cfg | 65 ------------------------------- 3 files changed, 1 insertion(+), 152 deletions(-) delete mode 100644 .pre-commit-config.yaml delete mode 100644 setup.cfg diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml deleted file mode 100644 index 061d96c..0000000 --- a/.pre-commit-config.yaml +++ /dev/null @@ -1,85 +0,0 @@ -# Ultralytics YOLO πŸš€, AGPL-3.0 license -# Pre-commit hooks. For more information see https://github.com/pre-commit/pre-commit-hooks/blob/main/README.md -# Optionally remove from local hooks with 'rm .git/hooks/pre-commit' - -# exclude: 'docs/' -# Define bot property if installed via https://github.com/marketplace/pre-commit-ci -ci: - autofix_prs: true - autoupdate_commit_msg: '[pre-commit.ci] pre-commit suggestions' - autoupdate_schedule: monthly - # submodules: true - -repos: - - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v4.5.0 - hooks: - - id: end-of-file-fixer - - id: trailing-whitespace - - id: check-case-conflict - # - id: check-yaml - - id: check-docstring-first - - id: double-quote-string-fixer - - id: detect-private-key - - - repo: https://github.com/asottile/pyupgrade - rev: v3.15.0 - hooks: - - id: pyupgrade - name: Upgrade code - - - repo: https://github.com/PyCQA/isort - rev: 5.12.0 - hooks: - - id: isort - name: Sort imports - - - repo: https://github.com/google/yapf - rev: v0.40.2 - hooks: - - id: yapf - name: YAPF formatting - - - repo: https://github.com/executablebooks/mdformat - rev: 0.7.17 - hooks: - - id: mdformat - name: MD formatting - additional_dependencies: - - mdformat-gfm - - mdformat-black - exclude: 'docs/.*\.md' - # exclude: "README.md|README.zh-CN.md|CONTRIBUTING.md" - - - repo: https://github.com/PyCQA/flake8 - rev: 6.1.0 - hooks: - - id: flake8 - name: PEP8 - - - repo: https://github.com/codespell-project/codespell - rev: v2.2.6 - hooks: - - id: codespell - args: - - --ignore-words-list=crate,nd,strack,dota,ane,segway,fo,gool,winn - - - repo: https://github.com/PyCQA/docformatter - rev: v1.7.5 - hooks: - - id: docformatter - -# - repo: https://github.com/asottile/yesqa -# rev: v1.4.0 -# hooks: -# - id: yesqa - -# - repo: https://github.com/asottile/dead -# rev: v1.5.0 -# hooks: -# - id: dead - -# - repo: https://github.com/ultralytics/pre-commit -# rev: bd60a414f80a53fb8f593d3bfed4701fc47e4b23 -# hooks: -# - id: capitalize-comments diff --git a/requirements.txt b/requirements.txt index c5b3cd2..1b9a685 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,5 +1,4 @@ # Ultralytics requirements # Usage: pip install -r requirements.txt -# Base ---------------------------------------- -ultralytics>=8.0 +ultralytics>=8.0.232 diff --git a/setup.cfg b/setup.cfg deleted file mode 100644 index c191a81..0000000 --- a/setup.cfg +++ /dev/null @@ -1,65 +0,0 @@ -# Project-wide configuration file, can be used for package metadata and other toll configurations -# Example usage: global configuration for PEP8 (via flake8) setting or default pytest arguments -# Local usage: pip install pre-commit, pre-commit run --all-files - -[metadata] -license_files = LICENSE -description_file = README.md - -[tool:pytest] -norecursedirs = - .git - dist - build -addopts = - --doctest-modules - --durations=30 - --color=yes - -[flake8] -max-line-length = 120 -exclude = .tox,*.egg,build,temp -select = E,W,F -doctests = True -verbose = 2 -# https://pep8.readthedocs.io/en/latest/intro.html#error-codes -format = pylint -# see: https://www.flake8rules.com/ -ignore = E731,F405,E402,W504,E501 - # E731: Do not assign a lambda expression, use a def - # F405: name may be undefined, or defined from star imports: module - # E402: module level import not at top of file - # W504: line break after binary operator - # E501: line too long - # removed: - # F401: module imported but unused - # E231: missing whitespace after β€˜,’, β€˜;’, or β€˜:’ - # E127: continuation line over-indented for visual indent - # F403: β€˜from module import *’ used; unable to detect undefined names - - -[isort] -# https://pycqa.github.io/isort/docs/configuration/options.html -line_length = 120 -# see: https://pycqa.github.io/isort/docs/configuration/multi_line_output_modes.html -multi_line_output = 0 - -[yapf] -based_on_style = pep8 -spaces_before_comment = 2 -COLUMN_LIMIT = 120 -COALESCE_BRACKETS = True -SPACES_AROUND_POWER_OPERATOR = True -SPACE_BETWEEN_ENDING_COMMA_AND_CLOSING_BRACKET = True -SPLIT_BEFORE_CLOSING_BRACKET = False -SPLIT_BEFORE_FIRST_ARGUMENT = False -# EACH_DICT_ENTRY_ON_SEPARATE_LINE = False - -[docformatter] -wrap-summaries = 120 -wrap-descriptions = 120 -in-place = true -make-summary-multi-line = false -pre-summary-newline = true -force-wrap = false -close-quotes-on-newline = true