feat: add structure for experiments

.gitignore

@@ -1,6 +1,19 @@
 # Auto-generated version file
 src/leap/_version.py
 
+# Data, models, and results (user-specific)
+data/*
+!data/.gitkeep
+!data/README.md
+
+models/*
+!models/.gitkeep
+!models/README.md
+
+results/*
+!results/.gitkeep
+!results/README.md
+
 # Python
 __pycache__/
 *.py[cod]

.pre-commit-config.yaml

@@ -37,25 +37,25 @@ repos:
         language: system
         types: [python]
         pass_filenames: false
-        entry: uv run ruff format src/ --exclude src/leap/_version.py
+        entry: uv run ruff format src/ configs/ scripts/ --exclude src/leap/_version.py
       - id: ruff-lint
         name: Lint using ruff
         language: system
         types: [python]
         pass_filenames: false
-        entry: uv run ruff check src/ --fix --exclude src/leap/_version.py
+        entry: uv run ruff check src/ configs/ scripts/ --fix --exclude src/leap/_version.py
       - id: mypy
         name: Static type checking using mypy
         language: system
         types: [python]
         pass_filenames: false
-        entry: uv run mypy src/ --exclude src/leap/_version.py
+        entry: uv run mypy src/ configs/ --exclude src/leap/_version.py
       - id: pydoclint
         name: Docstring linting with pydoclint
         language: system
         types: [python]
         pass_filenames: false
-        entry: uv run pydoclint --check-class-attributes=False --style=numpy --exclude '.*/_version\.py' src/leap/
+        entry: uv run pydoclint --check-class-attributes=False --style=numpy --exclude '.*/_version\.py' src/leap/ configs/ scripts/
       - id: jupyter-nb-clear-output
         name: Clear Jupyter notebook outputs
         files: \.ipynb$

configs/README.md

@@ -0,0 +1,8 @@
+# Configs
+
+Python configuration files for LEAP experiments.
+
+Import configs as Python modules:
+```python
+from configs.my_experiment import config
+```

configs/__init__.py

@@ -0,0 +1 @@
+"""Configuration files for LEAP experiments."""

data/README.md

@@ -0,0 +1,5 @@
+# Data
+
+Directory for storing datasets.
+
+**Note:** Data files are gitignored. Only this README is tracked.

models/README.md

@@ -0,0 +1,5 @@
+# Models
+
+Directory for storing trained models.
+
+**Note:** Model files are gitignored. Only this README is tracked.

pyproject.toml

@@ -156,7 +156,7 @@ select = [
 ]
 
 [tool.ruff.lint.isort]
-known-first-party = ["leap"]
+known-first-party = ["leap", "configs"]
 lines-after-imports = 2
 
 [tool.ruff.lint.pep8-naming]
@@ -171,8 +171,8 @@ convention = "numpy"
 [tool.mypy]
 python_version = "3.11"
 ignore_errors = false
-files = ["src/"]
-mypy_path = ["src"]
+files = ["src/", "configs/", "scripts/"]
+mypy_path = ["src", "configs", "scripts"]
 
 # Enforce typing on public functions
 disallow_incomplete_defs = true

results/README.md

@@ -0,0 +1,5 @@
+# Results
+
+Directory for experiment outputs and results.
+
+**Note:** Result files are gitignored. Only this README is tracked.

scripts/README.md

@@ -0,0 +1,8 @@
+# Scripts
+
+Experiment and utility scripts for LEAP.
+
+Run scripts from the repository root:
+```bash
+python scripts/train.py
+```