https://github.com/bpesquet/mlhandbook

(Phased out) My textbook for teaching Machine Learning
https://github.com/bpesquet/mlhandbook

deep-learning jupyter-notebook jupyterbook kata keras machine-learning nbgrader numpy python pytorch scikit-learn

Last synced: 1 day ago
JSON representation

(Phased out) My textbook for teaching Machine Learning

• Host: GitHub
• URL: https://github.com/bpesquet/mlhandbook
• Owner: bpesquet
• License: other
• Created: 2018-12-03T15:22:27.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2024-03-22T20:17:17.000Z (8 months ago)
• Last Synced: 2024-05-01T12:49:28.292Z (7 months ago)
• Topics: deep-learning, jupyter-notebook, jupyterbook, kata, keras, machine-learning, nbgrader, numpy, python, pytorch, scikit-learn
• Language: Jupyter Notebook
• Homepage: https://www.bpesquet.fr/mlhandbook/
• Size: 218 MB
• Stars: 38
• Watchers: 3
• Forks: 9
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
![Supported Python Versions](https://img.shields.io/badge/Python->=3.6-blue.svg?logo=python&logoColor=white)

[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)

# Machine Learning Handbook

> This project is being phased out and replaced by [ainotes](https://github.com/bpesquet/ainotes).

This repository contains the source files for the [Machine Learning Handbook](https://www.bpesquet.fr/mlhandbook), my textbook for teaching Machine Learning. More info [here](index.md).

## Development notes

### Generating the site

The [website](https://www.bpesquet.fr/mlhandbook) is generated by [Jupyter Book](https://jupyterbook.org). After installing it, execute the following command in the root folder to generate the HTML output in the `_build` subdirectory:

```bash

jupyter-book build .

```

A [GitHub action](.github/workflows/deploy.yaml) is used to publish this output as a website.

### Adding or updating katas

The practical challenges, named _katas_, are generated with [nbgrader](https://nbgrader.readthedocs.io/) and contain missing answers. Teacher versions (corrections) live in a separate private repository.

The [mlkatas](https://github.com/bpesquet/mlkatas) repository is outdated. Its content has been merged into this repository.

### Exporting a notebook to a PDF file

Use [nbconvert](https://nbconvert.readthedocs.io) in the same directory as the source file:

```bash

jupyter nbconvert --to PDF .ipynb

```

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