Aadityaramrame commited on
Commit
1b1fea4
Β·
verified Β·
1 Parent(s): c5e9f08

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +50 -6
README.md CHANGED
@@ -1,12 +1,56 @@
1
  ---
2
- title: KeywordExtraction
3
- emoji: 🐨
4
- colorFrom: yellow
5
- colorTo: purple
6
  sdk: gradio
7
- sdk_version: 5.49.1
8
  app_file: app.py
9
  pinned: false
 
10
  ---
11
 
12
- Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1
  ---
2
+ title: "Keyword Extraction App"
3
+ emoji: 🧠
4
+ colorFrom: blue
5
+ colorTo: indigo
6
  sdk: gradio
7
+ sdk_version: "4.0.0"
8
  app_file: app.py
9
  pinned: false
10
+ license: mit
11
  ---
12
 
13
+ # πŸ” **Keyword Extraction App**
14
+
15
+ ### ☁️ *Render API Integrated with Hugging Face Gradio*
16
+
17
+ ---
18
+
19
+ ## πŸ“‹ **Project Overview**
20
+ This app demonstrates how to connect a **Gradio interface on Hugging Face** with a **Flask API deployed on Render**.
21
+ It performs **keyword extraction** from any text input by making live API calls to the backend.
22
+
23
+ ---
24
+
25
+ ## πŸš€ **How It Works**
26
+ 1. User enters text into the Gradio interface.
27
+ 2. The frontend sends the text to the Render-hosted API endpoint:
28
+ πŸ”— [`https://carecompanion-keywordextraction.onrender.com/extract_keywords`](https://carecompanion-keywordextraction.onrender.com/extract_keywords)
29
+ 3. The backend extracts important keywords using NLP models and returns them to the Gradio interface.
30
+ 4. The extracted keywords are displayed instantly.
31
+
32
+ ---
33
+
34
+ ## 🧩 **Tech Stack**
35
+ - **Frontend:** Gradio (Hugging Face Spaces)
36
+ - **Backend:** Flask (deployed on Render)
37
+ - **Language:** Python
38
+ - **Model:** NLP-based keyword extraction pipeline
39
+
40
+ ---
41
+
42
+ ## πŸ’» **Usage**
43
+ 1. Enter or paste any text into the input box.
44
+ 2. Click **β€œSubmit”**.
45
+ 3. Instantly view extracted keywords.
46
+
47
+ ---
48
+
49
+ ## πŸ§‘β€πŸ’» **Developer**
50
+ **Aaditya Ramrame**
51
+ πŸ”— Hugging Face: [@Aadityaramrame](https://huggingface.co/Aadityaramrame)
52
+ ☁️ Render API: [Keyword Extraction API](https://carecompanion-keywordextraction.onrender.com/extract_keywords)
53
+
54
+ ---
55
+
56
+ ## 🧠 Example Input