pyproject.toml

[tool.poetry]
name = "maze-dataset"
version = "1.1.0"
description = "generating and working with datasets of mazes"
authors = [
    "Michael Ivanitskiy <mivanits@umich.edu>", "Aaron Sandoval <aaron.sandoval10@gmail.com>",
    "Dan Valentine <danvalentine256@gmail.com>", "Rusheb Shah <rusheb.shah@gmail.com>",
    "Lucia Quirke <luciaq@canva.com>", "Can Rager <can.rager@posteo.de>", "Alex Spies <alexfspies@gmail.com>", "Chris Mathwin <cwmathwin@gmail.com>", "Tilman Rauker <traeuker@googlemail.com>", "Guillaume Corlouer <guillaume.corlouer@gmail.com>"
]
readme = "README.md"

# source info
packages = [{include = "maze_dataset"}]
exclude = ["maze_dataset/tokenization/MazeTokenizerModular_hashes.npz"] # don't ship the hashes

# informational metadata
keywords = ["maze", "mazes", "labyrinth", "dataset", "procedural", "pathfinding", "tokenization"]
repository = "https://github.com/understanding-search/maze-dataset"
homepage = "https://github.com/understanding-search/maze-dataset"
documentation = "https://understanding-search.github.io/maze-dataset/"

[tool.poetry.dependencies]
python = "^3.10.6"
# custom packages
muutils = "^0.6.10"
zanj = "^0.3.1"
# torch and type hints
torch = { version = ">=1.13.1", source = "torch_cpu" }
jaxtyping = "^0.2.19"
# standard numerical
matplotlib = "^3.7.0"
pandas = "^2.2.2"
# notebooks
jupyter = "^1.0.0"
ipykernel = "^6.22.0"
# misc
tqdm = "^4.65.0"
frozendict = "^2.4.4"

[tool.poetry.group.dev.dependencies]
# testing
pytest = "^7.3.1"
pytest-xdist = "^3.6.1" # for parallel all tokenizers tests
pytest-mock = "^3.10.0"
pytest-cov = "^4.1.0"
coverage-badge = "^1.1.0"
# type checking
mypy = "^1.0.1"
# formatting
pycln = "^2.1.3"
isort = "^5.12.0"
black = "^24.1.0"
typer = "^0.12.3" # for pycln -- takes forever to install?

[tool.poetry.group.docs.dependencies]
# generating docs
pdoc = "^14.6.0"
# converting demo notebooks to md
nbconvert = "^7.16.4"

[[tool.poetry.source]]
name = "torch_cpu"
url = "https://download.pytorch.org/whl/cpu"
priority = "explicit"

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

[tool.pytest.ini_options]
# Ignore numpy deprecation warnings triggered by muutils
filterwarnings = [
    # Warning from muutils: https://github.com/mivanit/muutils/issues/1
    "ignore:`np\\.\\w*` is a deprecated alias for:DeprecationWarning",

    # Warning from matplotlib. Issue: https://github.com/matplotlib/matplotlib/issues/25244
    "ignore:Deprecated call to `pkg_resources.declare_namespace:DeprecationWarning",

    # temporary fix for lots of deprecation warnings for old tokenizers
    "ignore::maze_dataset.token_utils.TokenizerPendingDeprecationWarning",
]
testpaths = "tests"
norecursedirs="maze_dataset/utils/test_helpers"

[[tool.mypy.overrides]]
module = "fire"
ignore_missing_imports = true

[tool.isort]
profile = "black"
known_third_party = "wandb"

[tool.pycln]
disable-all-dunder-policy = true # this doesn't seem to work... :/

[tool.pyright]
exclude = [".venv"]
venvPath = "."
venv = ".venv"

[tool.pdoc]
warnings_ignore = [
    "Error parsing type annotation FilterBy for maze_dataset",
    "Found 'coord_str_to_tuple' in maze_dataset.tokenization.__all__, but it does not resolve: Error importing maze_dataset.tokenization.coord_str_to_tuple",
]