pyproject.toml

[tool.poetry]
name = "ferret-xai"
version = "0.5.0"
description = "A python package for benchmarking interpretability approaches."
authors = ["Giuseppe Attanasio <giuseppeattanasio6@gmail.com>"]
license = "MIT"
readme = "README.md"
homepage = "https://github.com/g8a9/ferret"
repository = "https://github.com/g8a9/ferret"
documentation = "https://ferret.readthedocs.io/en/latest/"
keywords = ["interpretability", "benchmarking", "xai", "nlp", "ml", "ai"]
classifiers = [
    "Development Status :: 4 - Beta",
    "Intended Audience :: Science/Research",
    "Intended Audience :: Education",
    "Intended Audience :: Developers",
    "License :: OSI Approved :: MIT License",
    "Natural Language :: English",
    "Programming Language :: Python :: 3.9",
    "Programming Language :: Python :: 3.10",
    "Programming Language :: Python :: 3.11",
]
packages = [
    { include = "ferret" },
]


[tool.poetry.dependencies]
python = "^3.9.0"
transformers = "^4.36.2"
datasets = "^2.16.1"
sentencepiece = "^0.1.99"
captum = "^0.7.0"
shap = "^0.44.0"
seaborn = "^0.13.1"
matplotlib = "^3.7.4"
numpy = "^1.24.4"
pandas = "^2.0.3"
tqdm = "^4.66.1"
scikit-image = "^0.21.0"
opencv-python = "^4.9.0.80"
lime = "^0.2.0.1"
joblib = "^1.3.2"
pytreebank = "^0.2.7"
thermostat-datasets = "^1.1.0"
# Speech-XAI additional requirements to allow for `pip install ferret[speech]`.
pydub = { version = "0.25.1", optional = true }
audiomentations = { version = "0.34.1", optional = true }
audiostretchy = { version = "1.3.5", optional = true }
pyroomacoustics = { version = "0.7.3", optional = true }
whisperx = { version = "3.1.2", optional = true }

[tool.poetry.extras]
speech = [
    "pydub",
    "audiomentations",
    "audiostretchy",
    "pyroomacoustics",
    "whisperx"
]
all = [
    "pydub",
    "audiomentations",
    "audiostretchy",
    "pyroomacoustics",
    "whisperx"
]


[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"

[tool.black]
line-length = 89

[tool.isort]
profile = "black"