• / - project root
  • <MODULE NAME>/ - the source code of the current project’s module
    • utils/ - a directory for utilities
      • download.py - helper function for downloading files from URLs
      • extract.py - helper function for extracting compressed archives
      • project_paths.py - helper functions for getting directory paths to the /artifacts/ directory
    • settings.py - a settings object that loads environment variables by default
  • notebooks/ - any notebooks used in development
    • experiments/ - experiment notebooks to try things out
    • tutorials/ - notebooks that follow online tutorials
  • scripts/ - a directory for single-file helper scripts
    • pdm_lockfile.py - an extension script for PDM to manage multiple lockfiles
  • artifacts/ - artifact files that are, by default, not included in source control
    • data/ - dataset files
      • raw/ - a download directory raw data files
      • intermediate/ - a cache directory for partially processed data files
      • cache/ - a cache directory for fully processed data files
    • checkpoints/ - training checkpoint files
    • logs/ - training or execution logs
    • models/ - saved model files
  • .vscode/ - configuration directory for VS Code
  • .env.example.sh - an example environment variables file

Artifacts

To keep any artifacts from /artifacts/ in source control, follow the instructions in /.gitignore.

PDM lockfiles

Run pdm lockfile --help for more information on how /scripts/pdm_lockfile.py works.