Parameter and Custom Objects#

Parameter Annotations#

HyperParameter

Mark class attribute as a hyper-parameter for an algorithm or pipeline.

HyperPara

Mark class attribute as a hyper-parameter for an algorithm or pipeline.

OptimizableParameter

Mark class attribute as an optimizable parameter for an algorithm or pipeline.

OptiPara

Mark class attribute as an optimizable parameter for an algorithm or pipeline.

PureParameter

Mark a class attribute as pure parameter for an algorithm or pipeline.

PurePara

Mark a class attribute as pure parameter for an algorithm or pipeline.

Parameter

Mark class attribute as a simple parameter for an algorithm or pipeline.

Para

Mark class attribute as a simple parameter for an algorithm or pipeline.

Utility functions#

clone(algorithm, *[, safe])

Construct a new algorithm object with the same parameters.

cf(default_value)

Wrap mutable default value with the CloneFactory.

Utility classes#

BaseTpcpObject()

Baseclass for all tpcp objects.

CloneFactory(default_value)

Init factory that creates a clone of the provided default values on instance initialisation.

BaseFactory()

Baseclass for factories to circumvent mutable defaults.