README.md

Deep learning project seed

Use this seed to start new deep learning / ML projects.

• Built in setup.py
• Built in requirements
• Examples with MNIST
• Badges
• Bibtex

Goals

The goal of this seed is to structure ML paper-code the same so that work can easily be extended and replicated.

DELETE EVERYTHING ABOVE FOR YOUR PROJECT

---

Your Project Name

Description

What it does

How to run

First, install dependencies

# clone project   
git clone https://github.com/YourGithubName/deep-learning-project-template

# install project   
cd deep-learning-project-template 
pip install -e .   
pip install -r requirements.txt

Next, navigate to any file and run it.

# run module (example: mnist as your main contribution)   
python project/train.py fit --config ../config/config.yaml

Config

If you would like to learn more about the lightning cli please head over to the LighningCLI docs.

Citation

@article{YourName,
  title={Your Title},
  author={Your team},
  journal={Location},
  year={Year}
}