<-- failure due to lack of Circle CI JDK12 see this issue
The Elasticsearch Learning to Rank plugin uses machine learning to improve search relevance ranking. It's powering search at places like Wikimedia Foundation and Snagajob!
This plugin:
- Allows you to store features (Elasticsearch query templates) in Elasticsearch
- Logs features scores (relevance scores) to create a training set for offline model development
- Stores linear, xgboost, or ranklib ranking models in Elasticsearch that use features you've stored
- Ranks search results using a stored model
We recommend taking time to read the docs. There's quite a bit of detailed information about learning to rank basics and how this plugin can ease learning to rank development.
If you want to just jump in, go straight to the demo. The demo uses Ranklib, a relatively straightforward Java Learning to Rank library, to train models. Follow the directions in the demo README, edit code, and have fun!
See the full list of prebuilt versions. If you don't see a version available, see the link below for building or file a request via issues.
To install, you'd run a command such as:
./bin/elasticsearch-plugin install http://es-learn-to-rank.labs.o19s.com/ltr-1.0.0-es6.1.2.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!
As any other piece of software, this plugin is not exempt from issues. Please read the known issues to learn about the current issues that we are aware of. This file might include workarounds to mitigate them when possible.
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 available in ./build/distributions.
When building to support another version of Elasticsearch, versions should be modified in ./build.gradle, and possibly ./gradle/wrapper/gradle-wrapper.properties. See https://mvnrepository.com/artifact/org.elasticsearch.gradle/build-tools for available build tool versions.
./bin/elasticsearch-plugin install file:///path/to/project/build/distributions/ltr-<LTR-VER>-es<ES-VER>.zip
- Initially developed at OpenSource Connections.
- Significant contributions by Wikimedia Foundation, Snagajob Engineering, and Bonsai
- Thanks to Jettro Coenradie for porting to ES 6.1
- Bloomberg's Learning to Rank work for Solr
- Our Berlin Buzzwords Talk, We built an Elasticsearch Learning to Rank plugin. Then came the hard part
- Blog article on How is Search Different from Other Machine Learning Problems
- Also check out our other relevance/search thingies: book Relevant Search, projects Elyzer, Splainer, and Quepid