Subayyal commited on
Commit
58b9a94
·
verified ·
1 Parent(s): 936ec26

Delete README2.md

Browse files
Files changed (1) hide show
  1. README2.md +0 -72
README2.md DELETED
@@ -1,72 +0,0 @@
1
- ---
2
- title: MoodVerse App
3
- emoji: 🐢
4
- colorFrom: green
5
- colorTo: gray
6
- sdk: streamlit
7
- sdk_version: 1.49.1
8
- app_file: app.py
9
- pinned: false
10
- 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
14
-
15
-
16
- # 🌿 MoodVerse — Your Sacred Journey
17
-
18
- *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.
19
-
20
- ---
21
-
22
- ## *Features*
23
-
24
- 1. *Mood-based Exploration*
25
- - Select your current mood (e.g., Happy, Angry, Hopeful).
26
- - The app randomly displays a relevant Quranic verse with *English & Urdu translations*.
27
- - It also provides a *tagline and reasoning* tailored to the selected mood.
28
-
29
- 2. *Keyword & Semantic Search*
30
- - Search Quranic verses in *English or Urdu*.
31
- - Choose *Keyword* or *Semantic* search mode:
32
- - *Keyword*: Exact word/phrase matches.
33
- - *Semantic*: Finds verses with similar meaning using TF-IDF similarity.
34
- - Filter by *Surah* or *Juz* for precise results.
35
- - View verse translations, tafseer, and highlighted keywords.
36
-
37
- 3. *Taglines & Reasoning*
38
- - Each mood verse includes an AI-generated *short tagline* (max 15 words) and *reasoning*.
39
-
40
- ---
41
-
42
- ## *How to Use*
43
-
44
- ### 1. Mood Exploration
45
- - Go to the *MoodVerse* tab.
46
- - Select your mood from the dropdown.
47
- - Click *"Show Verse"*.
48
- - View the verse, translations, and AI-generated tagline & reasoning.
49
-
50
- ### 2. Quran Search
51
- - Go to the *Search Quran* tab.
52
- - Enter a search term (keyword or phrase).
53
- - Choose *language*: English or Urdu.
54
- - Choose *search mode*: Keyword or Semantic.
55
- - Optionally select a *Surah* or *Juz* to filter results.
56
- - Click *"Search"*.
57
- - View results with highlighted search terms.
58
-
59
-
60
- - Once the files and secrets are in place, your app will launch automatically.
61
- - The Gradio UI will appear in your Space, ready for users to interact.
62
-
63
- ---
64
-
65
- ## *Notes*
66
- - The app automatically resumes incomplete tagline generation if the Groq API was previously interrupted.
67
- - Semantic search is limited to *top 50 matches* for performance.
68
- - Use moods and keywords thoughtfully to explore relevant verses.
69
-
70
- ---
71
-
72
- *🌿 Enjoy your sacred journey and let these divine words inspire your heart.*