No project description provided
Project description
Maze Dataset
Generation, solving and processing of various mazes. Primarily build for the maze-transformer project, which this repo is an offshoot of.
Installation
pip install git+ssh://git@github.com/aisc-understanding-search/maze-dataset.git
You can run all tests via
make test
(this will take a few minutes)
Usage
Most of the functionality is demonstrated in the ipython notebooks in the notebooks/
folder.
demo_dataset.ipynb
how to easily create a dataset of mazes, utilities for filtering the generates mazes via properties, and basic visualizationdemo_latticemaze.ipynb
internals of theLatticeMaze
andSolvedMaze
objects, and advanced visualization
Development
Prerequisites
-
Install Poetry
-
Install Python 3.10
- It's a good idea to use pyenv to manage python versions
- If using pyenv, you'll need to update your Poetry config for it to use the pyenv Python version:
poetry config virtualenvs.prefer-active-python true
-
Install dev dependencies
poetry config virtualenvs.in-project true poetry install --with dev
-
Run unit, integration, and notebook tests
make test
-
(Optional) If you want to work with the jupyter notebooks in VSCode
- create a jupyter kernel with
poetry run ipython kernel install --user --name=maze-dataset
- Restart VSCode
- In VSCode, select the python interpreter located in
maze-dataset/.venv/bin
as your juptyer kernel
- create a jupyter kernel with
Testing & Static analysis
make help
will print all available commands.
-
all tests via
make test
- unit tests via
make unit
- notebook tests via
make test_notebooks
- unit tests via
-
formatter (black, pycln, and isort) via
make format
- formatter in check-only mode via
make check-format
- formatter in check-only mode via
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
maze_dataset-0.3.3.tar.gz
(41.7 kB
view hashes)
Built Distribution
Close
Hashes for maze_dataset-0.3.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f2b816e0beda01030a5043c3830118c715f9a4248f9aab9800120aab971970f2 |
|
MD5 | 8b846134379000f21a4801e8bfa918bf |
|
BLAKE2b-256 | e5077b2a6d357caa6a53be770651edbc49b33c88606e5bb3dff0d2ddff8e4ea4 |