Coverage for maze_dataset/generation/__init__.py: 0%

1"""generation functions have signature `(grid_shape: Coord, **kwargs) -> LatticeMaze` and are methods in `LatticeMazeGenerators` 

2 

3`DEFAULT_GENERATORS` is a list of generator name, generator kwargs pairs used in tests and demos 

4 

5you can add your own maze generators by: 

6- adding a static method implementing your generation function to `LatticeMazeGenerators`, with the signature `(grid_shape: Coord, **kwargs) -> LatticeMaze` and adding the `(name, func)` pair to `GENERATORS_MAP` 

7- using the `@register_maze_generator` decorator on your generation function. However, this is only for testing purposes where modifying the original package is not possible. 

8 

9If you implement a new generation function, please make a pull request! 

10https://github.com/understanding-search/maze-dataset/pulls 

11""" 

12 

13from maze_dataset.generation.generators import ( 

14 _NUMPY_RNG, 

15 GENERATORS_MAP, 

16 LatticeMazeGenerators, 

17 get_maze_with_solution, 

18) 

19 

20__all__ = [ 

21 # submodules 

22 "default_generators", 

23 "generators", 

24 "registrationseed", 

25 # imports 

26 "LatticeMazeGenerators", 

27 "GENERATORS_MAP", 

28 "get_maze_with_solution", 

29 "_NUMPY_RNG", 

30]