Deep learning project seed

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

using poetry to manage env stuffs
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 
poetry install

It is highly recommended using poetry to manage python env, for usage, please refer to https://python-poetry.org/.

Next, navigate to any file and run it.

# spawn your env's shell 
poetry shell

mv configs/train.yaml.template configs/train.yaml
vi configs/train.yaml # do some modification

# run training
python main.py train configs/train.yaml.template

# run testing with two gpus
python main.py test configs/train.yaml {your_ckpt_path} {your_hparams_path} --gpus 2 --accelerator ddp

Citation

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

jiangxiluning / TCPN