Shresthh03 commited on
Commit
19c1682
·
verified ·
1 Parent(s): 9a6600b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +92 -13
README.md CHANGED
@@ -1,16 +1,95 @@
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
- title: Serenity Chatbot 4.5
3
- emoji: 💬
4
- colorFrom: yellow
5
- colorTo: purple
6
- sdk: gradio
7
- sdk_version: 5.42.0
8
- app_file: app.py
9
- pinned: false
10
- hf_oauth: true
11
- hf_oauth_scopes:
12
- - inference-api
13
- short_description: This is a great ai chatbot,who responds with love,care.
 
 
14
  ---
15
 
16
- An example chatbot using [Gradio](https://gradio.app), [`huggingface_hub`](https://huggingface.co/docs/huggingface_hub/v0.22.2/en/index), and the [Hugging Face Inference API](https://huggingface.co/docs/api-inference/index).
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
+ 🌸 Serenity — Your Emotional Support Chatbot
2
+
3
+ > A safe, soothing space where you can talk freely. Serenity listens, understands, and supports you — emotionally, mentally, and spiritually — whenever you need someone by your side.
4
+
5
+
6
+
7
+
8
+ ---
9
+
10
+ 💬 What Serenity Can Do
11
+
12
+ 🪷 Emotional Support:
13
+ Serenity listens to your feelings and responds with empathy, validation, and warmth — not robotic sympathy.
14
+
15
+ 🧠 Intelligent Conversation:
16
+ Serenity adapts to your tone — calm when you’re sad, cheerful when you’re happy, deep when you’re reflective.
17
+
18
+ 💛 Follow-up Memory:
19
+ If you felt low recently, Serenity remembers (for 10–15 days) and checks on you gently next time.
20
+
21
+ 🎙️ Multiple Voices:
22
+ Choose from 8 calming voices (male/female/neutral) — from deep and soothing to soft and nurturing.
23
+
24
+ 🌀 Avatar Animation:
25
+ A gentle, breathing avatar reacts as you talk — creating a peaceful, human-like experience.
26
+
27
+ 🌈 Dynamic Colors:
28
+ The interface changes between soft, calming hues for variety and comfort.
29
+
30
+
31
  ---
32
+
33
+ 🛠️ Tech Stack
34
+
35
+ Component Technology
36
+
37
+ Frontend HTML, CSS, JS (voice + emotion + avatar UI)
38
+ Backend Flask + OpenAI API
39
+ AI Model GPT-4-turbo / GPT-4o
40
+ Emotion Analysis DistilRoBERTa (via Transformers)
41
+ Voice gTTS (text-to-speech)
42
+ Hosting Hugging Face Spaces
43
+
44
+
45
+
46
  ---
47
 
48
+ ⚙️ Environment Variables
49
+
50
+ In your Hugging Face Space → Settings → Repository Secrets, add:
51
+
52
+ Variable Example Description
53
+
54
+ OPENAI_API_KEY sk-xxxxxx Your OpenAI API key (required)
55
+ ----🧭 Personality Modes
56
+
57
+ You can switch between personalities during chat:
58
+
59
+ 🌿 Serene Listener — calm, slow, deeply empathetic
60
+
61
+ 🌞 Uplifting Friend — cheerful, hopeful, talkative
62
+
63
+ 🌙 Reflective Soul — poetic, wise, deeply comforting
64
+
65
+ 🌺 Gentle Mentor — spiritual, compassionate, thoughtful
66
+
67
+
68
+ Each personality has unique tone, phrasing, and energy.
69
+
70
+
71
+ ---
72
+
73
+ ⚠️ Mental Health Note
74
+
75
+ Serenity is here to support you emotionally, not replace professional help.
76
+ If you are in crisis or feel unsafe, please reach out for immediate help:
77
+
78
+ 📞 International Helplines:
79
+
80
+ 🇺🇸 US: 988 (Suicide & Crisis Lifeline)
81
+
82
+ 🇬🇧 UK: Samaritans – 116 123
83
+
84
+ 🇮🇳 India: AASRA – 91-9820466726
85
+
86
+ 🌍 Find your local helpline here, anytime.
87
+
88
+
89
+
90
+ ---
91
+
92
+ 💖 Created With Love
93
+
94
+ Built to make the world a little kinder, one chat at a time.
95
+ Made by 💛 you — powered by OpenAI, Flask, and Hugging Face Spaces.