Skip to content

Commit fd37362

Browse files
committed
update README
1 parent 0f67d7b commit fd37362

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

README.md

+2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ Put your data under the `storage/data` directory. Note: You can add urls in the
2323

2424
> Note: The 'WebpageCrawler' in `code/modules/helpers.py` takes in the urls from the `storage/data/urls.txt` file, and gets all children urls and files from the urls provided. If you want to read only the data in the urls provided, set `["embedding_options"]["expand_urls"]` to False in the `code/config.yaml` file.
2525
26+
To run locally:
27+
2628
To create the Vector Database, run the following command:
2729
```python code/modules/vector_db.py```
2830
(Note: You would need to run the above when you add new data to the `storage/data` directory, or if the ``storage/data/urls.txt`` file is updated. Or you can set ``["embedding_options"]["embedd_files"]`` to True in the `code/config.yaml` file, which would embed files from the storage directory everytime you run the below chainlit command.)

0 commit comments

Comments
 (0)