API Reference

Welcome to the API reference for skbase.

The API reference provides a technical manual, describing the class and function interface provided by the package. See the User Guide for additional details.

skbase contains tools for creating and working with parametric objects.

The included functionality makes it easy to re-use scikit-learn and sktime design principles in your project.

Base Classes

BaseObject()	Base class for parametric objects with sktime style tag interface.
BaseEstimator()	Base class for estimators with scikit-learn and sktime design patterns.

Object Retrieval

all_objects([object_types, filter_tags, ...])	Get a list of all estimators in the package with name package_name.
get_package_metadata(package_name[, path, ...])	Return a dictionary mapping all package modules to their metadata.

Testing

baseobject.testing provides a framework to test BaseObjects.

BaseFixtureGenerator()	Fixture generator for baseobject testing functionality.
QuickTester()	Mixin class which adds the run_tests method to run tests on one object.
TestAllObjects()	Package level tests for BaseObjects.