pjml.data.evaluation.metric.Metric

class pjml.data.evaluation.metric.Metric(functions=None, target='Y', prediction='Z', **kwargs)

Metric to evaluate a given Data field.

Developer: new metrics can be added just following the pattern ‘_fun_xxxxx’ where xxxxx is the name of the new metric.

Parameters:

functions

Name of the function to use to evaluate data objects.

target

Name of the matrix with expected values.

prediction

Name of the matrix to be evaluated.

__init__(functions=None, target='Y', prediction='Z', **kwargs)

Initialize self. See help(type(self)) for accurate signature.

Methods

__init__([functions, target, prediction])	Initialize self.
default_config()	Create a copy of the component default configuration.
disable_pretty_printing()	Disable the pretty-printing.
dual_transform(train, …)
enable_pretty_printing()	Enable the pretty-printing.
function_from_name()	Map each function name to its corresponding class method.
names()
updated(**kwargs)	Clone this component, optionally replacing given params.

Attributes

cfserialized
cfuuid	UUID excluding ‘model’ and ‘enhance’ flags.
cs1	Convert component into a config space with a single component inside it.
enhancer
id	Short uuID First 8 chars of uuid, usually for printing purposes.
jsonable
longname
model
name
path
pretty_printing
serialized
sid	Short uuID First 6 chars of uuid, usually for printing purposes.
unwrap	Subpipeline inside the first Wrap().
uuid	Lazily calculated unique identifier for this dataset.
wrapped	Same as unwrap(), but with the external container Wrap.

cfuuid

UUID excluding ‘model’ and ‘enhance’ flags. Identifies the transformer.

cs1

Convert component into a config space with a single component inside it.

classmethod default_config() → Dict[str, Any]

Create a copy of the component default configuration.

Returns:

dict

Copy of the component default configuration.

disable_pretty_printing()

Disable the pretty-printing.

enable_pretty_printing()

Enable the pretty-printing.

classmethod function_from_name()

Map each function name to its corresponding class method.

id

Short uuID First 8 chars of uuid, usually for printing purposes. First collision expect after 12671943 combinations. :return:

sid

Short uuID First 6 chars of uuid, usually for printing purposes. :return:

unwrap

Subpipeline inside the first Wrap().

Hopefully there is only one Wrap in the pipeline. This method performs a depth-first search.

Examples

>>> pipe = Pipeline(
>>>     File(name='iris.arff'),
>>>     Wrap(Std(), SVMC()),
>>>     Metric(function='accuracy')
>>> )
>>> pipe.unwrap  # -> Chain(Std(), SVMC())

updated(**kwargs)

Clone this component, optionally replacing given params.

Returns:

A ready to use component.

uuid

Lazily calculated unique identifier for this dataset.

Should be accessed direct as a class member: ‘uuid’.

Returns:

A unique identifier UUID object.

wrapped

Same as unwrap(), but with the external container Wrap.