Skip to content

Commit f56fd9d

Browse files
authored
[DOCS] Fix typo: Elasticsearch (#6258)
[Fix typo] Elasticsearch Not ElasticSearch :)
1 parent a1e1867 commit f56fd9d

File tree

1 file changed

+6
-6
lines changed

1 file changed

+6
-6
lines changed

docs/source/faiss_es.mdx

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Search index
22

3-
[FAISS](https://github.com/facebookresearch/faiss) and [ElasticSearch](https://www.elastic.co/elasticsearch/) enables searching for examples in a dataset. This can be useful when you want to retrieve specific examples from a dataset that are relevant to your NLP task. For example, if you are working on a Open Domain Question Answering task, you may want to only return examples that are relevant to answering your question.
3+
[FAISS](https://github.com/facebookresearch/faiss) and [Elasticsearch](https://www.elastic.co/elasticsearch/) enables searching for examples in a dataset. This can be useful when you want to retrieve specific examples from a dataset that are relevant to your NLP task. For example, if you are working on a Open Domain Question Answering task, you may want to only return examples that are relevant to answering your question.
44

55
This guide will show you how to build an index for your dataset that will allow you to search it.
66

@@ -66,11 +66,11 @@ FAISS retrieves documents based on the similarity of their vector representation
6666
>>> ds.load_faiss_index('embeddings', 'my_index.faiss')
6767
```
6868

69-
## ElasticSearch
69+
## Elasticsearch
7070

71-
Unlike FAISS, ElasticSearch retrieves documents based on exact matches.
71+
Unlike FAISS, Elasticsearch retrieves documents based on exact matches.
7272

73-
Start ElasticSearch on your machine, or see the [ElasticSearch installation guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html) if you don't already have it installed.
73+
Start Elasticsearch on your machine, or see the [Elasticsearch installation guide](https://www.elastic.co/guide/en/elasticsearch/reference/current/setup.html) if you don't already have it installed.
7474

7575
1. Load the dataset you want to index:
7676

@@ -114,7 +114,7 @@ hf_squad_val_context
114114
>>> scores, retrieved_examples = squad.get_nearest_examples("context", query, k=10)
115115
```
116116

117-
For more advanced ElasticSearch usage, you can specify your own configuration with custom settings:
117+
For more advanced Elasticsearch usage, you can specify your own configuration with custom settings:
118118

119119
```py
120120
>>> import elasticsearch as es
@@ -128,6 +128,6 @@ For more advanced ElasticSearch usage, you can specify your own configuration wi
128128
... },
129129
... "mappings": {"properties": {"text": {"type": "text", "analyzer": "standard", "similarity": "BM25"}}},
130130
... } # default config
131-
>>> es_index_name = "hf_squad_context" # name of the index in ElasticSearch
131+
>>> es_index_name = "hf_squad_context" # name of the index in Elasticsearch
132132
>>> squad.add_elasticsearch_index("context", es_client=es_client, es_config=es_config, es_index_name=es_index_name)
133133
```

0 commit comments

Comments
 (0)