API Reference

Data and datasets

Read data

ASReviewData
load_data

Statistics

data.statistics.abstract_length
data.statistics.n_duplicates
data.statistics.n_irrelevant
data.statistics.n_keywords
data.statistics.n_missing_abstract
data.statistics.n_missing_title
data.statistics.n_records
data.statistics.n_relevant
data.statistics.n_unlabeled
data.statistics.title_length

Datasets

Available datasets

asreview.datasets.BenchmarkDataGroup
asreview.datasets.NaturePublicationDataGroup

Dataset managers

asreview.datasets.BaseDataSet
asreview.datasets.BaseDataGroup
asreview.datasets.DatasetManager

Reviewer

review.BaseReview
review.ReviewSimulate

Models

Base class

models.base.BaseModel

asreview.models.balance

Classes

balance.base.BaseBalance
balance.SimpleBalance
balance.DoubleBalance
balance.TripleBalance
balance.UndersampleBalance

Functions

balance.get_balance_model
balance.get_balance_class
balance.list_balance_strategies

asreview.models.classifiers

Classes

classifiers.base.BaseTrainClassifier
classifiers.NaiveBayesClassifier
classifiers.RandomForestClassifier
classifiers.SVMClassifier
classifiers.LogisticClassifier
classifiers.LSTMBaseClassifier
classifiers.LSTMPoolClassifier
classifiers.NN2LayerClassifier

Functions

classifiers.get_classifier
classifiers.get_classifier_class
classifiers.list_classifiers

asreview.models.feature_extraction

Classes

feature_extraction.base.BaseFeatureExtraction
feature_extraction.Tfidf
feature_extraction.Doc2Vec
feature_extraction.EmbeddingIdf
feature_extraction.EmbeddingLSTM
feature_extraction.SBERT

Functions

feature_extraction.get_feature_model
feature_extraction.get_feature_class
feature_extraction.list_feature_extraction

asreview.models.query

Classes

query.base.BaseQueryStrategy
query.base.ProbaQueryStrategy
query.MaxQuery
query.MixedQuery
query.MaxRandomQuery
query.MaxUncertaintyQuery
query.UncertaintyQuery
query.RandomQuery
query.ClusterQuery

Functions

query.get_query_model
query.get_query_class
query.list_query_strategies

Projects and States

Load, interact, and extract information from project files and states (the “diary” of the review).

ASReviewProject

ASReviewProject

State

open_state
state.SQLiteState

Utils

project.get_project_path
project.project_from_id
project.list_asreview_projects
project.is_project
project.is_v0_project

Readers and writers

This module contains the input and output functionality. You can install them as extensions.

asreview.list_readers
asreview.list_writers
io.CSVReader
io.CSVWriter
io.ExcelReader
io.ExcelWriter
io.PaperRecord
io.RISReader
io.RISWriter
io.TSVWriter

Misc

Classes

asreview.settings.ASReviewSettings

Functions

asreview.search.fuzzy_find
asreview.asreview_path
asreview.get_data_home

Entry points

Entry points for ASReview LAB.

entry_points.BaseEntryPoint
entry_points.AlgorithmsEntryPoint
entry_points.LABEntryPoint
entry_points.SimulateEntryPoint
entry_points.StateInspectEntryPoint