Skip to content

Commit

Permalink
Introduce index page for LTR search.
Browse files Browse the repository at this point in the history
  • Loading branch information
epugh committed Aug 23, 2024
1 parent 186a467 commit 08d0af6
Show file tree
Hide file tree
Showing 2 changed files with 43 additions and 1 deletion.
4 changes: 4 additions & 0 deletions _search-plugins/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ OpenSearch supports the following search methods:

- **Machine learning (ML)-powered search**

- **LTR search**

- [LTR search]({{site.url}}{{site.baseurl}}/search-plugins/ltr/): Uses ML to learn a ranking function that can effectively order a set of search results based on their relevance to the user's query that are query dependent.

- **Vector search**

- [k-NN search]({{site.url}}{{site.baseurl}}/search-plugins/knn/): Searches for k-nearest neighbors to a search term across an index of vectors.
Expand Down
40 changes: 39 additions & 1 deletion _search-plugins/ltr/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,4 +10,42 @@ redirect_from:

# LTR search

Short for *Learning to Rank*, the LTR plugin enables users to be amazing!
Short for *Learning to Rank*, the LTR plugin enables you use machine learning and behavioral data to tune the relevance of documents.
It uses models from the XGBoost and Ranklib libraries to rescore the search results that takes into account user behavior like click-through data that is query dependent, which can further improve relevance.

Check failure on line 14 in _search-plugins/ltr/index.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: XGBoost. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: XGBoost. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_search-plugins/ltr/index.md", "range": {"start": {"line": 14, "column": 25}}}, "severity": "ERROR"}

Check failure on line 14 in _search-plugins/ltr/index.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: Ranklib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: Ranklib. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_search-plugins/ltr/index.md", "range": {"start": {"line": 14, "column": 37}}}, "severity": "ERROR"}

[Learning to
Rank](http://opensourceconnections.com/blog/2017/02/24/what-is-learning-to-rank/)
applies machine learning to relevance ranking. The [OpenSearch
Learning to Rank
plugin](https://github.com/opensearch-project/opensearch-learning-to-rank-base)
(OpenSearch LTR) gives you tools to train and use ranking models in
OpenSearch.

## Get started

- Want a quickstart? Check out the demo in
[hello-ltr](https://github.com/o19s/hello-ltr).
- Brand new to learning to rank? head to
`core-concepts`{.interpreted-text role="doc"}.
- Otherwise, start with `fits-in`{.interpreted-text role="doc"}

## Installing

Pre-built versions can be found
[here](https://github.com/opensearch-project/opensearch-learning-to-rank-base/releases).
Want a build for an OS version? Follow the instructions in the [README
for
building](https://github.com/opensearch-project/opensearch-learning-to-rank-base#development)
or [create an
issue](https://github.com/opensearch-project/opensearch-learning-to-rank-base/issues).
Once you've found a version compatible with your OpenSearch, you'd
run a command such as:

./bin/opensearch-plugin install https://github.com/opensearch-project/opensearch-learning-to-rank-base/releases/download/ltr-plugin-v2.11.1-RC1/ltr-plugin-v2.11.1-RC1.zip



## History

The Elasticsearch LTR plugin was initially developed by [OpenSource Connections](http://opensourceconnections.com), with significant contributions by [Wikimedia Foundation](https://diff.wikimedia.org/2017/10/17/elasticsearch-learning-to-rank-plugin/), Snagajob Engineering, Bonsai, and Yelp Engineering.

Check failure on line 50 in _search-plugins/ltr/index.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: Wikimedia. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: Wikimedia. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_search-plugins/ltr/index.md", "range": {"start": {"line": 50, "column": 152}}}, "severity": "ERROR"}

Check failure on line 50 in _search-plugins/ltr/index.md

View workflow job for this annotation

GitHub Actions / style-job

[vale] reported by reviewdog 🐶 [OpenSearch.Spelling] Error: Snagajob. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks. Raw Output: {"message": "[OpenSearch.Spelling] Error: Snagajob. If you are referencing a setting, variable, format, function, or repository, surround it with tic marks.", "location": {"path": "_search-plugins/ltr/index.md", "range": {"start": {"line": 50, "column": 253}}}, "severity": "ERROR"}
The OpenSearch version of the plugin is derived from the Elasticsearch LTR plugin.

0 comments on commit 08d0af6

Please sign in to comment.