imanousar/ML-from-Scratch

Building ML models from scratch for practice. This project is under construction and will be constantly updated ...

Configs for libraries

python -m venv venv
source venv/Scripts/activate
pip install -r requirements.txt
pip install -e .

Configs for docs

pip install mkdocs
pip install mkdocs-material
pip install mkdocstrings[python]
cd mlfromscratch

Test locally

mkdocs serve

Deploy

mkdocs gh-deploy

Test docs

pytest mlfromscratch/tests/test_docs.py --verbose