kde-learn

Installation

conda create -n kde-learn python=3.9.12
conda activate kde-learn

pip install -e .

Code Prettifiers

black {source_file_or_directory}
flake8 {source_file_or_directory}
isort {source_file_or_directory}

They are also executed as a pre-commit hooks. See more in .pre-commit-config.yaml.

Useful links:

• Using black with other tools

Unit tests

Basic pytest usage:

pytest tests/

with coverage

pytest tests/ --cov=kdelearn/ --cov-report term-missing

Sphinx

Useful links:

• style guide
• style guide2

Create the documentation

Docstrings inspired on scikit-learn.

cd docs/
make clean
make html

Publish on readthedocs.org

1. Log in with GitHub credentials
2. Import a project
3. Build the project

Convert notebook into pdf

jupyter nbconvert --to pdf --no-input example_notebook.ipynb