update documentation to clarify that nltk needs to be downloaded in p…

…ython
Watts-Lab · Aug 8, 2024 · 583dcb7 · 583dcb7
1 parent a63b273
commit 583dcb7
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -29,9 +29,11 @@ You will also need to ensure that Spacy and NLTK are installed in addition to th
 spacy download en_core_web_sm
 ```
 
-Additionally, we require the following NLTK dependencies:
+Additionally, we require the following NLTK dependencies, which need to be downloaded via Python. If you don't have them, run the following python script in your environment:
+
+```python
+import nltk
 
-```sh
 nltk.download('nps_chat')
 nltk.download('punkt')
 nltk.download('stopwords')

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -20,10 +20,12 @@ You will also need to ensure that Spacy and NLTK are installed in addition to th
 
    spacy download en_core_web_sm
 
-Additionally, we require the following NLTK dependencies:
+Additionally, we require the following NLTK dependencies, which need to be downloaded via Python. If you don't have them, run the following python script in your environment:
 
 .. code-block::
 
+	import nltk
+
    nltk.download('nps_chat')
    nltk.download('punkt')
    nltk.download('stopwords')

diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -22,10 +22,12 @@ You will also need to ensure that Spacy and NLTK are installed in addition to th
 
    spacy download en_core_web_sm
 
-Additionally, we require the following NLTK dependencies:
+Additionally, we require the following NLTK dependencies, which need to be downloaded via Python. If you don't have them, run the following python script in your environment:
 
 .. code-block::
 
+   import nltk
+
    nltk.download('nps_chat')
    nltk.download('punkt')
    nltk.download('stopwords')