Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.26 KB

README.md

File metadata and controls

25 lines (16 loc) · 1.26 KB
Raw

Machine Learning Studies - Basics

Building this booklet locally

The content of this repository is written with markdown files, packaged with MkDocs and can be built into a book-readable format by MkDocs build processes.

  1. Install MkDocs locally following the official documentation instructions.
  2. Install Material plugin for mkdocs: pip install -r requirements.txt
  3. git clone https://github.com/jbcodeforce/ML-studies.git (or your forked repository if you plan to edit)
  4. cd ML-studies
  5. mkdocs serve
  6. Go to http://127.0.0.1:8000/ in your browser.

Building this booklet locally but with docker

In some cases you might not want to alter your Python setup and rather go with a docker image instead. This requires docker is running locally on your computer though.

  • docker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material
  • Go to http://127.0.0.1:8000/ in your browser.

Pushing the book to GitHub Pages

  1. Ensure that all your local changes to the master branch have been committed and pushed to the remote repository. git push origin code
  2. Run mkdocs gh-deploy --remote-branch main from the root directory.