Small improvement to README

VectorInstitute · Nov 12, 2024 · 61a5598 · 61a5598
1 parent 3924cd3
commit 61a5598
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -90,6 +90,9 @@ If you want to test the system without real data, you can generate some dummy te
 python3 scripts/generate_test_data.py
 ```
 
+This would create a folder `<path_to_output_dir>/test_data/data-00.json` with about 300 dummy services.
+You can follow the next step to load this data and embeddings to ChromaDB.
+
 #### Download service data
 
 If you are using the 211 API or Empower's API, make sure you check with them to see if the API keys are

diff --git a/docs/source/index.md b/docs/source/index.md
@@ -96,9 +96,12 @@ docker compose --env-file .env.development --profile frontend -f docker-compose.
 If you want to test the system without real data, you can generate some dummy testing data:
 
 ```bash
-python3 scripts/generate_test_data.py
+python3 scripts/generate_test_data.py --output-dir <path_to_output_dir>
 ```
 
+This would create a folder `<path_to_output_dir>/test_data/data-00.json` with about 300 dummy services.
+You can follow the next step to load this data and embeddings to ChromaDB.
+
 #### Download service data
 
 If you are using the 211 API or Empower's API, make sure you check with them to see if the API keys are