Welcome to the WEFE documentation!

WEFE: The Word Embeddings Fairness Evaluation Framework is an open source library for measuring bias in word embedding models.

The following pages contain information about the formulation of WEFE, how to install the package, how to use it and how to contribute, as well as the detailed API documentation and extensive examples.

Getting Started

• About
  • Motivation and objectives
  • The Framework
  • Metrics
  • Changelog
  • Relevant Papers
  • Citation
  • Roadmap
  • Licence
  • Team
  • Contact
  • Acknowledgments
• Quick Start
  • Download and setup
  • Run your first Query

Documentation

• User guide
  • Run a Query
  • Running multiple Queries
  • Calculate Rankings
  • Ranking Correlations
• How to implement your own metric
  • Create the class
  • Implement run_query method
  • Implement the logic of the metric
  • Contribute
• Loading embeddings from different sources
  • Create a example query
  • Load from Gensim API
  • Using Gensim Load
  • Flair
• Contributing
  • Get the repository
  • Testing
  • Build the documentation
• WEFE API
  • WordEmbeddingModel
  • Query
  • BaseMetric
  • WEAT
  • RND
  • RNSB
  • ECT
  • RIPA
  • Dataloaders

Examples

• Replication of Previous Studies
  • WEAT Replication
  • RNSB Replication
• Rank Word Embeddings Fairness using several Metrics and Queries

Repository

You can find the project repository at the following link: WEFE repository on Github.