asreview.models.stoppers.NConsecutiveIrrelevant

class asreview.models.stoppers.NConsecutiveIrrelevant(n)

Bases: BaseEstimator

Stop the review after n irrelevant records have been labeled in a row.

Parameters:

n (int) – Number of irrelevant records in a row to stop the review at.

Methods

__init__(n)
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.
stop(results, data)

Attributes

label
name

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 = 'N Consecutive Irrelevant'

name = 'n_consecutive_irrelevant'

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.

stop(results, data)