mchockal commited on
Commit
2b9bb06
β€’
1 Parent(s): 290f5b2

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +24 -2
README.md CHANGED
@@ -1,6 +1,6 @@
1
  ---
2
  title: TaylorSwiftDJ
3
- emoji: 😻
4
  colorFrom: pink
5
  colorTo: indigo
6
  sdk: streamlit
@@ -10,4 +10,26 @@ pinned: false
10
  license: creativeml-openrail-m
11
  ---
12
 
13
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
  title: TaylorSwiftDJ
3
+ emoji: 🌟
4
  colorFrom: pink
5
  colorTo: indigo
6
  sdk: streamlit
 
10
  license: creativeml-openrail-m
11
  ---
12
 
13
+ # TaylorSwiftDJ 🌟
14
+
15
+ *<small>Made with [DeepLake](https://www.deeplake.ai/) πŸš€ and [LangChain](https://python.langchain.com/en/latest/index.html) πŸ¦œβ›“οΈ</small>*
16
+
17
+ πŸ’« Hey there Swifties! Welcome to "TaylorSwiftDJ"! 🎀🎢 \
18
+ This streamlit powered app recommends Taylor Swift's iconic songs 'tailored'(hah! :D) to your emotions. \
19
+ Dance, reminisce, and embrace your feelings with every beat – because life's a melody, and Taylor's your DJ. ✨ 🌈 πŸ’–
20
+
21
+
22
+ ## How it works
23
+ The application follows a sequence of steps to deliver Taylor Swift songs matching the user's emotions:
24
+ - **User Input**: The application starts by collecting user's emotional state through a text input.
25
+ - **Emotion Encoding**: The user-provided emotions are then fed to a Language Model (LLM). The LLM interprets and encodes these emotions.
26
+ - **Similarity Search**: These encoded emotions are utilized to perform a similarity search within our [vector database](https://www.deeplake.ai/). This database houses ~130 Taylor Swift songs, each represented as emotional embeddings.
27
+ - **Song Selection**: From the pool of top matching songs, the application randomly selects one. The selection is weighted, giving preference to songs with higher similarity scores.
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
+