asrafulashiq / pl_template

A simple template repository to set up deep learning project with pytorch, pytorch-lightning, and hydra

Your Project Name

[What it does]

How to Run

Setup

Install dependencies

# clone project
git clone https://github.com/YourGithubName/your-repo-name
cd your-repo-name

# [OPTIONAL] create conda environment
conda create -n myenv python=3.8
conda activate myenv

# install requirements
pip install -r requirements.txt

Training

Train model with default configuration

# train on GPU
python run.py trainer.gpus=1

Train model with chosen experiment configuration from configs/experiment/

python run.py experiment=experiment_name.yaml

You can override any parameter from command line like this

python run.py trainer.max_epochs=20 datamodule.batch_size=64

Evaluation

python run.py experiment=experiment_name.yaml ckpt=[] test=true

Results

License

Acknowledgement

Citation