Table Of Contents

Previous topic

mvpa.misc.data_generators

Next topic

mvpa.misc.exceptions

This Page

Quick search

mvpa.misc.errorfx

Error functions helpers.

PyMVPA can use arbitrary function which takes 2 arguments: predictions and targets and spits out a scalar value. Functions below are for the convinience, and they confirm the agreement that ‘smaller’ is ‘better’

The comprehensive API documentation for this module, including all technical details, is available in the Epydoc-generated API reference for mvpa.misc.errorfx (for developers).

Classes

AUCErrorFx

class mvpa.misc.errorfx.AUCErrorFx

Bases: mvpa.misc.errorfx._ErrorFx

Computes the area under the ROC for the given the target and predicted to make the prediction.

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the AUCErrorFx documentation.

Full API documentation of AUCErrorFx in module mvpa.misc.errorfx.

MeanMismatchErrorFx

class mvpa.misc.errorfx.MeanMismatchErrorFx

Bases: mvpa.misc.errorfx._ErrorFx

Computes the percentage of mismatches between some target and some predicted values.

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the MeanMismatchErrorFx documentation.

Full API documentation of MeanMismatchErrorFx in module mvpa.misc.errorfx.

RMSErrorFx

class mvpa.misc.errorfx.RMSErrorFx

Bases: mvpa.misc.errorfx._ErrorFx

Computes the root mean squared error of some target and some predicted values.

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the RMSErrorFx documentation.

Full API documentation of RMSErrorFx in module mvpa.misc.errorfx.

RelativeRMSErrorFx

class mvpa.misc.errorfx.RelativeRMSErrorFx

Bases: mvpa.misc.errorfx._ErrorFx

Ratio between RMSE and root mean power of target output.

So it can be considered as a scaled RMSE – perfect reconstruction has values near 0, while no reconstruction has values around 1.0. Word of caution – it is not commutative, ie exchange of predicted and target might lead to completely different answers

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the RelativeRMSErrorFx documentation.

Full API documentation of RelativeRMSErrorFx in module mvpa.misc.errorfx.

Variance1SVFx

class mvpa.misc.errorfx.Variance1SVFx

Bases: mvpa.misc.errorfx._ErrorFx

Ratio of variance described by the first singular value component.

Of limited use – left for the sake of not wasting it

See also

Derived classes might provide additional methods via their base classes. Please refer to the list of base classes (if it exists) at the begining of the Variance1SVFx documentation.

Full API documentation of Variance1SVFx in module mvpa.misc.errorfx.

Functions

mvpa.misc.errorfx.meanPowerFx(data)

Returns mean power

Similar to var but without demeaning

See also

Full API documentation of meanPowerFx() in module mvpa.misc.errorfx.

mvpa.misc.errorfx.rootMeanPowerFx(data)

Returns root mean power

to be comparable against RMSE

See also

Full API documentation of rootMeanPowerFx() in module mvpa.misc.errorfx.