ml-systems-design

A guidebook for the ML Engineer to deploy ML models at scale.

Usage

Building the book

If you'd like to develop on and build the ml-systems-design book, you should:

Clone this repository and run
Run pip install -r requirements.txt (it is recommended you do this within a virtual environment)
(Recommended) Remove the existing ml-systems-design/_build/ directory
Run jupyter-book build ml-systems-design/

A fully-rendered HTML version of the book will be built in ml-systems-design/_build/html/.

Hosting the book

The html version of the book is hosted on the gh-pages branch of this repo. A GitHub actions workflow has been created that automatically builds and pushes the book to this branch on a push or pull request to master.

If you wish to disable this automation, you may remove the GitHub actions workflow and build the book manually by:

Navigating to your local build; and running,
ghp-import -n -p -f ml-systems-design/_build/html

This will automatically push your build to the gh-pages branch. More information on this hosting process can be found here.

Contributors

We welcome and recognize all contributions. You can see a list of current contributors in the contributors tab.

Credits