asreview.models.stoppers.LastRelevant

class asreview.models.stoppers.LastRelevant

Bases: BaseEstimator

Stop after last relevant record.

The stopping mechanism stops the review when all records have been labeled.

Parameters:

value (int, str) – Number of labels to stop the review at. If set to “min”, the review will stop when all relevant records are found.

Methods

__init__()
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 = 'Last Relevant'

name = 'last_relevant'

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)