Skip to content

development.md

Latest commit

 

History

History
37 lines (26 loc) · 1.28 KB

development.md

File metadata and controls

37 lines (26 loc) · 1.28 KB
Raw

Development

Pixl requires Python 3.11 or newer and uses uv for dependency management.

uv sync

This installs the package in src/pixl/ together with the development, notebook and app dependencies locked in uv.lock. Dependency groups and package metadata are defined in pyproject.toml.

Repository structure

  • src/pixl/ contains the Python package.
  • scripts/scenes/ contains scene generation and vocabulary tooling.
  • scripts/hub/ contains Hugging Face dataset tooling.
  • notebooks/ contains training and generation notebooks.
  • tests/ and scripts/*/tests/ contain the test suite.
  • docs/ contains project documentation.

Generated data is stored in downloaded-data/ and scene-data/. Training writes checkpoints to checkpoints/. These directories are not tracked by Git.

Run scripts as modules from the repository root:

uv run python -m scripts.scenes.generate --help
uv run python -m pixl.train --quick

Checks

uv run ruff check
uv run basedpyright
uv run python -m unittest discover -s . -p "test_*.py"

The same checks run in GitHub Actions.