added embeddings folder but not files inside

.gitignore

@@ -15,8 +15,6 @@ style_venv/
 .DS_Store
 *.zip
 
-embeddings/glove.840B.300d*
-
 ################################
 # Bellow is created as described
 ################################
@@ -279,5 +277,5 @@ dmypy.json
 .venv/
 
 # End of https://www.gitignore.io/api/emacs,python,intellij+all
-embeddings
-/output/
+embeddings/glove*
+output/*

README.md

@@ -13,7 +13,19 @@ Code to run the Extra [algorithm](https://aclanthology.info/papers/D18-1384/d18-
 **IMPORTANT**: 
 1. When running Extra inside docker-container, make sure that Docker process has enough resources. 
 For example, on Mac/Windows it should have at least 8 Gb of RAM available to it.
-1. GitHub repo does **not** come with Glove Embeddings. TODO: update after script is in place.
+1. GitHub repo does **not** come with Glove Embeddings. See the next section for how to download the reuired embeddings.
+
+### Downloading Embeddings
+
+**This package does not come with the required Glove embeddings and they must be downloaded before use.**
+
+To download the required embeddings, run the following command:
+
+```bash
+docker-compose run --rm setup
+```
+
+The embeddings will be downloaded, unzipped and formatted into a space-efficient format. Files will be save in the `embeddings/` directory in the root of the project directory. If the process fails, it can be safely restarted. If you want to restart the process with new files, delete all files except `README.md` in the `embeddings/` directory.
 
 ### Using docker-compose
 

docker-compose.yaml

@@ -12,13 +12,17 @@ services:
       - ./embeddings:/embeddings
       - ./io:/io
 
+  # download embeddings
+  setup:
+    <<: *dev
+    entrypoint: "extra-model-setup"
+
+  # run extra-model
   extra-model:
     <<: *dev
     entrypoint: "extra-model"
-    command: "--help"
 
-  # run all the tests and linting locally
-  # - black & isort will format code to address issues
+  # run test & lint suite
   test:
     <<: *dev
-    command: docker/run_tests.sh --format-code
+    command: "docker/run_tests.sh --format-code"

embeddings/README.md

@@ -0,0 +1,3 @@
+# embeddings
+
+This directory exists to contain embeddings resources downloaded by the `extra-model-setup` entrypoint.