Skip to content

Commit 3d600cd

Browse files
committed
docs: update README and gitignore
- Align README defaults with backend config - Remove unused HF env vars from documentation - Update gitignore patterns
1 parent 673137b commit 3d600cd

File tree

2 files changed

+3
-6
lines changed

2 files changed

+3
-6
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313

1414
# Python
1515
__pycache__/
16+
.mypy_cache
1617
*.py[cod]
1718
*$py.class
1819
*.so

README.md

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ AI-powered YouTube comment analysis tool with ML-powered sentiment detection, to
44

55
## Features
66

7-
- **Comment Extraction**: Fetch up to 500 comments from any YouTube video using yt-dlp
7+
- **Comment Extraction**: Fetch up to a configurable comment limit per video using yt-dlp (default 100)
88
- **Sentiment Analysis**: BERT-powered multilingual sentiment classification (positive/negative/neutral/suggestion)
99
- **Topic Modeling**: BERTopic clustering to identify key discussion themes
1010
- **AI Summaries**: Local LLM-powered summaries via Ollama (llama3.2:3b)
@@ -150,17 +150,13 @@ Copy `.env.example` to `.env` and configure:
150150

151151
```bash
152152
# YouTube
153-
YOUTUBE_MAX_COMMENTS=500
153+
YOUTUBE_MAX_COMMENTS=100
154154

155155
# Ollama (AI Summaries)
156156
OLLAMA_URL=http://localhost:11434
157157
OLLAMA_MODEL=llama3.2:3b
158158
OLLAMA_ENABLED=true
159159

160-
# Hugging Face (optional)
161-
HF_TOKEN=your_token_here
162-
HF_ENABLED=true
163-
164160
# ML Processing
165161
SENTIMENT_BATCH_SIZE=32
166162
MAX_TOPICS=10

0 commit comments

Comments
 (0)