asreview.models.balancers.Balanced#

class asreview.models.balancers.Balanced(ratio=1.0)[source]#

Bases: BaseEstimator

Balanced sample weight

Parameters:

ratio (float) – The ratio of the number of samples in class 0 to the number of samples in class 1.

Methods

__init__([ratio])

compute_sample_weight(y)

get_metadata_routing()

Get metadata routing of this object.

get_params([deep])

Get parameters for this estimator.

set_params(**params)

Set the parameters of this estimator.

Attributes

compute_sample_weight(y)[source]#
get_metadata_routing()#

Get metadata routing of this object.

Please check User Guide on how the routing mechanism works.

Returns:

routing (MetadataRequest) – A MetadataRequest encapsulating routing information.

get_params(deep=True)#

Get parameters for this estimator.

Parameters:

deep (bool, default=True) – If True, will return the parameters for this estimator and contained subobjects that are estimators.

Returns:

params (dict) – Parameter names mapped to their values.

label = 'Balanced Sample Weight'#
name = 'balanced'#
set_params(**params)#

Set the parameters of this estimator.

The method works on simple estimators as well as on nested objects (such as Pipeline). The latter have parameters of the form <component>__<parameter> so that it’s possible to update each component of a nested object.

Parameters:

**params (dict) – Estimator parameters.

Returns:

self (estimator instance) – Estimator instance.