Added README.MD

This commit is contained in:
Romain Quinet 2023-10-06 21:47:59 +02:00
parent d3d977a3d0
commit fcdde9fbe0

25
README.MD Normal file
View File

@ -0,0 +1,25 @@
# Darknet Diaries LLM
## How to run
### Install dependencies
I have no idea what the correct way to install dependencies with python is. Somehow install these libraries and their dependencies:
- llama_index
- beautifulsoup4
### Execution
Download transcripts:
```shell
python3 download_transcripts.py
```
Set OpenAPI key as environment variable
```shell
OPEN_API_KEY=<your key>
```
Then run the main file
```shell
python3 main.py
```
On the first run, it will generate the index. This can take a while, but it will be cached on disk for the next runs.
You can them ask it any questions about Darknet Diaries!