Skip to content

Latest commit

 

History

History
118 lines (81 loc) · 2.36 KB

api.rst

File metadata and controls

118 lines (81 loc) · 2.36 KB

WEFE API

This reference details all the utilities as well as the metrics and mitigation methods implemented so far in WEFE.

wefe

WordEmbeddingModel

wefe.word_embedding_model.WordEmbeddingModel

Query

wefe.query.Query

Metrics

This list contains the metrics implemented in WEFE.

wefe.metrics.WEAT wefe.metrics.RND wefe.metrics.RNSB wefe.metrics.MAC wefe.metrics.ECT wefe.metrics.RIPA

Debias

This list contains the debiasing methods implemented so far in WEFE.

wefe.debias.hard_debias.HardDebias wefe.debias.multiclass_hard_debias.MulticlassHardDebias wefe.debias.repulsion_attraction_neutralization.RepulsionAttractionNeutralization wefe.debias.double_hard_debias.DoubleHardDebias wefe.debias.half_sibling_regression.HalfSiblingRegression

Datasets

The following functions allow you to load sets of words used in previous studies.

wefe.datasets.load_bingliu wefe.datasets.fetch_debias_multiclass wefe.datasets.fetch_debiaswe wefe.datasets.fetch_eds wefe.datasets.load_weat

Preprocessing

The following functions allow transforming sets of words and queries to embeddings. The documentation of the functions in this section are intended as a guide for WEFE developers.

wefe.preprocessing.preprocess_word wefe.preprocessing.get_embeddings_from_set wefe.preprocessing.get_embeddings_from_tuples wefe.preprocessing.get_embeddings_from_query

Utils

Collection of assorted utils.

wefe.utils.load_test_model wefe.utils.generate_subqueries_from_queries_list wefe.utils.run_queries wefe.utils.plot_queries_results wefe.utils.create_ranking wefe.utils.plot_ranking wefe.utils.calculate_ranking_correlations wefe.utils.plot_ranking_correlations wefe.utils.flair_to_gensim