Skip to content

Latest commit

 

History

History
430 lines (252 loc) · 12.7 KB

OneVsOneClassifier.md

File metadata and controls

430 lines (252 loc) · 12.7 KB

OneVsOneClassifier

One-vs-one multiclass strategy.

This strategy consists in fitting one classifier per class pair. At prediction time, the class which received the most votes is selected. Since it requires to fit n\_classes \* (n\_classes \- 1) / 2 classifiers, this method is usually slower than one-vs-the-rest, due to its O(n_classes^2) complexity. However, this method may be advantageous for algorithms such as kernel algorithms which don’t scale well with n\_samples. This is because each individual learning problem only involves a small subset of the data whereas, with one-vs-the-rest, the complete dataset is used n\_classes times.

Read more in the User Guide.

Python Reference

Constructors

constructor()

Signature

new OneVsOneClassifier(opts?: object): OneVsOneClassifier;

Parameters

Name Type Description
opts? object -
opts.estimator? any A regressor or a classifier that implements fit. When a classifier is passed, decision_function will be used in priority and it will fallback to predict_proba if it is not available. When a regressor is passed, predict is used.
opts.n_jobs? number The number of jobs to use for the computation: the n\_classes \* ( n\_classes \- 1) / 2 OVO problems are computed in parallel. undefined means 1 unless in a joblib.parallel\_backend context. \-1 means using all processors. See Glossary for more details.

Returns

OneVsOneClassifier

Defined in: generated/multiclass/OneVsOneClassifier.ts:25

Methods

decision_function()

Decision function for the OneVsOneClassifier.

The decision values for the samples are computed by adding the normalized sum of pair-wise classification confidence levels to the votes in order to disambiguate between the decision values when the votes for all the classes are equal leading to a tie.

Signature

decision_function(opts: object): Promise<ArrayLike[]>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike[] Input data.

Returns

Promise<ArrayLike[]>

Defined in: generated/multiclass/OneVsOneClassifier.ts:118

dispose()

Disposes of the underlying Python resources.

Once dispose() is called, the instance is no longer usable.

Signature

dispose(): Promise<void>;

Returns

Promise<void>

Defined in: generated/multiclass/OneVsOneClassifier.ts:99

fit()

Fit underlying estimators.

Signature

fit(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike Data.
opts.y? ArrayLike Multi-class targets.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:156

get_metadata_routing()

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Signature

get_metadata_routing(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.routing? any A MetadataRequest encapsulating routing information.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:200

init()

Initializes the underlying Python resources.

This instance is not usable until the Promise returned by init() resolves.

Signature

init(py: PythonBridge): Promise<void>;

Parameters

Name Type
py PythonBridge

Returns

Promise<void>

Defined in: generated/multiclass/OneVsOneClassifier.ts:55

partial_fit()

Partially fit underlying estimators.

Should be used when memory is inefficient to train all data. Chunks of data can be passed in several iteration, where the first call should have an array of all target variables.

Signature

partial_fit(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.X? any[] Data.
opts.classes? any Classes across all calls to partial_fit. Can be obtained via np.unique(y\_all), where y_all is the target vector of the entire dataset. This argument is only required in the first call of partial_fit and can be omitted in the subsequent calls.
opts.y? ArrayLike Multi-class targets.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:240

predict()

Estimate the best class label for each sample in X.

This is implemented as argmax(decision\_function(X), axis=1) which will return the label of the class with most votes by estimators predicting the outcome of a decision for each possible class pair.

Signature

predict(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike Data.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:293

score()

Return the mean accuracy on the given test data and labels.

In multi-label classification, this is the subset accuracy which is a harsh metric since you require for each sample that each label set be correctly predicted.

Signature

score(opts: object): Promise<number>;

Parameters

Name Type Description
opts object -
opts.X? ArrayLike[] Test samples.
opts.sample_weight? ArrayLike Sample weights.
opts.y? ArrayLike True labels for X.

Returns

Promise<number>

Defined in: generated/multiclass/OneVsOneClassifier.ts:330

set_partial_fit_request()

Request metadata passed to the partial\_fit method.

Note that this method is only relevant if enable\_metadata\_routing=True (see sklearn.set\_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

Signature

set_partial_fit_request(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.classes? string | boolean Metadata routing for classes parameter in partial\_fit.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:383

set_score_request()

Request metadata passed to the score method.

Note that this method is only relevant if enable\_metadata\_routing=True (see sklearn.set\_config). Please see User Guide on how the routing mechanism works.

The options for each parameter are:

Signature

set_score_request(opts: object): Promise<any>;

Parameters

Name Type Description
opts object -
opts.sample_weight? string | boolean Metadata routing for sample\_weight parameter in score.

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:425

Properties

_isDisposed

boolean = false

Defined in: generated/multiclass/OneVsOneClassifier.ts:23

_isInitialized

boolean = false

Defined in: generated/multiclass/OneVsOneClassifier.ts:22

_py

PythonBridge

Defined in: generated/multiclass/OneVsOneClassifier.ts:21

id

string

Defined in: generated/multiclass/OneVsOneClassifier.ts:18

opts

any

Defined in: generated/multiclass/OneVsOneClassifier.ts:19

Accessors

classes_

Array containing labels.

Signature

classes_(): Promise<any>;

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:490

estimators_

Estimators used for predictions.

Signature

estimators_(): Promise<any>;

Returns

Promise<any>

Defined in: generated/multiclass/OneVsOneClassifier.ts:463

feature_names_in_

Names of features seen during fit. Defined only when X has feature names that are all strings.

Signature

feature_names_in_(): Promise<ArrayLike>;

Returns

Promise<ArrayLike>

Defined in: generated/multiclass/OneVsOneClassifier.ts:571

n_features_in_

Number of features seen during fit.

Signature

n_features_in_(): Promise<number>;

Returns

Promise<number>

Defined in: generated/multiclass/OneVsOneClassifier.ts:544

pairwise_indices_

Indices of samples used when training the estimators. undefined when estimator’s pairwise tag is false.

Signature

pairwise_indices_(): Promise<any[]>;

Returns

Promise<any[]>

Defined in: generated/multiclass/OneVsOneClassifier.ts:517

py

Signature

py(): PythonBridge;

Returns

PythonBridge

Defined in: generated/multiclass/OneVsOneClassifier.ts:42

Signature

py(pythonBridge: PythonBridge): void;

Parameters

Name Type
pythonBridge PythonBridge

Returns

void

Defined in: generated/multiclass/OneVsOneClassifier.ts:46