Skip to content

Commit

Permalink
Added documentation for storevectors
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmezzetti committed Sep 10, 2020
1 parent b6454ef commit 8ab5f2e
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -88,6 +88,7 @@ Embeddings({"method": "transformers",
# Word embeddings model
Embeddings({"path": vectors,
"storevectors": True,
"scoring": "bm25",
"pca": 3,
"quantize": True})
Expand All @@ -108,6 +109,13 @@ path: string
Required field that sets the path for a vectors model. When method set to _transformers_, this must be a path to a Hugging Face transformers model. Otherwise,
it must be a path to a local word embeddings model.
#### storevectors
```yaml
storevectors: boolean
```
Enables copying of a vectors model set in path into the embeddings models output directory on save. This option enables a fully encapsulated index with no external file dependencies.
#### scoring
```yaml
scoring: bm25|tfidf|sif
Expand Down

0 comments on commit 8ab5f2e

Please sign in to comment.