/pytorch-lightning-conference-seed

Pytorch Lightning code guideline for conferences

Primary LanguagePythonApache License 2.0Apache-2.0

pytorch-lightning-conference-seed

Use this seed to refactor your PyTorch research code for:

  • a paper submission
  • a new research project.

Read the usage instructions here

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

Paper Conference Conference Conference

Description

What it does

How to run

First, install dependencies

# clone project   
git clone https://github.com/YourGithubName/Your-project-name   

# install project   
cd Your-project-name 
pip install -e .   
pip install requirements.txt

Next, navigate to [Your Main Contribution (MNIST here)] and run it.

# module folder
cd research_seed/mnist/   

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

Main Contribution

List your modules here. Each module contains all code for a full system including how to run instructions.

Baselines

List your baselines here.

Citation

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