[DOC] better package description in readme - what are skbase
"patterns"
#109
Labels
documentation
Documentation & tutorials
skbase
"patterns"
#109
I think the readme and landing page should describe more clearly what patterns
skbase
provides.I would go with an abridged version of the
BaseObject
design document, from herehttps://github.com/sktime/skbase/pull/76/files
Here's an unabridged copy-paste:
BaseObject
BaseObjects are base classes with:
scikit-learn
style interface to get and set parameterssktime
style interface for working with tagssktime
style interface for cloning and re-instantiation (resetting)sktime
style interface for generating test instancessktime
style interface for retrieving fitted parametersscikit-learn
style interface for representing objects (e.g., pretty printingand drawing a simple block representation in HTML)
BaseObject
s,including the ability to get and set the parameters of component
BaseObject
sBaseObject
s should also follow certain design patterns and coding practices,including:
__init__
as explicit keyword arguments.No
args
orkwargs
should be used to set class parameters.These should be documented in the parameters section of the docstring, and not
documented in the attributes section of the docstring.
__init__
. If the attributeis not assigned a value until later, initialize it as None.
in an underscore to easily communicate that they are "state" dependent.
(per standard Python conventions).
attributes section.
The text was updated successfully, but these errors were encountered: