updated __all__ in __init__ to make docs show everything

understanding-search · Aug 28, 2024 · 71a532e · 71a532e
1 parent 4041ac0
commit 71a532e
Show file tree

Hide file tree

Showing 6 changed files with 48 additions and 1 deletion.
diff --git a/maze_dataset/__init__.py b/maze_dataset/__init__.py
@@ -1,3 +1,7 @@
+"""
+.. include:: ../README.md
+"""
+
 from maze_dataset.constants import (
     SPECIAL_TOKENS,
     VOCAB,
@@ -24,24 +28,40 @@
 from maze_dataset.maze.lattice_maze import LatticeMaze, SolvedMaze, TargetedLatticeMaze
 
 __all__ = [
+    # submodules (with sub-submodules)
+    "dataset",
+    "generation",
+    "maze",
+    "plotting",
+    "tokenization",
+    # submodules
+    "constants",
+    "testing_utils",
+    "token_utils",
+    "utils",
+    # types
     "Coord",
     "CoordTup",
     "CoordList",
     "CoordArray",
     "Connection",
     "ConnectionList",
     "ConnectionArray",
+    # constants
     "SPECIAL_TOKENS",
     "VOCAB",
     "VOCAB_LIST",
     "VOCAB_TOKEN_TO_INDEX",
+    # maze classes
     "LatticeMaze",
     "TargetedLatticeMaze",
     "SolvedMaze",
+    # dataset classes
     "MazeDataset",
     "MazeDatasetConfig",
-    "set_serialize_minimal_threshold",
     "MazeDatasetCollection",
     "MazeDatasetCollectionConfig",
+    # other
+    "set_serialize_minimal_threshold",
     "LatticeMazeGenerators",
 ]
diff --git a/maze_dataset/dataset/__init__.py b/maze_dataset/dataset/__init__.py
@@ -5,6 +5,13 @@
 from maze_dataset.dataset.maze_dataset import MazeDataset, MazeDatasetConfig
 
 __all__ = [
+    # submodules
+    "collected_dataset",
+    "configs",
+    "dataset",
+    "maze_dataset",
+    "rasterized",
+    # dataset classes
     "MazeDataset",
     "MazeDatasetConfig",
     "MazeDatasetCollection",

diff --git a/maze_dataset/generation/__init__.py b/maze_dataset/generation/__init__.py
@@ -6,6 +6,10 @@
 )
 
 __all__ = [
+    # submodules
+    "default_generators",
+    "generators",
+    # imports
     "GENERATORS_MAP",
     "LatticeMazeGenerators",
     "get_maze_with_solution",

diff --git a/maze_dataset/maze/__init__.py b/maze_dataset/maze/__init__.py
@@ -10,6 +10,9 @@
 )
 
 __all__ = [
+    # submodules
+    "lattice_maze",
+    # imports
     "AsciiChars",
     "ConnectionList",
     "Coord",

diff --git a/maze_dataset/plotting/__init__.py b/maze_dataset/plotting/__init__.py
@@ -2,6 +2,12 @@
 from maze_dataset.plotting.plot_maze import DEFAULT_FORMATS, MazePlot, PathFormat
 
 __all__ = [
+    # submodules
+    "plot_dataset",
+    "plot_maze",
+    "plot_tokens",
+    "print_tokens",
+    # imports
     "plot_dataset_mazes",
     "print_dataset_mazes",
     "DEFAULT_FORMATS",

diff --git a/maze_dataset/tokenization/__init__.py b/maze_dataset/tokenization/__init__.py
@@ -17,7 +17,13 @@
 )
 
 __all__ = [
+    # submodules
+    "all_tokenizers",
+    "maze_tokenizer",
+    "save_hashes",
+    # imports
     "MazeTokenizer",
+    # modular maze tokenization components
     "TokenizationMode",
     "_TokenizerElement",
     "MazeTokenizerModular",
@@ -31,6 +37,7 @@
     "StepSizes",
     "StepTokenizers",
     "PathTokenizers",
+    # helpers
     "coord_str_to_tuple",
     "get_tokens_up_to_path_start",
 ]