123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181 |
- # Ultralytics YOLO 🚀, AGPL-3.0 license
- # Overview:
- # This pyproject.toml file manages the build, packaging, and distribution of the Ultralytics library.
- # It defines essential project metadata, dependencies, and settings used to develop and deploy the library.
- # 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, yapf, etc.) used in the project.
- # Installation:
- # The Ultralytics library can be installed using the command: 'pip install ultralytics'
- # For development purposes, you can install the package in editable mode with: 'pip install -e .'
- # This approach allows for real-time code modifications without the need for re-installation.
- # Documentation:
- # For comprehensive documentation and usage instructions, visit: https://docs.ultralytics.com
- [build-system]
- requires = ["setuptools>=57.0.0", "wheel"]
- build-backend = "setuptools.build_meta"
- # Project settings -----------------------------------------------------------------------------------------------------
- [project]
- name = "ultralytics"
- dynamic = ["version"]
- description = "Ultralytics YOLOv8 for SOTA object detection, multi-object tracking, instance segmentation, pose estimation 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", "YOLOv8", "HUB", "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",
- "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 = [
- "numpy>=1.23.0,<2.0.0", # temporary patch for compat errors https://github.com/ultralytics/yolov5/actions/runs/9538130424/job/26286956354
- "matplotlib>=3.3.0",
- "opencv-python>=4.6.0",
- "pillow>=7.1.2",
- "pyyaml>=5.3.1",
- "requests>=2.23.0",
- "scipy>=1.4.1",
- "torch>=1.8.0",
- "torchvision>=0.9.0",
- "tqdm>=4.64.0", # progress bars
- "psutil", # system utilization
- "py-cpuinfo", # display CPU info
- "pandas>=1.1.4",
- "seaborn>=0.11.0", # plotting
- "ultralytics-thop>=2.0.0", # FLOPs computation https://github.com/ultralytics/thop
- ]
- # Optional dependencies ------------------------------------------------------------------------------------------------
- [project.optional-dependencies]
- dev = [
- "ipython",
- "pytest",
- "pytest-cov",
- "coverage[toml]",
- "mkdocs>=1.6.0",
- "mkdocs-material>=9.5.9",
- "mkdocstrings[python]",
- "mkdocs-jupyter", # for notebooks
- "mkdocs-redirects", # for 301 redirects
- "mkdocs-ultralytics-plugin>=0.0.49", # for meta descriptions and images, dates and authors
- ]
- export = [
- "onnx>=1.12.0", # ONNX export
- "coremltools>=7.0; platform_system != 'Windows' and python_version <= '3.11'", # CoreML supported on macOS and Linux
- "openvino>=2024.0.0", # OpenVINO export
- "tensorflow>=2.0.0", # TF bug https://github.com/ultralytics/ultralytics/issues/5161
- "tensorflowjs>=3.9.0", # TF.js export, automatically installs tensorflow
- "keras", # not installed automatically by tensorflow>=2.16
- "flatbuffers>=23.5.26,<100; platform_machine == 'aarch64'", # update old 'flatbuffers' included inside tensorflow package
- "numpy==1.23.5; platform_machine == 'aarch64'", # fix error: `np.bool` was a deprecated alias for the builtin `bool` when using TensorRT models on NVIDIA Jetson
- "h5py!=3.11.0; platform_machine == 'aarch64'", # fix h5py build issues due to missing aarch64 wheels in 3.11 release
- ]
- explorer = [
- "lancedb", # vector search
- "duckdb<=0.9.2", # SQL queries, duckdb==0.10.0 bug https://github.com/ultralytics/ultralytics/pull/8181
- "streamlit", # visualizing with GUI
- ]
- logging = [
- "comet", # https://docs.ultralytics.com/integrations/comet/
- "tensorboard>=2.13.0",
- "dvclive>=2.12.0",
- ]
- extra = [
- "hub-sdk>=0.0.8", # Ultralytics HUB
- "ipython", # interactive notebook
- "albumentations>=1.4.6", # training augmentations
- "pycocotools>=2.0.7", # COCO mAP
- ]
- [project.urls]
- "Bug Reports" = "https://github.com/ultralytics/ultralytics/issues"
- "Funding" = "https://ultralytics.com"
- "Source" = "https://github.com/ultralytics/ultralytics/"
- [project.scripts]
- yolo = "ultralytics.cfg:entrypoint"
- ultralytics = "ultralytics.cfg:entrypoint"
- # Tools settings -------------------------------------------------------------------------------------------------------
- [tool.setuptools] # configuration specific to the `setuptools` build backend.
- packages = { find = { where = ["."], include = ["ultralytics", "ultralytics.*"] } }
- package-data = { "ultralytics" = ["**/*.yaml", "../tests/*.py"], "ultralytics.assets" = ["*.jpg"] }
- [tool.setuptools.dynamic]
- version = { attr = "ultralytics.__version__" }
- [tool.pytest.ini_options]
- addopts = "--doctest-modules --durations=30 --color=yes"
- markers = [
- "slow: skip slow tests unless --slow is set",
- ]
- norecursedirs = [".git", "dist", "build"]
- [tool.coverage.run]
- source = ["ultralytics/"]
- data_file = "tests/.coverage"
- omit = ["ultralytics/utils/callbacks/*"]
- [tool.isort]
- line_length = 120
- multi_line_output = 0
- [tool.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
- [tool.ruff]
- line-length = 120
- [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 = "crate,nd,ned,strack,dota,ane,segway,fo,gool,winn,commend,bloc,nam,afterall"
- skip = '*.pt,*.pth,*.torchscript,*.onnx,*.tflite,*.pb,*.bin,*.param,*.mlmodel,*.engine,*.npy,*.data*,*.csv,*pnnx*,*venv*,*translat*,__pycache__*,*.ico,*.jpg,*.png,*.mp4,*.mov,/runs,/.git,./docs/??/*.md,./docs/mkdocs_??.yml'
|