tpcp.Algorithm#

class tpcp.Algorithm[source]#

Base class for all algorithms.

All type-specific algorithm classes should inherit from this class and need to

  1. overwrite _action_method with the name of the actual action method of this class type

  2. implement a stub for the action method

Attributes
_action_methods

The name(s) of the action method used by the child class

Methods

clone()

Create a new instance of the class with all parameters copied over.

get_params([deep])

Get parameters for this algorithm.

set_params(**params)

Set the parameters of this Algorithm.

__init__(*args, **kwargs)#
clone() typing_extensions.Self[source]#

Create a new instance of the class with all parameters copied over.

This will create a new instance of the class itself and all nested objects

get_params(deep: bool = True) Dict[str, Any][source]#

Get parameters for this algorithm.

Parameters
deep

Only relevant if object contains nested algorithm objects. If this is the case and deep is True, the params of these nested objects are included in the output using a prefix like nested_object_name__ (Note the two “_” at the end)

Returns
params

Parameter names mapped to their values.

set_params(**params: Any) typing_extensions.Self[source]#

Set the parameters of this Algorithm.

To set parameters of nested objects use nested_object_name__para_name=.

Examples using tpcp.Algorithm#