Template

This is a GitHub repo template for the lab. Feel free to contribute.

About

A brief eye-catching intro of the project.

Can include a figure here. <img src = "assets/architecture.png" width=800>

Citation

@article{
Put the google scholar Bibtex here.
}

Usage

Environment setup

git clone https://github.com/KrishnaswamyLab/ProjectName.git
cd ProjectName
chmod +x setup.sh && ./setup.sh
source .venv/bin/activate

Preprocessing

cd src/preprocessing
python preprocess_xxx.py

Training and evaluation

cd src/
python main_xxx.py

Analyses and visualizations

cd src/script_analysis/
python analyze_xxx.py

cd src/script_vis/
python visualize_xxx.py

Repository Structure

├── assets/                        # Figures to display in this repo
├── comparison/                    # Baseline methods to compare with
├── data/                          # Data files
├── src/                           # Code folder
│   ├── preprocessing/             # Preprocessing code
│   ├── datasets/                  # Data loaders
│   ├── model/                     # Neural networks
│   ├── utils/                     # Utility functions
│   ├── script_analysis/           # Analysis
│   ├── script_vis/                # Visualization
│   └── main_xxx.py                # Main training/eval script
├── results/                       # Training/eval outputs
├── requirements.txt               # Environment dependencies
└── setup.sh                       # Environment setup

Other sections to showcase results etc.