BeHappy

BeHappy is a small Python package that prints the source code of eight classic machine learning and statistics experiments with a single function call:

from BeHappy import code

code()

Calling code() prints the code of these eight experiments, in order, under the headings Exp 1: to Exp 8::

code() only prints the code. It does not run the experiments, download anything or create any files. Nothing is printed when you import the package.

You can copy any printed experiment into a notebook cell or a .py file and run it. The libraries it needs (numpy, pandas, scipy, scikit-learn, statsmodels, matplotlib and requests) are installed together with BeHappy. Experiments 2, 3, 4, 6 and 8 download public datasets when you run them, so they need an internet connection.

Installation

pip install behappy

The project is called behappy on PyPI, and you import it as BeHappy. pip treats the name case-insensitively, so pip install BeHappy works too.

To install from a local copy of the source:

pip install .

Usage

Python (script or terminal)

from BeHappy import code

code()

Save that as run.py and run python run.py. The code is printed in the terminal. To save it to a file instead, run python run.py > experiments.txt.

Jupyter Notebook

In a cell:

%pip install behappy

Then, in a new cell:

from BeHappy import code

code()

The code is printed below the cell. If VS Code shows "Output is truncated", click "View as a scrollable element" (or "open in a text editor") to see all of it.

Google Colab

!pip install behappy

from BeHappy import code

code()

Colab may ask you to restart the runtime after installing (for example if numpy was upgraded). If it does, restart and run the second cell again.

Requirements

Python 3.9 or newer. These dependencies are installed automatically: numpy, pandas, scipy, scikit-learn, statsmodels, matplotlib and requests.

Development

pip install -e ".[dev]"
pytest

License

MIT. See LICENSE.