murtaza2801 commited on
Commit
423f79f
Β·
verified Β·
1 Parent(s): 33e184b

Update README.md

Browse files
Files changed (1) hide show
  1. README.md +72 -2
README.md CHANGED
@@ -7,7 +7,77 @@ sdk: streamlit
7
  sdk_version: 1.43.2
8
  app_file: app.py
9
  pinned: false
10
- short_description: News Summarization and Text-to-Speech Application
11
- ---
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
12
 
13
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference
 
7
  sdk_version: 1.43.2
8
  app_file: app.py
9
  pinned: false
10
+ short_description: Sentiment Analysis Dashboard
11
+
12
+ This project implements a sentiment analysis dashboard that processes news articles about a selected company, summarizes the content, determines sentiment (positive, negative, or neutral), and provides a Hindi summary with text-to-speech (TTS) output. The application is built using Streamlit and deployed on Hugging Face Spaces.
13
+ Features
14
+
15
+ News Extraction:
16
+
17
+ Fetches the latest news articles related to the selected company using web scraping.
18
+
19
+ Extracts the article title, content, and metadata.
20
+
21
+ Summarization:
22
+
23
+ Summarizes each article to a concise text using the Hugging Face Transformer model.
24
+
25
+ Sentiment Analysis:
26
+
27
+ Analyzes the sentiment of the summarized content (positive, negative, or neutral).
28
+
29
+ Text-to-Speech (TTS):
30
+
31
+ Converts the summarized Hindi text into speech using the gTTS library.
32
+
33
+ Interactive Dashboard:
34
+
35
+ Provides a user-friendly interface using Streamlit for input and output visualization.
36
+
37
+ Customization:
38
+
39
+ Allows users to select companies from a dropdown and adjust sentiment thresholds.
40
+
41
+ Deployment:
42
+
43
+ Hosted on Hugging Face Spaces for accessibility and testing.
44
+ Dependencies
45
+
46
+ Below are the required Python libraries:
47
+
48
+ Main Libraries:
49
+
50
+ streamlit
51
+
52
+ streamlit-lottie
53
+
54
+ requests
55
+
56
+ beautifulsoup4
57
+
58
+ pandas
59
+
60
+ nltk
61
+
62
+ transformers
63
+
64
+ File Structure
65
+ project/
66
+ β”œβ”€β”€ app.py # Main application script
67
+ β”œβ”€β”€ utils.py # Utility functions for processing, scraping, and summarization
68
+ β”œβ”€β”€ api.py # API functions to support modularity
69
+ β”œβ”€β”€ requirements.txt # Required Python libraries
70
+ β”œβ”€β”€ README.md # Documentation
71
+ └── assets/ # Folder for Lottie animations or additional assets
72
+ Usage
73
+
74
+ Open the application in your browser (local Streamlit server or Hugging Face Spaces).
75
+
76
+ Write the company name.
77
+
78
+ View extracted articles, summaries, sentiment distribution, and Hindi TTS output.
79
+
80
+ Customize sentiment thresholds and other inputs as needed.
81
+ ---
82
 
83
  Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference