README_PROJECT.md

Paper Title

First Author¹; Second Author²; Third Author³;

¹First Affiliation ²Second Affiliation ³Third Affiliation

Abstract

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Curabitur condimentum bibendum nulla in porta. Fusce id eros diam. Aenean ut egestas tortor, at eleifend felis. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos himenaeos. Phasellus ut ante sit amet lorem commodo fringilla. Nulla rhoncus tincidunt erat vitae pulvinar. Vestibulum dapibus, mauris sed pharetra pellentesque, risus tellus fringilla erat, sit amet egestas urna risus eget nulla. Vestibulum porta, mauris sed commodo dictum, metus ex tempor sapien, eget viverra odio enim quis felis. Nunc aliquam nisi non nisl eleifend rhoncus. Duis sit amet mollis libero, porta hendrerit nunc. Maecenas ultricies sapien ultricies, tristique metus eu, blandit felis.

Method

Prerequisites

Installation

# clone project
git clone https://github.com/YOUR_GITHUB_NAME/YOUR_PROJECT_NAME.git

# create conda virtual environment
conda create -n PROJECT_NAME python=<3.10|3.11|3.12>
conda activate <env_name>

# [Optional] install pytorch according to the official guide to support GPU acceleration, etc.
# https://pytorch.org/get-started/locally/

# install requirements
pip install -r requirements.txt

Data Preparation

Training

python src/main.py fit --config configs/data/mnist.yaml --config configs/model/simplenet.yaml --trainer.logger.init_args.name exp1

Inference

python src/main.py predict --config configs/data/mnist.yaml --config configs/model/simplenet.yaml --trainer.logger.init_args.name exp1

Citation

@inproceedings{Key,
  title={Your Title},
  author={Your team},
  booktitle={Venue},
  year={Year}
}