The Fair Search Elasticsearch plugin uses machine learning to provide a fair search result with relevant protected and non protected classes.
This plugin:
- Store fairness distribution tables to use during rescoring.
- Allows you to rescore fairly any query in elasticsearch.
We recommend taking time to read the docs.
This plugin is an open source project and we love to receive contributions from the community — you! All contributions are welcome: ideas, patches, documentation, bug reports, complaints, and even something you drew up on a napkin.
Programming is not a required skill. Whatever you've seen about open source and maintainers or community members saying "send patches or die" - you will not see that here.
It is more important to me that you are able to contribute.
Extra bits at CONTRIBUTING.md
See the full list of prebuilt versions. If you don't see a version available, see the link below for building.
To install, you'd run a command such as:
./bin/elasticsearch-plugin install https://fair-search.github.io/fair-reranker/fairsearch-1.0-es6.1.2-SNAPSHOT.zip
(It's expected you'll confirm some security exceptions, you can pass -b to elasticsearch-plugin to automatically install)
If you already are running Elasticsearch, don't forget to restart!
Notes if you want to dig into the code or build for a version there's no build for.
./gradlew clean check
This runs the tasks in the esplugin gradle plugin that builds, tests, generates a Elasticsearch plugin zip file.
./bin/elasticsearch-plugin install file:///path/to/project/build/distributions/fairsearch-1.0.0-es6.2.2.zip
Initially developed by:
- Pere Urbón Bayes
- Tom Sühr
Special thanks to Meike Zehlike and Carlos Castillo, the minds behind the science in this plugin.