capability__update#

capability__update()[source]#

Capability: whether the estimator can be run in stream or on-line mode.

String name: "capability:update"
Public capability tag
Values: boolean, True / False
Example: True
Default: False

The tag specifies whether the estimator can be run in stream or on-line mode, with an update method. Depending on the estimator type, literature may refer to this as on-line learning, incremental learning, or stream learning.

If the tag is True, the update method is implemented and can be used to update the estimator with new data, without re-fitting the entire model.

If the tag is False, behaviour depends on the estimator type, two common cases are:

update will raise an exception. Compositors may be available to add on-line learning capabilities, these are typically listed in the exception message.
update will not raise an exception but carry out a reasonable default, such as a full re-fit, or discard the new data.

For the exact behaviour, users should consult the documentation of the respective update method.