Update README.md

README.md

@@ -46,18 +46,34 @@ It detects the following types of entities:
 
 The [Sefaria-Project](https://github.com/Sefaria/Sefaria-Project) repo can use this model to return objects linked to objects in the Sefaria database. Non-citation entities are linked to `Topic` objects and citation entities are linked to `Ref` objects.
 
+Note, this model is designed to be used in conjunction with the corresponding [subref model](https://huggingface.co/Sefaria/en_subref_ner). That model takes citations as input and tags the parts of the citation. The below instructions explain how to integrate both of these models into Sefaria-Project.
+
 ### Configuring Sefaria-Project to use this model
 
 The assumption is that Sefaria-Project is set up on your environment following the instructions in our [README](https://github.com/Sefaria/Sefaria-Project/blob/master/README.mkd).
 
+Download this repo and the [subref repo](https://huggingface.co/Sefaria/en_subref_ner).
+
 In `local_settings.py`, modify the following lines:
 
 ```python
+ENABLE_LINKER = True
+
 RAW_REF_MODEL_BY_LANG_FILEPATH = {
-   "en": "/path/to/torah-ner-english model"
+   "en": "/path/to/en-ref-ner model"
+}
+
+RAW_REF_PART_MODEL_BY_LANG_FILEPATH = {
+	"en": "/path/to/en-subref-ner model",
 }
 ```
 
+Make sure spaCy is installed.
+
+```bash
+pip install spacy==3.4.1
+```
+
 ### Running the model with Sefaria-Project
 
 The following code shows an example of instantiating the `Linker` object which uses the ML models and running the `Linker` with input.