From 8ab5f2e54eb40268c7fdbabd2fd938bc9718316a Mon Sep 17 00:00:00 2001
From: davidmezzetti <561939+davidmezzetti@users.noreply.github.com>
Date: Thu, 10 Sep 2020 18:01:51 -0400
Subject: [PATCH] Added documentation for storevectors

---
 README.md | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/README.md b/README.md
index 469526140..d94eaebb3 100644
--- a/README.md
+++ b/README.md
@@ -88,6 +88,7 @@ Embeddings({"method": "transformers",
 
 # Word embeddings model
 Embeddings({"path": vectors,
+            "storevectors": True,
             "scoring": "bm25",
             "pca": 3,
             "quantize": True})
@@ -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