SFU CMPT 340 Project Template -- Replace with project title

This repository is a template for your CMPT 340 course project. Replace the title with your project title, and add a snappy acronym that people remember (mnemonic).

Add a 1-2 line summary of your project here.

Important Links

Timesheet	Slack channel	Project report

• Timesheet: Link your timesheet (pinned in your project's Slack channel) where you track per student the time and tasks completed/participated for this project/
• Slack channel: Link your private Slack project channel.
• Project report: Link your Overleaf project report document.

Video/demo/GIF

Record a short video (1:40 - 2 minutes maximum) or gif or a simple screen recording or even using PowerPoint with audio or with text, showcasing your work.

Table of Contents

1. Demo

2. Installation

3. Reproducing this project

4. Guidance

1. Example demo

A minimal example to showcase your work

from amazing import amazingexample
imgs = amazingexample.demo()
for img in imgs:
    view(img)

What to find where

Explain briefly what files are found where

repository
├── src                          ## source code of the package itself
├── scripts                      ## scripts, if needed
├── docs                         ## If needed, documentation   
├── README.md                    ## You are here
├── requirements.yml             ## If you use conda

2. Installation

Provide sufficient instructions to reproduce and install your project. Provide exact versions, test on CSIL or reference workstations.

git clone $THISREPO
cd $THISREPO
conda env create -f requirements.yml
conda activate amazing

3. Reproduction

Demonstrate how your work can be reproduced, e.g. the results in your report.

mkdir tmp && cd tmp
wget https://yourstorageisourbusiness.com/dataset.zip
unzip dataset.zip
conda activate amazing
python evaluate.py --epochs=10 --data=/in/put/dir

Data can be found at ... Output will be saved in ...

4. Guidance

• Use git
  • Do NOT use history re-editing (rebase)
  • Commit messages should be informative:
    • No: 'this should fix it', 'bump' commit messages
    • Yes: 'Resolve invalid API call in updating X'
  • Do NOT include IDE folders (.idea), or hidden files. Update your .gitignore where needed.
  • Do NOT use the repository to upload data
• Use VSCode or a similarly powerful IDE
• Use Copilot for free
• Sign up for GitHub Education