pyproject.toml

[build-system]
requires = ["setuptools>=75.3.0,<81.0.0"]
build-backend = "setuptools.build_meta"

[project]
name = "maubert"
version = "0.1.0"
description = "Universal phonetic inductive biases for few-shot acoustic unit discovery"
readme = "README.md"
license = "MIT"
license-files = ["LICENSE"]
requires-python = ">=3.12"
authors = [
    { name = "Angelo Ortiz Tandazo" },
    { name = "Manel Khentout" },
    { name = "Youssef Benchekroun" },
    { name = "Thomas Hueber" },
    { name = "Emmanuel Dupoux" },
]
keywords = [
    "speech",
    "self-supervised-learning",
    "hubert",
    "phonetics",
    "acoustic-unit-discovery",
]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Programming Language :: Python :: 3.12",
    "Programming Language :: Python :: 3.13",
    "Topic :: Scientific/Engineering :: Artificial Intelligence",
    "Typing :: Typed",
]
dependencies = [
    "editdistance>=0.8.1",
    "filelock>=3.20.2",
    "huggingface-hub>=1.0",
    "jaxtyping>=0.3.3",
    "joblib>=1.5.0",
    "minimal-hubert>=0.0.7",
    "numpy>=1.26.4",
    "orjson>=3.11.5",
    "panphon",
    "polars>=1.31.0",
    "pyyaml>=6.0.3",
    "scikit-learn>=1.6.1",
    "spidr[train]>=0.1.3",
    "statsmodels>=0.14.6",
    "torch>=2.8.0",
    "torchaudio>=2.8.0",
    "torchcodec>=0.7.0",
    "tqdm>=4.67.1",
]

[project.optional-dependencies]
train = [
    "soundfile>=0.13.1",
    "wandb>=0.23.0",
]

[project.urls]
Repository = "https://github.com/angelo-ortiz/maubert"
Paper = "https://aclanthology.org/2026.acl-long.24/"
arXiv = "https://arxiv.org/abs/2512.19612"

[dependency-groups]
dev = [
    "ipykernel>=6.29.5",
    "mypy>=1.18.2",
    "ruff>=0.16.0",
    "ty>=0.0.60",
    "typos>=1.40.1",
]

[tool.setuptools.packages.find]
where = ["src"]

[tool.setuptools.package-data]
maubert = ["assets/*.pickle", "py.typed"]

[tool.uv.sources]
panphon = { git = "https://github.com/angelo-ortiz/panphon.git", branch = "maubert" }

[tool.ruff]
line-length = 119
target-version = "py312"

[tool.ruff.format]
quote-style = "single"
docstring-code-format = true
docstring-code-line-length = 72

[tool.ruff.lint]
select = ["ALL"]
ignore = [
    "ANN401", # Any is sometimes the only option.
    "ARG001", # Unused arguments are needed in callbacks.
    "ARG002", # Unused arguments are needed in torch overrides.
    "B019", # Memoised methods live as long as the process.
    "C901", # Model and training code is long by nature.
    "COM812", # Incompatible format recommendation.
    "CPY001", # No copyright notice.
    "D1", # Docstrings are optional.
    "D203", # Blank line before class.
    "D213", # Multi-line docstring second line.
    "DOC", # Disable pydoclint.
    "EM101", # Exceptions can have literal string.
    "EM102", # f-string in exceptions are ok.
    "FBT001", # Boolean flags are idiomatic here.
    "FBT002", # Ditto.
    "FBT003", # Ditto.
    "FIX002", # TODOs are ok.
    "F722", # Forward references necessary by jaxtyping
    "G004", # f-strings in logging are ok.
    "ISC001", # Incompatible format recommendation.
    "NPY002", # We use np.random.seed to set the seed just in case.
    "N806", # Ditto.
    "PLC0415", # Lazy imports are intentional.
    "PLR0912", # Model and training code is long by nature.
    "PLR0915", # Ditto.
    "PLR2004", # Magic values are ok.
    "PLR6104", # Leads to bugs in model code.
    "PLW2901", # Rebinding loop variables is ok.
    "PT018", # No pytest here.
    "PTH123", # open() is ok.
    "RUF003", # IPA and maths symbols in comments are intentional.
    "RET505", # else after return aids readability.
    "RET507", # Ditto.
    "S101", # Asserts are ok.
    "S301", # Assets are pickled.
    "SLF001", # Private member access is ok.
    "T201", # Scripts print.
    "TD003", # TODOs need no issue link.
    "TID252", # Relative imports are the house style.
    "TRY003", # Exceptions can have long error messages.
]

[tool.ruff.lint.flake8-quotes]
inline-quotes = "single" # Matches format.quote-style.

[tool.ruff.lint.isort]
combine-as-imports = true
force-wrap-aliases = true

[tool.ruff.lint.pep8-naming]
extend-ignore-names = ["F", "LA"] # torch.nn.functional and torch.linalg aliases

[tool.ruff.lint.pylint]
max-args = 10

[[tool.mypy.overrides]]
module = [
    "editdistance.*",
    "joblib.*",
    "minimal_hubert.*",
    "panphon.*",
    "sklearn.*",
    "soundfile.*",
    "spidr.*",
    "statsmodels.*",
    "torchaudio.*",
    "torchcodec.*",
]
ignore_missing_imports = true