A Minimal Project Template

This minimal project template integrates Hydra with Transformers for efficient development of complex neural models. It leverages Hydra for modularized model construction and Transformers for easy training and evaluation.

Overview

Below is the depth-1 directory hierarchy of the project.

vsymbol        // project name
├── bash       // command line scripts
├── configs    // configuration files for Hydra
├── main.py    // the entry of the code
└── vsymbol    // all the code

Run

Create a running environment

The project dependencies are defined in configs/envrionment.yml.

Submit a training/evaluation job

The command line is automatically composed in bash/run_main.sh. Remember to specify PROJ_ROOT by replacing the anchor MODIFY_ME with a path you'd like to use. After setting up data and model paths, try bash bash/run_main.sh.

How to contribute?

Suggestions for improvement are more than welcome. Always run python -m black . before git push. Cheers!

License

MIT