Project Structure

├── .github                <- Github Actions workflows
│
├── configs                <- Hydra configs
│   ├── callbacks             <- Callbacks configs
│   ├── data                  <- Data configs
│   ├── debug                 <- Debugging configs
│   ├── experiment            <- Experiment configs
│   ├── extras                <- Extra utilities configs
│   ├── hparams_search        <- Hyperparameter search configs
│   ├── hydra                 <- Hydra configs
│   ├── local                 <- Local configs
│   ├── logger                <- Logger configs
│   ├── model                 <- Model configs
│   ├── paths                 <- Project paths configs
│   ├── trainer               <- Trainer configs
│   ├── eval.yaml             <- Main config for evaluation
│   └── train.yaml            <- Main config for training
│
├── data                   <- Project data
│
├── docs                   <- Website files
│
├── logs                   <- Logs generated by hydra and lightning loggers
│
├── notebooks              <- Jupyter notebooks
│
├── scripts                <- Shell scripts
│
├── src                    <- Source code
│   ├── data                  <- Data scripts
│   ├── models                <- Model scripts
│   ├── utils                 <- Utility scripts
│   ├── eval.py               <- Run evaluation
│   └── train.py              <- Run training
│
├── .gitignore                <- List of files ignored by git
├── .pre-commit-config.yaml   <- Configuration of pre-commit hooks for code formatting
├── .project-root             <- File for inferring the position of root directory
├── environment.yaml          <- File for installing conda environment
├── Makefile                  <- Makefile with commands like `make train`
├── pyproject.toml            <- Configuration options for testing and linting
├── README.md                 <- README file
└── requirements.txt          <- File for installing python dependencies