capability__contractable#

capability__contractable()[source]#

Capability: the estimator can be asked to satisfy a maximum time contract.

To avoid confusion, users should note that the literature term “contractable” unusually derives its meaning from “contract”, i.e., a time contract, and not from “contraction”, i.e., reducing the size of something.

  • String name: "capability:contractable"

  • Public capability tag

  • Values: boolean, True / False

  • Example: True

  • Default: False

If the tag is True, the estimator can be contracted in time, by using some of its parameters, to limit the maximum time spent in fitting.

Currently, there is no unified naming or selection of parameters controlling the contract time setting, as this can apply to different parts of the algorithm. Users should consult the documentation of the specific estimator for details.

If the tag is False, the estimator does not support a contract time setting.