Spaces:
Runtime error
Runtime error
Update README.md
Browse files
README.md
CHANGED
@@ -28,8 +28,39 @@ The application follows a sequence of steps to deliver Taylor Swift songs matchi
|
|
28 |
- **Song Retrieval**: The selected song's embedded player is displayed on the webpage for the user. Additionally, the LLM interpreted emotional state associated with the chosen song is displayed.
|
29 |
|
30 |
## Setup instructions
|
31 |
-
--TODO--
|
32 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
33 |
<small>_DISCLAIMER_: This project is 200% inspired by Francesco's [FairyTaleDJ](https://github.com/FrancescoSaverioZuppichini/FairytaleDJ). </small>
|
34 |
|
35 |
|
|
|
28 |
- **Song Retrieval**: The selected song's embedded player is displayed on the webpage for the user. Additionally, the LLM interpreted emotional state associated with the chosen song is displayed.
|
29 |
|
30 |
## Setup instructions
|
|
|
31 |
|
32 |
+
### Checkout the repo
|
33 |
+
Clone the repository using the following command:
|
34 |
+
```
|
35 |
+
git clone https://huggingface.co/spaces/mchockal/TaylorSwiftDJ
|
36 |
+
```
|
37 |
+
|
38 |
+
### Set Environment Variables
|
39 |
+
You'll need to set the following variables in the `env_vars.env` file:
|
40 |
+
|
41 |
+
```dotenv
|
42 |
+
OPENAI_API_KEY=
|
43 |
+
ACTIVELOOP_TOKEN=
|
44 |
+
ACTIVELOOP_ORG_ID=
|
45 |
+
MODEL = "text-embedding-ada-002"
|
46 |
+
DATASET = <your_vector_space_for_emotions>
|
47 |
+
UPSTASH_URL=
|
48 |
+
UPSTASH_PASSWORD=
|
49 |
+
USE_STORAGE="False"
|
50 |
+
ROOT=
|
51 |
+
```
|
52 |
+
|
53 |
+
### Install Dependencies
|
54 |
+
Install the required dependencies using the following command:
|
55 |
+
```
|
56 |
+
pip install -r requirements.txt
|
57 |
+
```
|
58 |
+
|
59 |
+
### Run the Streamlit App
|
60 |
+
Launch the Streamlit app using the following command:
|
61 |
+
```
|
62 |
+
streamlit run app.py
|
63 |
+
```
|
64 |
<small>_DISCLAIMER_: This project is 200% inspired by Francesco's [FairyTaleDJ](https://github.com/FrancescoSaverioZuppichini/FairytaleDJ). </small>
|
65 |
|
66 |
|