API Reference

This is an example on how to document the API of your own project.

Estimator

TemplateEstimator([demo_param])

A template estimator to be used as a reference implementation.

Transformer

TemplateTransformer([demo_param])

An example transformer that returns the element-wise square root.

Predictor

TemplateClassifier([demo_param])

An example classifier which implements a 1-NN algorithm.

Utilities

utils.discovery.all_estimators([type_filter])	Get a list of all estimators from skltemplate.
utils.discovery.all_displays()	Get a list of all displays from skltemplate.
utils.discovery.all_functions()	Get a list of all functions from skltemplate.