Lightning-AI/deep-learning-project-template

Lightning-AI/deep-learning-project-template

Description: Pytorch Lightning code guideline for conferences

Language: Python

License: Apache-2.0

Stars: 1290

Forks: 272

Open issues: 14

Created: 2019-08-23T16:50:05Z

Pushed: 2023-09-20T12:05:43Z

Default branch: master

Fork: no

Archived: yes

README:

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

---

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.

# module folder
cd project

# run module (example: mnist as your main contribution)
python lit_classifier_main.py

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}
}