zhengzangw / pytorch-template

Your Project Name

Description

TBD

How to run

First, install dependencies

# clone project
git clone https://github.com/zhengzangw/this_project

# install project
cd this_project
pip install -e .
pip install -r requirements.txt

Next, run the training or testing script.

cd project

# train
python -m project.train --config config/debug.yaml

# test
python -m project.train --config config/test.yaml

Imports

This project is setup as a package which means you can now easily import any file into any other file like so:

from project.datasets.mnist import mnist
from project.lit_classifier_main import LitClassifier
from pytorch_lightning import Trainer

# model
model = LitClassifier()

# data
train, val, test = mnist()

# train
trainer = Trainer()
trainer.fit(model, train, val)

# test using the best model!
trainer.test(test_dataloaders=test)

Citation

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