asreview.models.stoppers.NLabeled

class asreview.models.stoppers.NLabeled(n)

Bases: BaseEstimator

Stop the review after n have been labeled.

Parameters:

n (int, tuple) – Number of labels to stop the review at. If tuple, the first element is the number of relevant records to find, the second element is the number of irrelevant records to find.

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 Labeled'

name = 'n_labeled'

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)