pyproject.toml

[project]
name = "discophon"
description = "The Phoneme Discovery Benchmark"
readme = "README.md"
requires-python = ">=3.12"
license = "MIT"
authors = [{ name = "Maxime Poli" }, { name = "CoML", email = "dev@cognitive-ml.fr" }]
keywords = ["machine learning", "speech"]
classifiers = [
  "Development Status :: 4 - Beta",
  "Intended Audience :: Science/Research",
  "Operating System :: OS Independent",
  "Programming Language :: Python :: 3 :: Only",
  "Programming Language :: Python :: 3.12",
  "Programming Language :: Python :: 3.13",
  "Programming Language :: Python :: 3.14",
  "Topic :: Scientific/Engineering",
  "Topic :: Scientific/Engineering :: Artificial Intelligence",
]
dependencies = [
  "filelock>=3.20.2",
  "numba>=0.63.1",
  "numpy>=2.3.5",
  "polars>=1.44.1",
  "praat-textgrids>=1.4.0",
  "scipy>=1.17.0",
  "tqdm>=4.67.1",
  "xarray>=2025.12.0",
]
dynamic = ["version"]

[project.urls]
Documentation = "https://benchmarks.cognitive-ml.fr/discophon/guide/"
Homepage = "https://benchmarks.cognitive-ml.fr/discophon/"
Issues = "https://github.com/bootphon/discophon/issues"
Paper = "https://www.isca-archive.org/interspeech_2026/poli26_interspeech.html"
Repository = "https://github.com/bootphon/discophon"

[project.optional-dependencies]
abx = [
  "fastabx>=0.8.0",
]
baselines = [
  "joblib>=1.5.3",
  "minimal-hubert>=0.0.8",
  "orjson>=3.11.5",
  "scikit-learn>=1.8.0",
  "spidr[train]>=0.2.0",
  "torch>=2.13.0",
  "torchcodec>=0.16.0",
  "wandb>=0.19.10",
]
prepare = [
  "datacollective>=0.6.4",
  "requests>=2.32.5",
  "soundfile>=0.13.1",
  "soxr>=1.0.0",
]

[dependency-groups]
dev = [
  "prek>=0.5.5",
]
docs = [
  "mkdocstrings-python>=2.0.3",
  "zensical>=0.0.38",
]
test = [
  "hypothesis>=6.155.7",
  "matplotlib>=3.10.8",
  "pytest>=9.0.3",
  "pytest-cov>=7.1.0",
  "scikit-learn>=1.8.0",
]

[build-system]
requires = ["hatch-vcs", "hatchling"]
build-backend = "hatchling.build"

[tool.coverage.report]
fail_under = 85

[tool.coverage.run]
branch = true

[tool.hatch.version]
source = "vcs"

[tool.pytest]
markers = [
  "requires_dataset: mark test as requiring a path to the dataset",
  "requires_tipa_output: mark test as requiring an output path for the TIPA mapping plot",
  "slow: mark test as slow (only runs with --run-slow)",
]
testpaths = ["tests"]

[tool.ruff]
line-length = 119

[tool.ruff.lint]
preview = true
select = [
  "correctness",
  "suspicious",
  "complexity",
  "performance",
  "style",
  "security",
  "formatting",
  "pedantic",
  "banned-module-level-imports",
]
ignore = [
  "docstring-missing-exception",
  "docstring-missing-returns",
  "f-string-in-exception",
  "incorrect-blank-line-before-class",
  "missing-copyright-notice",
  "missing-trailing-comma",
  "multi-line-summary-second-line",
  "raise-vanilla-args",
  "raw-string-in-exception",
  "undocumented-magic-method",
  "undocumented-public-function",
  "undocumented-public-init",
  "undocumented-public-module",
]

[tool.ruff.lint.per-file-ignores]
"tests/*.py" = ["float-equality-comparison"]
"scripts/*.py" = ["implicit-namespace-package"]

[tool.ruff.lint.flake8-tidy-imports]
banned-module-level-imports = ["discophon.abx"]

[tool.ruff.lint.pylint]
allow-magic-value-types = ["int", "str"]
max-args = 10

[tool.ruff.lint.pep8-naming]
extend-ignore-names = ["F"]  # from torch.nn import functional as F

[tool.ty]
src.exclude = [
  "scripts/interactive_plots.py",
  "scripts/post_process_dataset.py",
  "scripts/segment_dataset.py",
  "scripts/vad_dataset.py",
  "tests/test_batching.py",
]

[tool.typos.default.extend-words]
interm = "interm"
tha = "tha"
Charis = "Charis"

[tool.typos.files]
extend-exclude = ["*.html"]

[tool.uv.workspace]
members = ["scripts"]