pyproject.toml

# Ultralytics 🚀 AGPL-3.0 License - https://ultralytics.com/license

# Overview:
# This pyproject.toml file manages the packaging metadata and tool configuration for Ultralytics YOLOv5.
# Most users run YOLOv5 directly from a repository clone with dependencies from requirements.txt.

# Key Sections:
# - [build-system]: Specifies the build requirements and backend (e.g., setuptools, wheel).
# - [project]: Includes details like name, version, description, authors, dependencies and more.
# - [project.optional-dependencies]: Provides additional, optional packages for extended features.
# - [tool.*]: Configures settings for various tools (pytest, ruff, etc.) used in the project.

# Documentation:
# For comprehensive documentation and usage instructions, visit: https://docs.ultralytics.com/yolov5

[build-system]
requires = ["setuptools>=43.0.0", "wheel"]
build-backend = "setuptools.build_meta"

# Project settings -----------------------------------------------------------------------------------------------------
[project]
version = "7.0.0"
name = "YOLOv5"
description = "Ultralytics YOLOv5 for object detection, instance segmentation and image classification."
readme = "README.md"
requires-python = ">=3.8"
license = { "text" = "AGPL-3.0" }
keywords = ["machine-learning", "deep-learning", "computer-vision", "ML", "DL", "AI", "YOLO", "YOLOv3", "YOLOv5", "Ultralytics"]
authors = [
    { name = "Glenn Jocher" },
    { name = "Ayush Chaurasia" },
    { name = "Jing Qiu" }
]
maintainers = [
    { name = "Glenn Jocher" },
    { name = "Ayush Chaurasia" },
    { name = "Jing Qiu" }
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Developers",
    "Intended Audience :: Education",
    "Intended Audience :: Science/Research",
    "License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)",
    "Programming Language :: Python :: 3",
    "Programming Language :: Python :: 3.8",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Programming Language :: Python :: 3.14",
    "Topic :: Software Development",
    "Topic :: Scientific/Engineering",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Topic :: Scientific/Engineering :: Image Recognition",
    "Operating System :: POSIX :: Linux",
    "Operating System :: MacOS",
    "Operating System :: Microsoft :: Windows",
]

# Required dependencies ------------------------------------------------------------------------------------------------
dependencies = [
    "matplotlib>=3.3.0",
    "numpy>=1.23.5",
    "opencv-python>=4.6.0",
    "pillow>=10.3.0",
    "pyyaml>=5.3.1",
    "requests>=2.32.2",
    "scipy>=1.4.1",
    "torch>=1.8.0",
    "torchvision>=0.9.0",
    "psutil", # system utilization
    "ultralytics-thop>=2.1.6", # FLOPs computation https://github.com/ultralytics/thop
    "pandas>=1.1.4",
    "seaborn>=0.11.0", # plotting
    "packaging", # general utilities
    "ultralytics>=8.4.132"
]

# Optional dependencies ------------------------------------------------------------------------------------------------
[project.optional-dependencies]
dev = [
    "ipython",
    "pytest",
    "pytest-cov",
    "coverage[toml]",
]
export = [
    "onnx>=1.12.0", # ONNX export
    "coremltools>=9.0; platform_system != 'Windows'", # CoreML only supported on macOS and Linux
    "openvino>=2024.0.0", # OpenVINO export
    "tensorflow>=2.0.0,<=2.19.0", # TF bug https://github.com/ultralytics/ultralytics/issues/5161
    "tensorflowjs>=3.9.0", # TF.js export, automatically installs tensorflow
    "keras>=3.5.0,<=3.12.0", # pin to avoid XNNPACK errors
]
# tflite-support  # for TFLite model metadata
# tensorrt  # TensorRT export
logging = [
    "comet_ml", # https://docs.ultralytics.com/integrations/comet
    "tensorboard>=2.13.0",
]
extra = [
    "ipython", # interactive notebook
    "albumentations>=1.0.3", # training augmentations
    "pycocotools>=2.0.6", # COCO mAP
]

[project.urls]
"Bug Reports" = "https://github.com/ultralytics/yolov5/issues"
"Funding" = "https://ultralytics.com"
"Source" = "https://github.com/ultralytics/yolov5/"

# Tools settings -------------------------------------------------------------------------------------------------------
[tool.pytest.ini_options]
norecursedirs = [".git", "dist", "build"]

[tool.ruff]
line-length = 120

[tool.ruff.lint.per-file-ignores]
"benchmarks.py" = ["E402"]
"classify/*.py" = ["E402"]
"detect.py" = ["E402"]
"export.py" = ["E402"]
"models/tf.py" = ["E402"]
"models/yolo.py" = ["E402"]
"segment/*.py" = ["E402"]
"tests/test_flask_rest_api.py" = ["D101", "D102", "D103"]
"train.py" = ["E402"]
"utils/loggers/comet/__init__.py" = ["E402"]
"utils/loggers/comet/hpo.py" = ["E402"]
"val.py" = ["E402"]

[tool.docformatter]
wrap-summaries = 120
wrap-descriptions = 120
in-place = true
pre-summary-newline = true
close-quotes-on-newline = true

[tool.codespell]
ignore-words-list = "grey,nd,writeable"
skip = '*venv*'