Project template for scikit-learn extension#
Date: May 01, 2024 Version: 0.1.1
Useful links: Source Repository | Issues & Ideas |
This is the documentation for the project-template to help at extending
scikit-learn. It provides some information on how to build your own custom
scikit-learn compatible estimators as well as a template to package them.
Getting started
Information regarding this template and how to modify it for your own project.
User guide
An example of narrative documentation. Here, we will explain how to create your own scikit-learn estimator.
API reference
An example of API documentation. This is an example how to use sphinx to automatically generate reference API page.
Examples
A set of examples. It complements the User Guide and it is the right place to show how to use your compatible estimator.