mvpa2.clfs.meta.TreeClassifier¶

class mvpa2.clfs.meta.TreeClassifier(clf, groups, **kwargs)¶

TreeClassifier which allows to create hierarchy of classifiers

Functions by grouping some labels into a single “meta-label” and training classifier first to separate between meta-labels. Then each group further proceeds with classification within each group.

Possible scenarios:

TreeClassifier(SVM(),
 {'animate':  ((1,2,3,4),
               TreeClassifier(SVM(),
                   {'human': (('male', 'female'), SVM()),
                    'animals': (('monkey', 'dog'), SMLR())})),
  'inanimate': ((5,6,7,8), SMLR())})

would create classifier which would first do binary classification to separate animate from inanimate, then for animate result it would separate to classify human vs animal and so on:

                 SVM
               /                                 animate  inanimate
           /                                       SVM            SMLR
       /     \         / | \                     human    animal     5  6 7  8
   |          |
  SVM        SVM
 /   \       /                   male female monkey dog
1      2    3      4

If it is desired to have a trailing node with a single label and thus without any classification, such as in

SVM

/ g1 g2

/ 1 SVM

/ 2 3

then just specify None as the classifier to use:

TreeClassifier(SVM(),
   {'g1':  ((1,), None),
    'g2':  ((1,2,3,4), SVM())})

Notes

Available conditional attributes:

calling_time+: Time (in seconds) it took to call the node
estimates+: Internal classifier estimates the most recent predictions are based on
predicting_time+: Time (in seconds) which took classifier to predict
predictions+: Most recent set of predictions
raw_results: Computed results before invoking postproc. Stored only if postproc is not None.
trained_dataset: The dataset it has been trained on
trained_nsamples+: Number of samples it has been trained on
trained_targets+: Set of unique targets (or any other space) it has been trained on (if present in the dataset trained on)
training_stats: Confusion matrix of learning performance
training_time+: Time (in seconds) it took to train the learner

(Conditional attributes enabled by default suffixed with +)

Attributes

`auto_train`	Whether the Learner performs automatic trainingwhen called untrained.
`clf`	Used `Classifier`
`descr`	Description of the object if any
`force_train`	Whether the Learner enforces training upon every call.
`pass_attr`	Which attributes of the dataset or self.ca to pass into result dataset upon call
`postproc`	Node to perform post-processing of results
`space`	Processing space name of this node
`trained`	Either classifier was already trained

Methods

`__call__`(ds)
`clone`()	Create full copy of the classifier.
`generate`(ds)	Yield processing results.
`get_postproc`()	Returns the post-processing node or None.
`get_sensitivity_analyzer`(\args_, \\*kwargs_)
`get_space`()	Query the processing space name of this node.
`is_trained`([dataset])	Either classifier was already trained.
`predict`(obj, data, \args, \\*kwargs)
`repredict`(obj, data, \args, \\*kwargs)
`reset`()
`retrain`(dataset, \\kwargs)	Helper to avoid check if data was changed actually changed
`set_postproc`(node)	Assigns a post-processing node
`set_space`(name)	Set the processing space name of this node.
`summary`()	Provide summary for the `TreeClassifier`.
`train`(ds)	The default implementation calls `_pretrain()`, `_train()`, and finally `_posttrain()`.
`untrain`()	Reverts changes in the state of this node caused by previous training

Initialize TreeClassifier

Parameters:

clf : Classifier

Classifier to separate between the groups

groups : dict of meta-label: tuple of (tuple of labels, classifier)

Defines the groups of labels and their classifiers. See TreeClassifier for example

enable_ca : None or list of str

Names of the conditional attributes which should be enabled in addition to the default ones

disable_ca : None or list of str

Names of the conditional attributes which should be disabled

auto_train : bool

Flag whether the learner will automatically train itself on the input dataset when called untrained.

force_train : bool

Flag whether the learner will enforce training on the input dataset upon every call.

space : str, optional

Name of the ‘processing space’. The actual meaning of this argument heavily depends on the sub-class implementation. In general, this is a trigger that tells the node to compute and store information about the input data that is “interesting” in the context of the corresponding processing in the output dataset.

pass_attr : str, list of str|tuple, optional

Additional attributes to pass on to an output dataset. Attributes can be taken from all three attribute collections of an input dataset (sa, fa, a – see Dataset.get_attr()), or from the collection of conditional attributes (ca) of a node instance. Corresponding collection name prefixes should be used to identify attributes, e.g. ‘ca.null_prob’ for the conditional attribute ‘null_prob’, or ‘fa.stats’ for the feature attribute stats. In addition to a plain attribute identifier it is possible to use a tuple to trigger more complex operations. The first tuple element is the attribute identifier, as described before. The second element is the name of the target attribute collection (sa, fa, or a). The third element is the axis number of a multidimensional array that shall be swapped with the current first axis. The fourth element is a new name that shall be used for an attribute in the output dataset. Example: (‘ca.null_prob’, ‘fa’, 1, ‘pvalues’) will take the conditional attribute ‘null_prob’ and store it as a feature attribute ‘pvalues’, while swapping the first and second axes. Simplified instructions can be given by leaving out consecutive tuple elements starting from the end.

postproc : Node instance, optional

Node to perform post-processing of results. This node is applied in __call__() to perform a final processing step on the to be result dataset. If None, nothing is done.

descr : str

Description of the instance

Attributes

`auto_train`	Whether the Learner performs automatic trainingwhen called untrained.
`clf`	Used `Classifier`
`descr`	Description of the object if any
`force_train`	Whether the Learner enforces training upon every call.
`pass_attr`	Which attributes of the dataset or self.ca to pass into result dataset upon call
`postproc`	Node to perform post-processing of results
`space`	Processing space name of this node
`trained`	Either classifier was already trained

Methods

`__call__`(ds)
`clone`()	Create full copy of the classifier.
`generate`(ds)	Yield processing results.
`get_postproc`()	Returns the post-processing node or None.
`get_sensitivity_analyzer`(\args_, \\*kwargs_)
`get_space`()	Query the processing space name of this node.
`is_trained`([dataset])	Either classifier was already trained.
`predict`(obj, data, \args, \\*kwargs)
`repredict`(obj, data, \args, \\*kwargs)
`reset`()
`retrain`(dataset, \\kwargs)	Helper to avoid check if data was changed actually changed
`set_postproc`(node)	Assigns a post-processing node
`set_space`(name)	Set the processing space name of this node.
`summary`()	Provide summary for the `TreeClassifier`.
`train`(ds)	The default implementation calls `_pretrain()`, `_train()`, and finally `_posttrain()`.
`untrain`()	Reverts changes in the state of this node caused by previous training

clfs = None¶: Dictionary of classifiers used by the groups

summary()¶: Provide summary for the TreeClassifier.