Index

Symbols

--clean_all_projects CLEAN_ALL_PROJECTS asreview-lab command line option --clean_project CLEAN_PROJECT asreview-lab command line option --config_file CONFIG_FILE asreview-simulate command line option --embedding EMBEDDING_FP asreview-lab command line option asreview-simulate command line option --excluded_dataset [EXCLUDED_DATASET [EXCLUDED_DATASET ...]] asreview-simulate command line option --included_dataset [INCLUDED_DATASET [INCLUDED_DATASET ...]] asreview-simulate command line option --init_seed INIT_SEED asreview-simulate command line option --ip IP asreview-lab command line option --n_instances N_INSTANCES asreview-simulate command line option --n_prior_excluded N_PRIOR_EXCLUDED asreview-simulate command line option --n_prior_included N_PRIOR_INCLUDED asreview-simulate command line option --n_queries N_QUERIES asreview-simulate command line option --n_runs asreview-simulate-batch command line option

--port PORT asreview-lab command line option --prior_dataset [PRIOR_DATASET [PRIOR_DATASET ...]] asreview-simulate command line option --prior_idx [PRIOR_IDX [PRIOR_IDX ...]] asreview-simulate command line option --prior_record_id [PRIOR_RECORD_ID [PRIOR_RECORD_ID ...]] asreview-simulate command line option --seed SEED asreview-lab command line option asreview-simulate command line option --state_file STATE_FILE, -s STATE_FILE asreview-simulate command line option --verbose VERBOSE, -v VERBOSE asreview-simulate command line option -b, --balance_strategy BALANCE_STRATEGY asreview-simulate command line option -e, --feature_extraction FEATURE_EXTRACTION asreview-simulate command line option -h, --help asreview-lab command line option asreview-simulate command line option -m, --model MODEL asreview-simulate command line option -n N_PAPERS, --n_papers N_PAPERS asreview-simulate command line option -q, --query_strategy QUERY_STRATEGY asreview-simulate command line option

A

add_classification() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) add_proba() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) Analysis (class in asreview.analysis) append() (asreview.ASReviewData method) asreview-lab command line option --clean_all_projects CLEAN_ALL_PROJECTS --clean_project CLEAN_PROJECT --embedding EMBEDDING_FP --ip IP --port PORT --seed SEED -h, --help asreview-simulate command line option --config_file CONFIG_FILE --embedding EMBEDDING_FP --excluded_dataset [EXCLUDED_DATASET [EXCLUDED_DATASET ...]] --included_dataset [INCLUDED_DATASET [INCLUDED_DATASET ...]] --init_seed INIT_SEED --n_instances N_INSTANCES --n_prior_excluded N_PRIOR_EXCLUDED --n_prior_included N_PRIOR_INCLUDED --n_queries N_QUERIES --prior_dataset [PRIOR_DATASET [PRIOR_DATASET ...]] --prior_idx [PRIOR_IDX [PRIOR_IDX ...]] --prior_record_id [PRIOR_RECORD_ID [PRIOR_RECORD_ID ...]] --seed SEED --state_file STATE_FILE, -s STATE_FILE --verbose VERBOSE, -v VERBOSE -b, --balance_strategy BALANCE_STRATEGY -e, --feature_extraction FEATURE_EXTRACTION -h, --help -m, --model MODEL -n N_PAPERS, --n_papers N_PAPERS -q, --query_strategy QUERY_STRATEGY dataset

asreview-simulate-batch command line option --n_runs dataset ASReviewData (class in asreview) avg_time_to_discovery() (asreview.analysis.Analysis method)

B

BaseEntryPoint (class in asreview.entry_points)

BaseReview (class in asreview.review) BaseState (class in asreview.state)

C

classify() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) close() (asreview.analysis.Analysis method) (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

ClusterQuery (class in asreview.models.query)

D

dataset asreview-simulate command line option asreview-simulate-batch command line option default_param (asreview.models.balance.DoubleBalance attribute) (asreview.models.balance.SimpleBalance attribute) (asreview.models.balance.TripleBalance attribute) (asreview.models.balance.UndersampleBalance attribute) (asreview.models.classifiers.LSTMBaseClassifier attribute) (asreview.models.classifiers.LSTMPoolClassifier attribute) (asreview.models.classifiers.LogisticClassifier attribute) (asreview.models.classifiers.NN2LayerClassifier attribute) (asreview.models.classifiers.NaiveBayesClassifier attribute) (asreview.models.classifiers.RandomForestClassifier attribute) (asreview.models.classifiers.SVMClassifier attribute) (asreview.models.feature_extraction.Doc2Vec attribute) (asreview.models.feature_extraction.EmbeddingIdf attribute) (asreview.models.feature_extraction.EmbeddingLSTM attribute) (asreview.models.feature_extraction.SBERT attribute) (asreview.models.feature_extraction.Tfidf attribute) (asreview.models.query.ClusterQuery attribute) (asreview.models.query.MaxQuery attribute) (asreview.models.query.MixedQuery attribute) (asreview.models.query.RandomQuery attribute) (asreview.models.query.UncertaintyQuery attribute)

delete_last_query() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) DictState (class in asreview.state) Doc2Vec (class in asreview.models.feature_extraction) DoubleBalance (class in asreview.models.balance)

E

EmbeddingIdf (class in asreview.models.feature_extraction)

EmbeddingLSTM (class in asreview.models.feature_extraction) execute() (asreview.entry_points.BaseEntryPoint class method)

F

fit() (asreview.models.classifiers.LogisticClassifier method) (asreview.models.classifiers.LSTMBaseClassifier method) (asreview.models.classifiers.LSTMPoolClassifier method) (asreview.models.classifiers.NN2LayerClassifier method) (asreview.models.classifiers.NaiveBayesClassifier method) (asreview.models.classifiers.RandomForestClassifier method) (asreview.models.classifiers.SVMClassifier method) (asreview.models.feature_extraction.Doc2Vec method) (asreview.models.feature_extraction.EmbeddingIdf method) (asreview.models.feature_extraction.EmbeddingLSTM method) (asreview.models.feature_extraction.SBERT method) (asreview.models.feature_extraction.Tfidf method) fit_transform() (asreview.models.feature_extraction.Doc2Vec method) (asreview.models.feature_extraction.EmbeddingIdf method) (asreview.models.feature_extraction.EmbeddingLSTM method) (asreview.models.feature_extraction.SBERT method) (asreview.models.feature_extraction.Tfidf method)

format() (asreview.entry_points.BaseEntryPoint method) from_dir() (asreview.analysis.Analysis class method) from_file() (asreview.analysis.Analysis class method) (asreview.ASReviewData class method) from_path() (asreview.analysis.Analysis class method) full_hyper_space() (asreview.models.classifiers.LogisticClassifier method) (asreview.models.classifiers.LSTMBaseClassifier method) (asreview.models.classifiers.LSTMPoolClassifier method) (asreview.models.classifiers.NN2LayerClassifier method) (asreview.models.classifiers.NaiveBayesClassifier method) (asreview.models.classifiers.RandomForestClassifier method) (asreview.models.classifiers.SVMClassifier method)

G

get() (asreview.ASReviewData method) (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) get_balance_class() (in module asreview.models.balance) get_balance_model() (in module asreview.models.balance) get_classifier() (in module asreview.models.classifiers) get_classifier_class() (in module asreview.models.classifiers) get_current_queries() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

get_feature_class() (in module asreview.models.feature_extraction) get_feature_matrix() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) get_feature_model() (in module asreview.models.feature_extraction) get_query_class() (in module asreview.models.query) get_query_model() (in module asreview.models.query)

H

hash() (asreview.ASReviewData method)

HDF5State (class in asreview.state)

I

inclusions_found() (asreview.analysis.Analysis method) initialize_structure() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

is_empty() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

J

JSONState (class in asreview.state)

L

limits() (asreview.analysis.Analysis method) list_balance_strategies() (in module asreview.models.balance) list_classifiers() (in module asreview.models.classifiers) list_feature_extraction() (in module asreview.models.feature_extraction) list_query_strategies() (in module asreview.models.query)

load_embedding() (in module asreview) log_probabilities() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) LogisticClassifier (class in asreview.models.classifiers) LSTMBaseClassifier (class in asreview.models.classifiers) LSTMPoolClassifier (class in asreview.models.classifiers)

M

MaxQuery (class in asreview.models.query)

MixedQuery (class in asreview.models.query)

N

n_pool() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) n_queries() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

NaiveBayesClassifier (class in asreview.models.classifiers) name (asreview.models.query.MixedQuery attribute) NN2LayerClassifier (class in asreview.models.classifiers)

O

open_state() (in module asreview.state)

P

param (asreview.models.balance.DoubleBalance attribute) (asreview.models.balance.SimpleBalance attribute) (asreview.models.balance.TripleBalance attribute) (asreview.models.balance.UndersampleBalance attribute) (asreview.models.classifiers.LSTMBaseClassifier attribute) (asreview.models.classifiers.LSTMPoolClassifier attribute) (asreview.models.classifiers.LogisticClassifier attribute) (asreview.models.classifiers.NN2LayerClassifier attribute) (asreview.models.classifiers.NaiveBayesClassifier attribute) (asreview.models.classifiers.RandomForestClassifier attribute) (asreview.models.classifiers.SVMClassifier attribute) (asreview.models.feature_extraction.Doc2Vec attribute) (asreview.models.feature_extraction.EmbeddingIdf attribute) (asreview.models.feature_extraction.EmbeddingLSTM attribute) (asreview.models.feature_extraction.SBERT attribute) (asreview.models.feature_extraction.Tfidf attribute) (asreview.models.query.ClusterQuery attribute) (asreview.models.query.MaxQuery attribute) (asreview.models.query.MixedQuery attribute) (asreview.models.query.RandomQuery attribute) (asreview.models.query.UncertaintyQuery attribute)

pred_proba (asreview.state.BaseState attribute) (asreview.state.DictState attribute) (asreview.state.HDF5State attribute) (asreview.state.JSONState attribute) predict_proba() (asreview.models.classifiers.LogisticClassifier method) (asreview.models.classifiers.LSTMBaseClassifier method) (asreview.models.classifiers.LSTMPoolClassifier method) (asreview.models.classifiers.NN2LayerClassifier method) (asreview.models.classifiers.NaiveBayesClassifier method) (asreview.models.classifiers.RandomForestClassifier method) (asreview.models.classifiers.SVMClassifier method) prior_data_idx (asreview.ASReviewData attribute) prior_labels() (asreview.ASReviewData method)

Q

query() (asreview.models.query.ClusterQuery method) (asreview.ReviewSimulate method) (asreview.models.query.MaxQuery method) (asreview.models.query.MixedQuery method) (asreview.models.query.RandomQuery method) (asreview.models.query.UncertaintyQuery method) (asreview.review.BaseReview method)

R

RandomForestClassifier (class in asreview.models.classifiers) RandomQuery (class in asreview.models.query) record() (asreview.ASReviewData method) restore() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

review() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) ReviewSimulate (class in asreview) rrf() (asreview.analysis.Analysis method)

S

sample() (asreview.models.balance.DoubleBalance method) (asreview.models.balance.SimpleBalance method) (asreview.models.balance.TripleBalance method) (asreview.models.balance.UndersampleBalance method) sample_embedding() (in module asreview) save() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) SBERT (class in asreview.models.feature_extraction) set_current_queries() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) set_final_labels() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method)

set_labels() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) settings (asreview.review.BaseReview attribute) (asreview.ReviewSimulate attribute) (asreview.state.BaseState attribute) (asreview.state.DictState attribute) (asreview.state.HDF5State attribute) (asreview.state.JSONState attribute) SimpleBalance (class in asreview.models.balance) slice() (asreview.ASReviewData method) startup_vals() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) statistics() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) SVMClassifier (class in asreview.models.classifiers)

T

Tfidf (class in asreview.models.feature_extraction) to_csv() (asreview.ASReviewData method) to_dataframe() (asreview.ASReviewData method) to_dict() (asreview.state.BaseState method) (asreview.state.DictState method) (asreview.state.HDF5State method) (asreview.state.JSONState method) to_excel() (asreview.ASReviewData method)

to_file() (asreview.ASReviewData method) train() (asreview.review.BaseReview method) (asreview.ReviewSimulate method) transform() (asreview.models.feature_extraction.Doc2Vec method) (asreview.models.feature_extraction.EmbeddingIdf method) (asreview.models.feature_extraction.EmbeddingLSTM method) (asreview.models.feature_extraction.SBERT method) (asreview.models.feature_extraction.Tfidf method) TripleBalance (class in asreview.models.balance)

U

UncertaintyQuery (class in asreview.models.query)

UndersampleBalance (class in asreview.models.balance)

W

wss() (asreview.analysis.Analysis method)