Files
cs249r_book/README.md
2023-11-24 08:49:05 -05:00

11 KiB

CS249r: MACHINE LEARNING SYSTEMS for TinyML

All Contributors

Welcome to the collaborative book repository for students of CS249r: Tiny Machine Learning at Harvard! This repository contains the source files of chapters and sections written by your peers. We're excited to see your contributions!

Contributing

To contribute to the repository using pull requests, follow these steps:

  1. Fork the Repository:

    • Navigate to the repository's GitHub page and click the 'Fork' button at the top-right corner.
  2. Clone Your Forked Repository:

    git clone https://github.com/YOUR_USERNAME/cs249r_book.git
    
  3. Navigate to the Repository:

    cd cs249r_book
    
  4. Set Upstream Remote:

    git remote add upstream https://github.com/harvard-edge/cs249r_book.git
    
  5. Create a New Branch for your chapter/section:

    git checkout -b name-of-your-new-branch
    
  6. Make your edits for your chapter or section in Markdown.

  7. Commit Changes to Your Branch:

    git add .
    git commit -m "Briefly describe your changes"
    
  8. Push Your Branch to Your Forked Repository:

    git push origin name-of-your-new-branch
    
  9. Navigate to your fork on GitHub and click the 'New pull request' button. Ensure you're comparing your branch from your fork to the main branch of the original harvard-edge/cs249r_book repository.

  10. Submit the pull request with a descriptive message.

The instructors will assess your pull request and provide feedback. Once it's approved, your contribution will be integrated into the main branch, and the book's website will be updated.

For a more detailed guide on the CS249r documentation process and peer review, check here.


Website

The book's website is automatically constructed from the gh-pages branch. Once reviewed, changes to main are merged into gh-pages.

You can view the book's website at: https://harvard-edge.github.io/cs249r_book/


Local Rendering

You need to have quarto installed for local rendering of the book. Please follow the Quarto installation instructions here.

Once that's done, the following command can be used to produce the HTML pages:

cd cs249r_book
quarto render

Contributors

Andrew Bass
Andrew Bass

naeemkh
naeemkh

oishib
oishib

sjohri20
sjohri20

aptl26
aptl26

Eric D
Eric D

Marco Zennaro
Marco Zennaro

Jared Ni
Jared Ni

arnaumarin
arnaumarin

ishapira
ishapira

Jason Yik
Jason Yik

Emil Njor
Emil Njor

Colby Banbury
Colby Banbury

Matthew Stewart
Matthew Stewart

Vijay Janapa Reddi
Vijay Janapa Reddi

happyappledog
happyappledog

Divya
Divya

sophiacho1
sophiacho1

Henry Bae
Henry Bae

Jennifer Zhou
Jennifer Zhou

Pong Trairatvorakul
Pong Trairatvorakul

Ikechukwu Uchendu
Ikechukwu Uchendu

AditiR_42
AditiR_42

Jessica Quaye
Jessica Quaye

Andrea Murillo
Andrea Murillo

Jayson Lin
Jayson Lin

Mark Mazumder
Mark Mazumder

Michael Schnebly
Michael Schnebly

Jeffrey Ma
Jeffrey Ma

Marcelo Rovai
Marcelo Rovai

alxrod
alxrod

Shvetank Prakash
Shvetank Prakash

This project follows the all-contributors specification. Contributions of any kind are welcome!