documentation (#2)

.gitignore

@@ -160,3 +160,6 @@ cython_debug/
 #  and can be added to the global gitignore or merged into this file.  For a more nuclear
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 #.idea/
+
+# jupyter-book
+_build/

.readthedocs.yml

@@ -0,0 +1,23 @@
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.10"
+  apt_packages:
+    - graphviz
+  jobs:
+    pre_build:
+      # Generate on-the-fly Sphinx configuration from Jupyter Book's _config.yml
+      - "jupyter-book config sphinx docs/"
+
+python:
+   install:
+   - requirements: docs/requirements.txt
+#   - method: pip
+#     path: .
+
+formats:
+  - pdf
+  - epub

README.md

@@ -1,15 +1,29 @@
 # mlfz
-Machine Learning From Zero: an educational machine learning library.
+*Machine Learning From Zero: an educational machine learning library.*
 
-## Installation
+Hi there! `mlfz` is my attempt to provide reference implementations of machine learning algorithms for educational purposes. The goal is not performance, but simplicity: you won't just use this library; you'll dig through the source code to understand how machine learning works on the inside. [Check the documentation](https://mlfz.readthedocs.io/), which is written like an interactive textbook on the internals of machine learning and neural networks.
 
-You can install the package with
+If you find value in this project, support me by grabbing a copy of my [Mathematics of Machine Learning](https://tivadardanka.com/books/mathematics-of-machine-learning) book!
+
+## Quickstart
+
+You can install the package directly from pip:
 
 ```
 pip install mlfz
 ```
 
-To play around with the code, you can clone the repository and install locally via
+However, I encourage you to clone the repository and install via
 ```
 pip install -e .
 ```
+from the directory. This way, any local change is reflected immediately, so you can play around with the code in, say, a Jupyter Notebook.
+
+## Contributions
+
+Contributions are welcome! If you think you could make this project better, feel free to submit a PR. To make the process smooth, here are the steps you should take.
+
+1. Open an issue where we'll discuss your suggestions. If we are on the same page, you can start working on the PR. (And if we're not, you have saved yourself a ton of work.)
+2. Fork the repository and create a feature branch where you'll prepare the proposed changes.
+3. Open a PR to the `main` branch and tag me ([@cosmic-cortex](https://github.com/cosmic-cortex/)) as a reviewer.
+4. I'll either leave comments and suggestions, or merge the PR.

docs/01-machine-learning/wip.ipynb

@@ -0,0 +1,30 @@
+{
+ "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Work in progress"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "I'm focusing on putting together the neural network part first. Stay tuned!"
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}