Skip to content

bpesquet/mlhandbook

Repository files navigation

Supported Python Versions Code style: black

Machine Learning Handbook

This project is being phased out and replaced by ainotes.

This repository contains the source files for the Machine Learning Handbook, my textbook for teaching Machine Learning. More info here.

Development notes

Generating the site

The website is generated by Jupyter Book. After installing it, execute the following command in the root folder to generate the HTML output in the _build subdirectory:

jupyter-book build .

A GitHub action is used to publish this output as a website.

Adding or updating katas

The practical challenges, named katas, are generated with nbgrader and contain missing answers. Teacher versions (corrections) live in a separate private repository.

The mlkatas repository is outdated. Its content has been merged into this repository.

Exporting a notebook to a PDF file

Use nbconvert in the same directory as the source file:

jupyter nbconvert --to PDF <chapter_file_name>.ipynb

For now, GIF files must be replaced by their PNG counterparts before launching the conversion process.