Spaces:
Sleeping
Sleeping
Update README.md
Browse files
README.md
CHANGED
|
@@ -11,3 +11,60 @@ short_description: MoodVerse is an interactive Quranic verse explorer app.
|
|
| 11 |
---
|
| 12 |
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 11 |
---
|
| 12 |
|
| 13 |
Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
|
| 14 |
+
# 🌿 MoodVerse — Your Sacred Journey
|
| 15 |
+
|
| 16 |
+
*MoodVerse* is an interactive Quranic verse explorer designed to help users discover inspiring verses based on their *mood* or by *searching keywords/semantic queries*. The app also generates short, meaningful taglines and reasoning for each verse using Groq AI.
|
| 17 |
+
|
| 18 |
+
---
|
| 19 |
+
|
| 20 |
+
## *Features*
|
| 21 |
+
|
| 22 |
+
1. *Mood-based Exploration*
|
| 23 |
+
- Select your current mood (e.g., Happy, Angry, Hopeful).
|
| 24 |
+
- The app randomly displays a relevant Quranic verse with *English & Urdu translations*.
|
| 25 |
+
- It also provides a *tagline and reasoning* tailored to the selected mood.
|
| 26 |
+
|
| 27 |
+
2. *Keyword & Semantic Search*
|
| 28 |
+
- Search Quranic verses in *English or Urdu*.
|
| 29 |
+
- Choose *Keyword* or *Semantic* search mode:
|
| 30 |
+
- *Keyword*: Exact word/phrase matches.
|
| 31 |
+
- *Semantic*: Finds verses with similar meaning using TF-IDF similarity.
|
| 32 |
+
- Filter by *Surah* or *Juz* for precise results.
|
| 33 |
+
- View verse translations, tafseer, and highlighted keywords.
|
| 34 |
+
|
| 35 |
+
3. *Taglines & Reasoning*
|
| 36 |
+
- Each mood verse includes an AI-generated *short tagline* (max 15 words) and *reasoning*.
|
| 37 |
+
|
| 38 |
+
---
|
| 39 |
+
|
| 40 |
+
## *How to Use*
|
| 41 |
+
|
| 42 |
+
### 1. Mood Exploration
|
| 43 |
+
- Go to the *MoodVerse* tab.
|
| 44 |
+
- Select your mood from the dropdown.
|
| 45 |
+
- Click *"Show Verse"*.
|
| 46 |
+
- View the verse, translations, and AI-generated tagline & reasoning.
|
| 47 |
+
|
| 48 |
+
### 2. Quran Search
|
| 49 |
+
- Go to the *Search Quran* tab.
|
| 50 |
+
- Enter a search term (keyword or phrase).
|
| 51 |
+
- Choose *language*: English or Urdu.
|
| 52 |
+
- Choose *search mode*: Keyword or Semantic.
|
| 53 |
+
- Optionally select a *Surah* or *Juz* to filter results.
|
| 54 |
+
- Click *"Search"*.
|
| 55 |
+
- View results with highlighted search terms.
|
| 56 |
+
|
| 57 |
+
|
| 58 |
+
- Once the files and secrets are in place, your app will launch automatically.
|
| 59 |
+
- The Gradio UI will appear in your Space, ready for users to interact.
|
| 60 |
+
|
| 61 |
+
---
|
| 62 |
+
|
| 63 |
+
## *Notes*
|
| 64 |
+
- The app automatically resumes incomplete tagline generation if the Groq API was previously interrupted.
|
| 65 |
+
- Semantic search is limited to *top 50 matches* for performance.
|
| 66 |
+
- Use moods and keywords thoughtfully to explore relevant verses.
|
| 67 |
+
|
| 68 |
+
---
|
| 69 |
+
|
| 70 |
+
*🌿 Enjoy your sacred journey and let these divine words inspire your heart.*
|