diff --git a/.gitignore b/.gitignore index ab190d9..14276ae 100644 --- a/.gitignore +++ b/.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] diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 462ff06..5701e32 100644 --- a/.pre-commit-config.yaml +++ b/.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$ diff --git a/badges/cov_badge.svg b/badges/cov_badge.svg new file mode 100644 index 0000000..e2dd726 --- /dev/null +++ b/badges/cov_badge.svg @@ -0,0 +1 @@ +coverage: 89%coverage89% diff --git a/configs/README.md b/configs/README.md new file mode 100644 index 0000000..3ccef8e --- /dev/null +++ b/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 +``` diff --git a/configs/__init__.py b/configs/__init__.py new file mode 100644 index 0000000..f5886dc --- /dev/null +++ b/configs/__init__.py @@ -0,0 +1 @@ +"""Configuration files for LEAP experiments.""" diff --git a/data/.gitkeep b/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/data/README.md b/data/README.md new file mode 100644 index 0000000..f228954 --- /dev/null +++ b/data/README.md @@ -0,0 +1,5 @@ +# Data + +Directory for storing datasets. + +**Note:** Data files are gitignored. Only this README is tracked. diff --git a/models/.gitkeep b/models/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/models/README.md b/models/README.md new file mode 100644 index 0000000..d97462e --- /dev/null +++ b/models/README.md @@ -0,0 +1,5 @@ +# Models + +Directory for storing trained models. + +**Note:** Model files are gitignored. Only this README is tracked. diff --git a/pyproject.toml b/pyproject.toml index 65b36cf..4648303 100644 --- a/pyproject.toml +++ b/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 diff --git a/results/.gitkeep b/results/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/results/README.md b/results/README.md new file mode 100644 index 0000000..1d0bbc1 --- /dev/null +++ b/results/README.md @@ -0,0 +1,5 @@ +# Results + +Directory for experiment outputs and results. + +**Note:** Result files are gitignored. Only this README is tracked. diff --git a/scripts/README.md b/scripts/README.md new file mode 100644 index 0000000..d495553 --- /dev/null +++ b/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 +```