Upload 14 files
Browse files- .env.example +38 -0
- .gitignore +184 -0
- CONTRIBUTING.md +218 -0
- Dockerfile +43 -0
- LICENSE +51 -0
- README.md +443 -2
- advanced_sentiment_analysis.ipynb +0 -0
- config/README.md +127 -0
- docker-compose.yml +71 -0
- docs/README.md +70 -0
- requirements.txt +34 -0
- setup.py +227 -0
- tests/README.md +93 -0
- tests/fixtures/sample_texts.json +62 -0
.env.example
ADDED
|
@@ -0,0 +1,38 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Example environment configuration
|
| 2 |
+
# Copy this file to .env and update with your actual values
|
| 3 |
+
|
| 4 |
+
# OpenAI API Configuration (REQUIRED)
|
| 5 |
+
OPENAI_API_KEY=your_openai_api_key_here
|
| 6 |
+
|
| 7 |
+
# Sentiment Analysis Thresholds (Optional - defaults provided)
|
| 8 |
+
SENTIMENT_CONFIDENCE_THRESHOLD=0.7
|
| 9 |
+
ESCALATION_RATE_THRESHOLD=0.15
|
| 10 |
+
PROCESSING_TIME_THRESHOLD=5.0
|
| 11 |
+
ERROR_RATE_THRESHOLD=0.05
|
| 12 |
+
|
| 13 |
+
# Production Configuration (Optional)
|
| 14 |
+
ENVIRONMENT=development
|
| 15 |
+
MAX_CONCURRENT_REQUESTS=100
|
| 16 |
+
RATE_LIMIT_REQUESTS_PER_MINUTE=1000
|
| 17 |
+
RATE_LIMIT_BURST_CAPACITY=50
|
| 18 |
+
|
| 19 |
+
# Monitoring Configuration (Optional)
|
| 20 |
+
METRICS_COLLECTION_ENABLED=true
|
| 21 |
+
ALERT_WEBHOOK_URL=your_webhook_url_here
|
| 22 |
+
|
| 23 |
+
# Database Configuration (Optional - for future use)
|
| 24 |
+
# DATABASE_URL=postgresql://user:password@localhost:5432/sentiment_db
|
| 25 |
+
# REDIS_URL=redis://localhost:6379/0
|
| 26 |
+
|
| 27 |
+
# Logging Configuration (Optional)
|
| 28 |
+
LOG_LEVEL=INFO
|
| 29 |
+
LOG_FORMAT=json
|
| 30 |
+
|
| 31 |
+
# Cache Configuration (Optional)
|
| 32 |
+
CACHE_ENABLED=true
|
| 33 |
+
CACHE_TTL_SECONDS=300
|
| 34 |
+
|
| 35 |
+
# Performance Configuration (Optional)
|
| 36 |
+
BATCH_SIZE_DEFAULT=100
|
| 37 |
+
MAX_WORKERS_DEFAULT=10
|
| 38 |
+
PROCESSING_TIMEOUT_SECONDS=30
|
.gitignore
ADDED
|
@@ -0,0 +1,184 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Byte-compiled / optimized / DLL files
|
| 2 |
+
__pycache__/
|
| 3 |
+
*.py[cod]
|
| 4 |
+
*$py.class
|
| 5 |
+
|
| 6 |
+
# C extensions
|
| 7 |
+
*.so
|
| 8 |
+
|
| 9 |
+
# Distribution / packaging
|
| 10 |
+
.Python
|
| 11 |
+
build/
|
| 12 |
+
develop-eggs/
|
| 13 |
+
dist/
|
| 14 |
+
downloads/
|
| 15 |
+
eggs/
|
| 16 |
+
.eggs/
|
| 17 |
+
lib/
|
| 18 |
+
lib64/
|
| 19 |
+
parts/
|
| 20 |
+
sdist/
|
| 21 |
+
var/
|
| 22 |
+
wheels/
|
| 23 |
+
pip-wheel-metadata/
|
| 24 |
+
share/python-wheels/
|
| 25 |
+
*.egg-info/
|
| 26 |
+
.installed.cfg
|
| 27 |
+
*.egg
|
| 28 |
+
MANIFEST
|
| 29 |
+
|
| 30 |
+
# PyInstaller
|
| 31 |
+
# Usually these files are written by a python script from a template
|
| 32 |
+
# before PyInstaller builds the exe, so as to inject date/other infos into it.
|
| 33 |
+
*.manifest
|
| 34 |
+
*.spec
|
| 35 |
+
|
| 36 |
+
# Installer logs
|
| 37 |
+
pip-log.txt
|
| 38 |
+
pip-delete-this-directory.txt
|
| 39 |
+
|
| 40 |
+
# Unit test / coverage reports
|
| 41 |
+
htmlcov/
|
| 42 |
+
.tox/
|
| 43 |
+
.nox/
|
| 44 |
+
.coverage
|
| 45 |
+
.coverage.*
|
| 46 |
+
.cache
|
| 47 |
+
nosetests.xml
|
| 48 |
+
coverage.xml
|
| 49 |
+
*.cover
|
| 50 |
+
*.py,cover
|
| 51 |
+
.hypothesis/
|
| 52 |
+
.pytest_cache/
|
| 53 |
+
|
| 54 |
+
# Translations
|
| 55 |
+
*.mo
|
| 56 |
+
*.pot
|
| 57 |
+
|
| 58 |
+
# Django stuff:
|
| 59 |
+
*.log
|
| 60 |
+
local_settings.py
|
| 61 |
+
db.sqlite3
|
| 62 |
+
db.sqlite3-journal
|
| 63 |
+
|
| 64 |
+
# Flask stuff:
|
| 65 |
+
instance/
|
| 66 |
+
.webassets-cache
|
| 67 |
+
|
| 68 |
+
# Scrapy stuff:
|
| 69 |
+
.scrapy
|
| 70 |
+
|
| 71 |
+
# Sphinx documentation
|
| 72 |
+
docs/_build/
|
| 73 |
+
|
| 74 |
+
# PyBuilder
|
| 75 |
+
target/
|
| 76 |
+
|
| 77 |
+
# Jupyter Notebook
|
| 78 |
+
.ipynb_checkpoints
|
| 79 |
+
|
| 80 |
+
# IPython
|
| 81 |
+
profile_default/
|
| 82 |
+
ipython_config.py
|
| 83 |
+
|
| 84 |
+
# pyenv
|
| 85 |
+
.python-version
|
| 86 |
+
|
| 87 |
+
# pipenv
|
| 88 |
+
# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
|
| 89 |
+
# However, in case of collaboration, if having platform-specific dependencies or dependencies
|
| 90 |
+
# having no cross-platform support, pipenv may install dependencies that don't work, or not
|
| 91 |
+
# install all needed dependencies.
|
| 92 |
+
#Pipfile.lock
|
| 93 |
+
|
| 94 |
+
# PEP 582; used by e.g. github.com/David-OConnor/pyflow
|
| 95 |
+
__pypackages__/
|
| 96 |
+
|
| 97 |
+
# Celery stuff
|
| 98 |
+
celerybeat-schedule
|
| 99 |
+
celerybeat.pid
|
| 100 |
+
|
| 101 |
+
# SageMath parsed files
|
| 102 |
+
*.sage.py
|
| 103 |
+
|
| 104 |
+
# Environments
|
| 105 |
+
.env
|
| 106 |
+
.env.local
|
| 107 |
+
.env.development
|
| 108 |
+
.env.production
|
| 109 |
+
.venv
|
| 110 |
+
env/
|
| 111 |
+
venv/
|
| 112 |
+
ENV/
|
| 113 |
+
env.bak/
|
| 114 |
+
venv.bak/
|
| 115 |
+
|
| 116 |
+
# Spyder project settings
|
| 117 |
+
.spyderproject
|
| 118 |
+
.spyproject
|
| 119 |
+
|
| 120 |
+
# Rope project settings
|
| 121 |
+
.ropeproject
|
| 122 |
+
|
| 123 |
+
# mkdocs documentation
|
| 124 |
+
/site
|
| 125 |
+
|
| 126 |
+
# mypy
|
| 127 |
+
.mypy_cache/
|
| 128 |
+
.dmypy.json
|
| 129 |
+
dmypy.json
|
| 130 |
+
|
| 131 |
+
# Pyre type checker
|
| 132 |
+
.pyre/
|
| 133 |
+
|
| 134 |
+
# Project-specific files
|
| 135 |
+
*.csv
|
| 136 |
+
*.json
|
| 137 |
+
*.xlsx
|
| 138 |
+
results/
|
| 139 |
+
logs/
|
| 140 |
+
temp/
|
| 141 |
+
cache/
|
| 142 |
+
.DS_Store
|
| 143 |
+
Thumbs.db
|
| 144 |
+
|
| 145 |
+
# IDE files
|
| 146 |
+
.vscode/
|
| 147 |
+
.idea/
|
| 148 |
+
*.swp
|
| 149 |
+
*.swo
|
| 150 |
+
*~
|
| 151 |
+
|
| 152 |
+
# API keys and sensitive information
|
| 153 |
+
api_keys.txt
|
| 154 |
+
secrets.txt
|
| 155 |
+
config.ini
|
| 156 |
+
*.key
|
| 157 |
+
*.pem
|
| 158 |
+
credentials.json
|
| 159 |
+
openai_key.txt
|
| 160 |
+
api_credentials.*
|
| 161 |
+
llm_config.json
|
| 162 |
+
|
| 163 |
+
# Temporary analysis files
|
| 164 |
+
sentiment_results_*
|
| 165 |
+
batch_output_*
|
| 166 |
+
analysis_export_*
|
| 167 |
+
|
| 168 |
+
# System files
|
| 169 |
+
.DS_Store
|
| 170 |
+
.DS_Store?
|
| 171 |
+
._*
|
| 172 |
+
.Spotlight-V100
|
| 173 |
+
.Trashes
|
| 174 |
+
ehthumbs.db
|
| 175 |
+
Thumbs.db
|
| 176 |
+
|
| 177 |
+
# Backup files
|
| 178 |
+
*.bak
|
| 179 |
+
*.backup
|
| 180 |
+
*.old
|
| 181 |
+
|
| 182 |
+
# Runtime files
|
| 183 |
+
*.pid
|
| 184 |
+
*.lock
|
CONTRIBUTING.md
ADDED
|
@@ -0,0 +1,218 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Contributing to Advanced Sentiment Analysis System
|
| 2 |
+
|
| 3 |
+
Thank you for your interest in contributing to the Advanced Sentiment Analysis System! This document provides guidelines and information for contributors.
|
| 4 |
+
|
| 5 |
+
## 🌟 Getting Started
|
| 6 |
+
|
| 7 |
+
### Prerequisites
|
| 8 |
+
|
| 9 |
+
- Python 3.8 or higher
|
| 10 |
+
- OpenAI API key for testing
|
| 11 |
+
- Git for version control
|
| 12 |
+
- Jupyter Notebook for development
|
| 13 |
+
|
| 14 |
+
### Development Environment Setup
|
| 15 |
+
|
| 16 |
+
1. **Fork the repository** on GitHub
|
| 17 |
+
2. **Clone your fork locally**:
|
| 18 |
+
```bash
|
| 19 |
+
git clone https://github.com/your-username/advanced-sentiment-analysis.git
|
| 20 |
+
cd advanced-sentiment-analysis
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
3. **Create a virtual environment**:
|
| 24 |
+
```bash
|
| 25 |
+
python -m venv venv
|
| 26 |
+
source venv/bin/activate # On Windows: venv\Scripts\activate
|
| 27 |
+
```
|
| 28 |
+
|
| 29 |
+
4. **Install dependencies**:
|
| 30 |
+
```bash
|
| 31 |
+
pip install -r requirements.txt
|
| 32 |
+
```
|
| 33 |
+
|
| 34 |
+
5. **Set up environment variables**:
|
| 35 |
+
```bash
|
| 36 |
+
cp .env.example .env
|
| 37 |
+
# Edit .env with your OpenAI API key
|
| 38 |
+
```
|
| 39 |
+
|
| 40 |
+
## 🔧 Development Guidelines
|
| 41 |
+
|
| 42 |
+
### Code Style
|
| 43 |
+
|
| 44 |
+
We follow Python best practices and maintain consistent code style:
|
| 45 |
+
|
| 46 |
+
- **PEP 8** compliance for Python code
|
| 47 |
+
- **Type hints** for function parameters and return values
|
| 48 |
+
- **Docstrings** for all classes and functions (Google style)
|
| 49 |
+
- **Meaningful variable names** and clear code structure
|
| 50 |
+
|
| 51 |
+
### Testing
|
| 52 |
+
|
| 53 |
+
- **Unit tests** for individual components
|
| 54 |
+
- **Integration tests** for system workflows
|
| 55 |
+
- **Performance tests** for scalability validation
|
| 56 |
+
- **Example-based tests** with real-world scenarios
|
| 57 |
+
|
| 58 |
+
### Documentation
|
| 59 |
+
|
| 60 |
+
- **Inline comments** for complex logic
|
| 61 |
+
- **Jupyter notebook documentation** for tutorials and examples
|
| 62 |
+
- **README updates** for new features
|
| 63 |
+
- **API documentation** for public interfaces
|
| 64 |
+
|
| 65 |
+
## 🚀 How to Contribute
|
| 66 |
+
|
| 67 |
+
### 1. Issue Reporting
|
| 68 |
+
|
| 69 |
+
Before creating a new issue, please:
|
| 70 |
+
|
| 71 |
+
- **Search existing issues** to avoid duplicates
|
| 72 |
+
- **Provide detailed information** including:
|
| 73 |
+
- System environment (Python version, OS)
|
| 74 |
+
- Steps to reproduce
|
| 75 |
+
- Expected vs. actual behavior
|
| 76 |
+
- Error messages and logs
|
| 77 |
+
|
| 78 |
+
### 2. Feature Requests
|
| 79 |
+
|
| 80 |
+
When proposing new features:
|
| 81 |
+
|
| 82 |
+
- **Describe the use case** and problem being solved
|
| 83 |
+
- **Explain the proposed solution** with examples
|
| 84 |
+
- **Consider backward compatibility** and performance impact
|
| 85 |
+
- **Discuss implementation approach** if you have ideas
|
| 86 |
+
|
| 87 |
+
### 3. Pull Requests
|
| 88 |
+
|
| 89 |
+
#### Before submitting:
|
| 90 |
+
|
| 91 |
+
1. **Create a feature branch** from `main`
|
| 92 |
+
2. **Implement your changes** following coding guidelines
|
| 93 |
+
3. **Add tests** for new functionality
|
| 94 |
+
4. **Update documentation** as needed
|
| 95 |
+
5. **Ensure all tests pass** locally
|
| 96 |
+
|
| 97 |
+
#### Pull Request Process:
|
| 98 |
+
|
| 99 |
+
1. **Create a clear title** describing the change
|
| 100 |
+
2. **Fill out the PR template** (if available)
|
| 101 |
+
3. **Link relevant issues** using keywords (fixes #123)
|
| 102 |
+
4. **Request review** from maintainers
|
| 103 |
+
5. **Address feedback** promptly and professionally
|
| 104 |
+
|
| 105 |
+
## 🧪 Testing
|
| 106 |
+
|
| 107 |
+
### Running Tests
|
| 108 |
+
|
| 109 |
+
```bash
|
| 110 |
+
# Install test dependencies
|
| 111 |
+
pip install pytest pytest-cov
|
| 112 |
+
|
| 113 |
+
# Run all tests
|
| 114 |
+
pytest tests/ -v
|
| 115 |
+
|
| 116 |
+
# Run with coverage
|
| 117 |
+
pytest tests/ --cov=. --cov-report=html
|
| 118 |
+
|
| 119 |
+
# Run specific test categories
|
| 120 |
+
pytest tests/ -m "unit"
|
| 121 |
+
pytest tests/ -m "integration"
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
### Test Structure
|
| 125 |
+
|
| 126 |
+
```
|
| 127 |
+
tests/
|
| 128 |
+
├── unit/ # Unit tests for individual components
|
| 129 |
+
├── integration/ # Integration tests for workflows
|
| 130 |
+
├── performance/ # Performance and load tests
|
| 131 |
+
└── fixtures/ # Test data and utilities
|
| 132 |
+
```
|
| 133 |
+
|
| 134 |
+
## 📝 Documentation Standards
|
| 135 |
+
|
| 136 |
+
### Jupyter Notebooks
|
| 137 |
+
|
| 138 |
+
- **Clear cell organization** with proper headings
|
| 139 |
+
- **Executable examples** with expected outputs
|
| 140 |
+
- **Error handling** demonstrations
|
| 141 |
+
- **Performance considerations** and optimization tips
|
| 142 |
+
|
| 143 |
+
### Code Documentation
|
| 144 |
+
|
| 145 |
+
```python
|
| 146 |
+
class SentimentAnalyzer:
|
| 147 |
+
"""
|
| 148 |
+
Advanced sentiment analysis with multi-dimensional classification.
|
| 149 |
+
|
| 150 |
+
This class provides comprehensive sentiment analysis including:
|
| 151 |
+
- Primary sentiment classification (positive/negative/neutral)
|
| 152 |
+
- Emotion detection (joy, anger, fear, etc.)
|
| 153 |
+
- Aspect-based sentiment analysis
|
| 154 |
+
- Confidence calibration and uncertainty quantification
|
| 155 |
+
|
| 156 |
+
Example:
|
| 157 |
+
>>> analyzer = SentimentAnalyzer()
|
| 158 |
+
>>> result = analyzer.analyze("Great product!")
|
| 159 |
+
>>> print(result.primary_sentiment)
|
| 160 |
+
'positive'
|
| 161 |
+
"""
|
| 162 |
+
```
|
| 163 |
+
|
| 164 |
+
## 🌐 Community Guidelines
|
| 165 |
+
|
| 166 |
+
### Code of Conduct
|
| 167 |
+
|
| 168 |
+
- **Be respectful** and professional in all interactions
|
| 169 |
+
- **Welcome newcomers** and help them get started
|
| 170 |
+
- **Focus on constructive feedback** in code reviews
|
| 171 |
+
- **Acknowledge contributions** and give credit where due
|
| 172 |
+
|
| 173 |
+
### Communication
|
| 174 |
+
|
| 175 |
+
- **Use clear, concise language** in issues and PRs
|
| 176 |
+
- **Provide context** for your changes and decisions
|
| 177 |
+
- **Ask questions** when you need clarification
|
| 178 |
+
- **Share knowledge** and help others learn
|
| 179 |
+
|
| 180 |
+
## 🏆 Recognition
|
| 181 |
+
|
| 182 |
+
Contributors are recognized in several ways:
|
| 183 |
+
|
| 184 |
+
- **Contributors list** in README.md
|
| 185 |
+
- **Release notes** mention significant contributions
|
| 186 |
+
- **GitHub contributors graph** tracks all contributions
|
| 187 |
+
- **Special recognition** for major features or fixes
|
| 188 |
+
|
| 189 |
+
## 📋 Contribution Checklist
|
| 190 |
+
|
| 191 |
+
Before submitting your contribution:
|
| 192 |
+
|
| 193 |
+
- [ ] Code follows project style guidelines
|
| 194 |
+
- [ ] All tests pass locally
|
| 195 |
+
- [ ] New features include appropriate tests
|
| 196 |
+
- [ ] Documentation is updated for changes
|
| 197 |
+
- [ ] Commit messages are clear and descriptive
|
| 198 |
+
- [ ] No sensitive data (API keys, credentials) included
|
| 199 |
+
- [ ] Performance impact considered and documented
|
| 200 |
+
|
| 201 |
+
## 🔗 Resources
|
| 202 |
+
|
| 203 |
+
### Useful Links
|
| 204 |
+
|
| 205 |
+
- [DSPy Documentation](https://github.com/stanfordnlp/dspy)
|
| 206 |
+
- [OpenAI API Documentation](https://platform.openai.com/docs)
|
| 207 |
+
- [Python Testing Best Practices](https://docs.python.org/3/library/unittest.html)
|
| 208 |
+
- [Jupyter Notebook Best Practices](https://jupyter.org/community)
|
| 209 |
+
|
| 210 |
+
### Getting Help
|
| 211 |
+
|
| 212 |
+
- **GitHub Issues**: For bug reports and feature requests
|
| 213 |
+
- **GitHub Discussions**: For questions and general discussion
|
| 214 |
+
- **Documentation**: Check README.md and inline documentation first
|
| 215 |
+
|
| 216 |
+
---
|
| 217 |
+
|
| 218 |
+
Thank you for contributing to the Advanced Sentiment Analysis System! Your contributions help make this project better for everyone. 🚀
|
Dockerfile
ADDED
|
@@ -0,0 +1,43 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Advanced Sentiment Analysis System
|
| 2 |
+
FROM python:3.10-slim
|
| 3 |
+
|
| 4 |
+
# Set working directory
|
| 5 |
+
WORKDIR /app
|
| 6 |
+
|
| 7 |
+
# Set environment variables
|
| 8 |
+
ENV PYTHONDONTWRITEBYTECODE=1 \
|
| 9 |
+
PYTHONUNBUFFERED=1 \
|
| 10 |
+
PIP_NO_CACHE_DIR=1 \
|
| 11 |
+
PIP_DISABLE_PIP_VERSION_CHECK=1
|
| 12 |
+
|
| 13 |
+
# Install system dependencies
|
| 14 |
+
RUN apt-get update && apt-get install -y \
|
| 15 |
+
gcc \
|
| 16 |
+
g++ \
|
| 17 |
+
&& apt-get clean \
|
| 18 |
+
&& rm -rf /var/lib/apt/lists/*
|
| 19 |
+
|
| 20 |
+
# Copy requirements first for better caching
|
| 21 |
+
COPY requirements.txt .
|
| 22 |
+
|
| 23 |
+
# Install Python dependencies
|
| 24 |
+
RUN pip install --upgrade pip && \
|
| 25 |
+
pip install -r requirements.txt
|
| 26 |
+
|
| 27 |
+
# Copy application code
|
| 28 |
+
COPY . .
|
| 29 |
+
|
| 30 |
+
# Create non-root user for security
|
| 31 |
+
RUN useradd --create-home --shell /bin/bash app && \
|
| 32 |
+
chown -R app:app /app
|
| 33 |
+
USER app
|
| 34 |
+
|
| 35 |
+
# Health check
|
| 36 |
+
HEALTHCHECK --interval=30s --timeout=30s --start-period=5s --retries=3 \
|
| 37 |
+
CMD python -c "import requests; requests.get('http://localhost:8000/health')" || exit 1
|
| 38 |
+
|
| 39 |
+
# Expose port
|
| 40 |
+
EXPOSE 8000
|
| 41 |
+
|
| 42 |
+
# Run command
|
| 43 |
+
CMD ["python", "-m", "jupyter", "notebook", "--ip=0.0.0.0", "--port=8000", "--no-browser", "--allow-root"]
|
LICENSE
ADDED
|
@@ -0,0 +1,51 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
MIT License
|
| 2 |
+
|
| 3 |
+
Copyright (c) 2024 Advanced Sentiment Analysis System
|
| 4 |
+
|
| 5 |
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
| 6 |
+
of this software and associated documentation files (the "Software"), to deal
|
| 7 |
+
in the Software without restriction, including without limitation the rights
|
| 8 |
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
| 9 |
+
copies of the Software, and to permit persons to whom the Software is
|
| 10 |
+
furnished to do so, subject to the following conditions:
|
| 11 |
+
|
| 12 |
+
The above copyright notice and this permission notice shall be included in all
|
| 13 |
+
copies or substantial portions of the Software.
|
| 14 |
+
|
| 15 |
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
| 16 |
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
| 17 |
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
| 18 |
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
| 19 |
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
| 20 |
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
| 21 |
+
SOFTWARE.
|
| 22 |
+
|
| 23 |
+
---
|
| 24 |
+
|
| 25 |
+
Additional Acknowledgments:
|
| 26 |
+
|
| 27 |
+
This project includes components and inspiration from several open-source projects:
|
| 28 |
+
|
| 29 |
+
1. DSPy Framework (Apache License 2.0)
|
| 30 |
+
- https://github.com/stanfordnlp/dspy
|
| 31 |
+
- Used for declarative language programming foundations
|
| 32 |
+
|
| 33 |
+
2. OpenAI Python Library (MIT License)
|
| 34 |
+
- https://github.com/openai/openai-python
|
| 35 |
+
- Used for GPT-4 model integration
|
| 36 |
+
|
| 37 |
+
3. Scientific Python Ecosystem
|
| 38 |
+
- NumPy, pandas, scikit-learn, matplotlib, seaborn
|
| 39 |
+
- Various licenses (BSD, MIT)
|
| 40 |
+
- Used for data processing and analysis
|
| 41 |
+
|
| 42 |
+
4. Jupyter Project (BSD License)
|
| 43 |
+
- https://jupyter.org/
|
| 44 |
+
- Used for interactive development environment
|
| 45 |
+
|
| 46 |
+
The authors and contributors of this project acknowledge and appreciate the
|
| 47 |
+
work of all open-source developers whose libraries and frameworks made this
|
| 48 |
+
project possible.
|
| 49 |
+
|
| 50 |
+
For the most up-to-date license information of dependencies, please refer to
|
| 51 |
+
their respective repositories and documentation.
|
README.md
CHANGED
|
@@ -1,3 +1,444 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
---
|
| 2 |
-
|
| 3 |
-
|
|
|
|
|
|
|
|
|
| 1 |
+
# 🚀 Advanced Sentiment Analysis System
|
| 2 |
+
|
| 3 |
+
[](https://opensource.org/licenses/MIT)
|
| 4 |
+
[](https://www.python.org/downloads/)
|
| 5 |
+
[](https://github.com/stanfordnlp/dspy)
|
| 6 |
+
[](https://openai.com/)
|
| 7 |
+
|
| 8 |
+
A sophisticated, production-ready sentiment analysis system built with DSPy framework and OpenAI GPT-4, featuring multi-dimensional sentiment analysis, automated response generation, and enterprise-grade monitoring capabilities.
|
| 9 |
+
|
| 10 |
+
## 🌟 Key Features
|
| 11 |
+
|
| 12 |
+
### 🧠 Advanced Analysis Capabilities
|
| 13 |
+
- **Multi-dimensional Sentiment Analysis**: Primary sentiments, emotions, aspects, and contextual understanding
|
| 14 |
+
- **Emotion Detection**: Joy, anger, fear, sadness, surprise, and disgust classification
|
| 15 |
+
- **Aspect-based Sentiment**: Product features, service quality, delivery experience analysis
|
| 16 |
+
- **Confidence Calibration**: Uncertainty quantification and reliability scoring
|
| 17 |
+
- **Dynamic Thresholds**: Adaptive confidence and urgency detection
|
| 18 |
+
|
| 19 |
+
### 🤖 Automated Response System
|
| 20 |
+
- **Intelligent Response Generation**: Context-aware, personalized customer responses
|
| 21 |
+
- **Escalation Management**: Smart routing based on sentiment urgency and complexity
|
| 22 |
+
- **Quality Assurance**: Automated validation and human oversight integration
|
| 23 |
+
- **Workflow Automation**: End-to-end processing with minimal human intervention
|
| 24 |
+
|
| 25 |
+
### 🏭 Production-Ready Features
|
| 26 |
+
- **Batch Processing**: High-volume data processing with optimized performance
|
| 27 |
+
- **Real-time Monitoring**: System health, performance metrics, and alerting
|
| 28 |
+
- **API Gateway**: RESTful endpoints with rate limiting and authentication
|
| 29 |
+
- **Scalable Architecture**: Enterprise deployment with monitoring and diagnostics
|
| 30 |
+
- **Health Monitoring**: Comprehensive system diagnostics and reporting
|
| 31 |
+
|
| 32 |
+
### 📊 Analytics & Intelligence
|
| 33 |
+
- **Trend Analysis**: Historical sentiment patterns and business insights
|
| 34 |
+
- **Performance Analytics**: Processing speed, accuracy, and efficiency metrics
|
| 35 |
+
- **Business Intelligence**: Customer satisfaction scores and operational KPIs
|
| 36 |
+
- **Comprehensive Reporting**: Detailed analytics dashboards and export capabilities
|
| 37 |
+
|
| 38 |
+
## 🛠️ Technology Stack
|
| 39 |
+
|
| 40 |
+
- **Framework**: DSPy (Declarative Self-improving Language Programs)
|
| 41 |
+
- **Language Model**: OpenAI GPT-4o-mini
|
| 42 |
+
- **Data Processing**: pandas, numpy, scikit-learn
|
| 43 |
+
- **Visualization**: matplotlib, seaborn, plotly
|
| 44 |
+
- **Development**: Jupyter Notebook, Python 3.8+
|
| 45 |
+
- **Deployment**: Production-ready with monitoring and scaling capabilities
|
| 46 |
+
|
| 47 |
+
## 🚀 Quick Start
|
| 48 |
+
|
| 49 |
+
### Prerequisites
|
| 50 |
+
|
| 51 |
+
1. **Python 3.8 or higher**
|
| 52 |
+
2. **OpenAI API Key** - Get one from [OpenAI Platform](https://platform.openai.com/api-keys)
|
| 53 |
+
3. **Required Dependencies** (see requirements.txt)
|
| 54 |
+
|
| 55 |
+
### Installation
|
| 56 |
+
|
| 57 |
+
1. **Clone the repository**:
|
| 58 |
+
```bash
|
| 59 |
+
git clone https://github.com/skkuhg/Advanced-Sentiment-Analysis-DSPy-LLM.git
|
| 60 |
+
cd Advanced-Sentiment-Analysis-DSPy-LLM
|
| 61 |
+
```
|
| 62 |
+
|
| 63 |
+
2. **Install dependencies**:
|
| 64 |
+
```bash
|
| 65 |
+
pip install -r requirements.txt
|
| 66 |
+
```
|
| 67 |
+
|
| 68 |
+
3. **Set up environment variables**:
|
| 69 |
+
```bash
|
| 70 |
+
# Create a .env file (recommended)
|
| 71 |
+
echo "OPENAI_API_KEY=your_openai_api_key_here" > .env
|
| 72 |
+
|
| 73 |
+
# OR set environment variable directly:
|
| 74 |
+
# Windows
|
| 75 |
+
set OPENAI_API_KEY=your_openai_api_key_here
|
| 76 |
+
|
| 77 |
+
# Linux/Mac
|
| 78 |
+
export OPENAI_API_KEY=your_openai_api_key_here
|
| 79 |
+
```
|
| 80 |
+
|
| 81 |
+
⚠️ **Security Note**: Never commit your API key to version control. The system will prompt you to enter it if not found in environment variables.
|
| 82 |
+
|
| 83 |
+
4. **Launch Jupyter Notebook**:
|
| 84 |
+
```bash
|
| 85 |
+
jupyter notebook advanced_sentiment_analysis.ipynb
|
| 86 |
+
```
|
| 87 |
+
|
| 88 |
+
5. **Run all cells** to initialize the system and see the comprehensive demonstration.
|
| 89 |
+
|
| 90 |
+
## 🎯 Automated Setup (Recommended)
|
| 91 |
+
|
| 92 |
+
### One-Command Setup
|
| 93 |
+
|
| 94 |
+
Run our intelligent setup script for automatic configuration:
|
| 95 |
+
|
| 96 |
+
```bash
|
| 97 |
+
python setup.py
|
| 98 |
+
```
|
| 99 |
+
|
| 100 |
+
This script will:
|
| 101 |
+
- ✅ Check Python version compatibility
|
| 102 |
+
- 📦 Install all required dependencies
|
| 103 |
+
- 🔧 Set up secure environment configuration
|
| 104 |
+
- 🔑 Help you configure your OpenAI API key securely
|
| 105 |
+
- 📚 Set up Jupyter notebook extensions
|
| 106 |
+
- ✨ Verify the complete installation
|
| 107 |
+
- 🚀 Provide next steps for immediate use
|
| 108 |
+
|
| 109 |
+
### Manual Setup Alternative
|
| 110 |
+
|
| 111 |
+
If you prefer manual configuration:
|
| 112 |
+
|
| 113 |
+
1. **Clone the repository**:
|
| 114 |
+
```bash
|
| 115 |
+
git clone https://github.com/your-username/advanced-sentiment-analysis.git
|
| 116 |
+
cd advanced-sentiment-analysis
|
| 117 |
+
```
|
| 118 |
+
|
| 119 |
+
2. **Install dependencies**:
|
| 120 |
+
```bash
|
| 121 |
+
pip install -r requirements.txt
|
| 122 |
+
```
|
| 123 |
+
|
| 124 |
+
3. **Set up environment variables**:
|
| 125 |
+
```bash
|
| 126 |
+
# Create a .env file (recommended)
|
| 127 |
+
echo "OPENAI_API_KEY=your_openai_api_key_here" > .env
|
| 128 |
+
|
| 129 |
+
# OR set environment variable directly:
|
| 130 |
+
# Windows
|
| 131 |
+
set OPENAI_API_KEY=your_openai_api_key_here
|
| 132 |
+
|
| 133 |
+
# Linux/Mac
|
| 134 |
+
export OPENAI_API_KEY=your_openai_api_key_here
|
| 135 |
+
```
|
| 136 |
+
|
| 137 |
+
⚠️ **Security Note**: Never commit your API key to version control. The system will prompt you to enter it if not found in environment variables.
|
| 138 |
+
|
| 139 |
+
4. **Launch Jupyter Notebook**:
|
| 140 |
+
```bash
|
| 141 |
+
jupyter notebook advanced_sentiment_analysis.ipynb
|
| 142 |
+
```
|
| 143 |
+
|
| 144 |
+
5. **Run all cells** to initialize the system and see the comprehensive demonstration.
|
| 145 |
+
|
| 146 |
+
## 📖 Usage Examples
|
| 147 |
+
|
| 148 |
+
### Basic Sentiment Analysis
|
| 149 |
+
|
| 150 |
+
```python
|
| 151 |
+
from advanced_sentiment_analysis import AdvancedSentimentAnalyzer
|
| 152 |
+
|
| 153 |
+
# Initialize the analyzer
|
| 154 |
+
analyzer = AdvancedSentimentAnalyzer()
|
| 155 |
+
|
| 156 |
+
# Analyze a review
|
| 157 |
+
result = analyzer.analyze_review(
|
| 158 |
+
"This product exceeded all my expectations! Amazing quality and fast shipping.",
|
| 159 |
+
category="electronics"
|
| 160 |
+
)
|
| 161 |
+
|
| 162 |
+
print(f"Primary Sentiments: {result.primary_sentiments}")
|
| 163 |
+
print(f"Emotions: {result.emotions_detected}")
|
| 164 |
+
print(f"Confidence: {result.confidence_score:.2f}")
|
| 165 |
+
```
|
| 166 |
+
|
| 167 |
+
### Automated Response Generation
|
| 168 |
+
|
| 169 |
+
```python
|
| 170 |
+
from advanced_sentiment_analysis import AutomatedResponseSystem
|
| 171 |
+
|
| 172 |
+
# Initialize response system
|
| 173 |
+
response_system = AutomatedResponseSystem()
|
| 174 |
+
|
| 175 |
+
# Process review with automated response
|
| 176 |
+
result = response_system.process_review_workflow(
|
| 177 |
+
"The delivery was late and the package was damaged.",
|
| 178 |
+
category="logistics"
|
| 179 |
+
)
|
| 180 |
+
|
| 181 |
+
print(f"Generated Response: {result['workflow_result']['response_generated']['response_text']}")
|
| 182 |
+
print(f"Action Taken: {result['workflow_result']['action_taken']}")
|
| 183 |
+
```
|
| 184 |
+
|
| 185 |
+
### Batch Processing
|
| 186 |
+
|
| 187 |
+
```python
|
| 188 |
+
from advanced_sentiment_analysis import ProductionSentimentPlatform
|
| 189 |
+
|
| 190 |
+
# Initialize production platform
|
| 191 |
+
platform = ProductionSentimentPlatform()
|
| 192 |
+
|
| 193 |
+
# Process large dataset
|
| 194 |
+
reviews_data = [
|
| 195 |
+
{'review_text': 'Great product!', 'product_category': 'electronics'},
|
| 196 |
+
{'review_text': 'Poor service experience', 'product_category': 'support'},
|
| 197 |
+
# ... more reviews
|
| 198 |
+
]
|
| 199 |
+
|
| 200 |
+
results = platform.batch_processor.process_large_dataset(
|
| 201 |
+
data_source=reviews_data,
|
| 202 |
+
batch_size=100,
|
| 203 |
+
output_format='json',
|
| 204 |
+
save_path='results.json'
|
| 205 |
+
)
|
| 206 |
+
|
| 207 |
+
print(f"Processed {results['processing_stats']['processed_items']} reviews")
|
| 208 |
+
print(f"Business Health Score: {results['aggregated_insights']['business_health_score']:.2f}")
|
| 209 |
+
```
|
| 210 |
+
|
| 211 |
+
## 🏗️ System Architecture
|
| 212 |
+
|
| 213 |
+
```mermaid
|
| 214 |
+
graph TB
|
| 215 |
+
A[Customer Reviews] --> B[Advanced Sentiment Analyzer]
|
| 216 |
+
B --> C[Multi-dimensional Analysis]
|
| 217 |
+
C --> D[Confidence Calibration]
|
| 218 |
+
D --> E[Response Generation System]
|
| 219 |
+
E --> F[Quality Assurance]
|
| 220 |
+
F --> G[Escalation Management]
|
| 221 |
+
G --> H[Automated Workflows]
|
| 222 |
+
|
| 223 |
+
I[Monitoring System] --> J[Health Checks]
|
| 224 |
+
I --> K[Performance Metrics]
|
| 225 |
+
I --> L[Alerting]
|
| 226 |
+
|
| 227 |
+
M[API Gateway] --> N[Rate Limiting]
|
| 228 |
+
M --> O[Authentication]
|
| 229 |
+
M --> P[Request Routing]
|
| 230 |
+
|
| 231 |
+
Q[Batch Processor] --> R[Large-scale Processing]
|
| 232 |
+
Q --> S[Export & Analytics]
|
| 233 |
+
|
| 234 |
+
T[Trend Analyzer] --> U[Business Intelligence]
|
| 235 |
+
T --> V[Predictive Insights]
|
| 236 |
+
```
|
| 237 |
+
|
| 238 |
+
## 📊 Performance Metrics
|
| 239 |
+
|
| 240 |
+
### System Performance
|
| 241 |
+
- **Processing Speed**: 5-10 reviews/second (single-threaded)
|
| 242 |
+
- **Batch Throughput**: 100-500 reviews/minute (multi-threaded)
|
| 243 |
+
- **Accuracy**: 85-95% sentiment classification accuracy
|
| 244 |
+
- **Response Generation**: 80-90% automated response rate
|
| 245 |
+
- **Escalation Rate**: 5-15% (varies by domain)
|
| 246 |
+
|
| 247 |
+
### Quality Metrics
|
| 248 |
+
- **Confidence Calibration**: Properly calibrated uncertainty estimates
|
| 249 |
+
- **QA Pass Rate**: 90-95% quality assurance validation
|
| 250 |
+
- **System Reliability**: 99%+ uptime with health monitoring
|
| 251 |
+
- **API Response Time**: <500ms for single analysis requests
|
| 252 |
+
|
| 253 |
+
## � Security
|
| 254 |
+
|
| 255 |
+
### API Key Management
|
| 256 |
+
|
| 257 |
+
- **Never commit API keys** to version control
|
| 258 |
+
- **Use environment variables** or `.env` files to store sensitive credentials
|
| 259 |
+
- **Add `.env` to `.gitignore`** to prevent accidental commits
|
| 260 |
+
- **Rotate API keys regularly** for enhanced security
|
| 261 |
+
|
| 262 |
+
### Best Practices
|
| 263 |
+
|
| 264 |
+
1. **Environment Variables**: Store your OpenAI API key in environment variables
|
| 265 |
+
2. **Local Configuration**: Use `.env` files for local development (excluded from git)
|
| 266 |
+
3. **Production Deployment**: Use secure secret management services (AWS Secrets Manager, Azure Key Vault, etc.)
|
| 267 |
+
4. **Access Control**: Limit API key permissions and monitor usage
|
| 268 |
+
|
| 269 |
+
## �🔧 Configuration
|
| 270 |
+
|
| 271 |
+
### Environment Variables
|
| 272 |
+
|
| 273 |
+
```bash
|
| 274 |
+
# Required
|
| 275 |
+
OPENAI_API_KEY=your_openai_api_key
|
| 276 |
+
|
| 277 |
+
# Optional (with defaults)
|
| 278 |
+
SENTIMENT_CONFIDENCE_THRESHOLD=0.7
|
| 279 |
+
ESCALATION_RATE_THRESHOLD=0.15
|
| 280 |
+
PROCESSING_TIME_THRESHOLD=5.0
|
| 281 |
+
ERROR_RATE_THRESHOLD=0.05
|
| 282 |
+
```
|
| 283 |
+
|
| 284 |
+
### System Configuration
|
| 285 |
+
|
| 286 |
+
The system supports extensive configuration through the `DeploymentManager` class:
|
| 287 |
+
|
| 288 |
+
```python
|
| 289 |
+
deployment_config = {
|
| 290 |
+
'environment': 'production',
|
| 291 |
+
'version': '1.0.0',
|
| 292 |
+
'max_concurrent_requests': 100,
|
| 293 |
+
'rate_limiting': {
|
| 294 |
+
'requests_per_minute': 1000,
|
| 295 |
+
'burst_capacity': 50
|
| 296 |
+
},
|
| 297 |
+
'caching': {
|
| 298 |
+
'enabled': True,
|
| 299 |
+
'ttl_seconds': 300
|
| 300 |
+
},
|
| 301 |
+
'monitoring': {
|
| 302 |
+
'metrics_collection': True,
|
| 303 |
+
'alert_webhooks': ['your-webhook-url']
|
| 304 |
+
}
|
| 305 |
+
}
|
| 306 |
+
```
|
| 307 |
+
|
| 308 |
+
## 🔍 Monitoring & Analytics
|
| 309 |
+
|
| 310 |
+
### Real-time Monitoring
|
| 311 |
+
|
| 312 |
+
The system includes comprehensive monitoring capabilities:
|
| 313 |
+
|
| 314 |
+
- **System Health**: CPU, memory, and processing metrics
|
| 315 |
+
- **Performance Tracking**: Response times and throughput monitoring
|
| 316 |
+
- **Quality Metrics**: Confidence scores and accuracy tracking
|
| 317 |
+
- **Alert Management**: Automated alerting for system issues
|
| 318 |
+
|
| 319 |
+
### Analytics Dashboard
|
| 320 |
+
|
| 321 |
+
Access detailed analytics through the built-in dashboard:
|
| 322 |
+
|
| 323 |
+
```python
|
| 324 |
+
# Get comprehensive analytics
|
| 325 |
+
analytics = analyzer.get_analytics_dashboard()
|
| 326 |
+
print(f"Total Reviews Analyzed: {analytics['total_reviews_analyzed']}")
|
| 327 |
+
print(f"Average Confidence: {analytics['metrics']['average_confidence']:.2f}")
|
| 328 |
+
|
| 329 |
+
# Generate health report
|
| 330 |
+
health_report = monitoring_system.generate_health_report()
|
| 331 |
+
print(health_report)
|
| 332 |
+
```
|
| 333 |
+
|
| 334 |
+
## 🧪 Testing & Validation
|
| 335 |
+
|
| 336 |
+
### Running Tests
|
| 337 |
+
|
| 338 |
+
The notebook includes comprehensive testing scenarios:
|
| 339 |
+
|
| 340 |
+
1. **Individual Analysis Tests**: 10 diverse review scenarios
|
| 341 |
+
2. **Batch Processing Tests**: Large-scale processing validation
|
| 342 |
+
3. **API Gateway Tests**: Endpoint functionality verification
|
| 343 |
+
4. **Performance Benchmarks**: Speed and accuracy measurements
|
| 344 |
+
5. **System Health Checks**: Component validation and monitoring
|
| 345 |
+
|
| 346 |
+
### Validation Results
|
| 347 |
+
|
| 348 |
+
The system has been validated with:
|
| 349 |
+
- ✅ Multi-dimensional sentiment analysis
|
| 350 |
+
- ✅ Emotion detection and classification
|
| 351 |
+
- ✅ Automated response generation
|
| 352 |
+
- ✅ Quality assurance and escalation management
|
| 353 |
+
- ✅ Production deployment readiness
|
| 354 |
+
- ✅ Comprehensive monitoring and analytics
|
| 355 |
+
|
| 356 |
+
## 🚀 Deployment
|
| 357 |
+
|
| 358 |
+
### Production Deployment
|
| 359 |
+
|
| 360 |
+
1. **Run deployment readiness check**:
|
| 361 |
+
```python
|
| 362 |
+
deployment_status = platform.deployment_manager.prepare_production_deployment()
|
| 363 |
+
print(f"Deployment Ready: {deployment_status['deployment_ready']}")
|
| 364 |
+
```
|
| 365 |
+
|
| 366 |
+
2. **Configure production environment**:
|
| 367 |
+
- Set production API keys and credentials
|
| 368 |
+
- Configure monitoring and alerting endpoints
|
| 369 |
+
- Set up rate limiting and authentication
|
| 370 |
+
- Configure database connections (if required)
|
| 371 |
+
|
| 372 |
+
3. **Deploy with your preferred method**:
|
| 373 |
+
- Docker containerization
|
| 374 |
+
- Cloud platforms (AWS, Azure, GCP)
|
| 375 |
+
- Kubernetes orchestration
|
| 376 |
+
- Traditional server deployment
|
| 377 |
+
|
| 378 |
+
### Docker Deployment
|
| 379 |
+
|
| 380 |
+
```dockerfile
|
| 381 |
+
FROM python:3.9-slim
|
| 382 |
+
|
| 383 |
+
WORKDIR /app
|
| 384 |
+
COPY requirements.txt .
|
| 385 |
+
RUN pip install -r requirements.txt
|
| 386 |
+
|
| 387 |
+
COPY . .
|
| 388 |
+
EXPOSE 8000
|
| 389 |
+
|
| 390 |
+
CMD ["python", "production_server.py"]
|
| 391 |
+
```
|
| 392 |
+
|
| 393 |
+
## 📈 Roadmap
|
| 394 |
+
|
| 395 |
+
### Upcoming Features
|
| 396 |
+
- [ ] **Multi-language Support**: Expand beyond English sentiment analysis
|
| 397 |
+
- [ ] **Real-time Streaming**: Process live data streams with minimal latency
|
| 398 |
+
- [ ] **Advanced ML Models**: Integration with transformer-based models
|
| 399 |
+
- [ ] **Custom Training**: Domain-specific model fine-tuning capabilities
|
| 400 |
+
- [ ] **Enhanced Visualization**: Interactive dashboards and reporting tools
|
| 401 |
+
|
| 402 |
+
### Performance Improvements
|
| 403 |
+
- [ ] **Caching Layer**: Redis integration for improved response times
|
| 404 |
+
- [ ] **Database Integration**: PostgreSQL/MongoDB for persistent storage
|
| 405 |
+
- [ ] **Distributed Processing**: Celery/RQ for scalable background processing
|
| 406 |
+
- [ ] **Advanced Monitoring**: Prometheus/Grafana integration
|
| 407 |
+
|
| 408 |
+
## 🤝 Contributing
|
| 409 |
+
|
| 410 |
+
We welcome contributions! Please see our [Contributing Guidelines](CONTRIBUTING.md) for details.
|
| 411 |
+
|
| 412 |
+
### Development Setup
|
| 413 |
+
|
| 414 |
+
1. Fork the repository
|
| 415 |
+
2. Create a feature branch: `git checkout -b feature-name`
|
| 416 |
+
3. Make your changes and add tests
|
| 417 |
+
4. Run the test suite: `python -m pytest tests/`
|
| 418 |
+
5. Submit a pull request
|
| 419 |
+
|
| 420 |
+
## 📄 License
|
| 421 |
+
|
| 422 |
+
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
|
| 423 |
+
|
| 424 |
+
## 🙏 Acknowledgments
|
| 425 |
+
|
| 426 |
+
- **DSPy Framework**: For providing the foundation for declarative language programming
|
| 427 |
+
- **OpenAI**: For the powerful GPT-4 language model
|
| 428 |
+
- **Open Source Community**: For the excellent libraries and tools that make this project possible
|
| 429 |
+
|
| 430 |
+
## 📞 Support
|
| 431 |
+
|
| 432 |
+
- **Documentation**: Full documentation in the Jupyter notebook
|
| 433 |
+
- **Issues**: Report bugs and feature requests via GitHub Issues
|
| 434 |
+
- **Discussions**: Join our community discussions for questions and support
|
| 435 |
+
|
| 436 |
+
## ⭐ Star History
|
| 437 |
+
|
| 438 |
+
If you find this project useful, please consider giving it a star! ⭐
|
| 439 |
+
|
| 440 |
---
|
| 441 |
+
|
| 442 |
+
**Built with ❤️ for the sentiment analysis community**
|
| 443 |
+
|
| 444 |
+
*Ready for production deployment and enterprise use cases*
|
advanced_sentiment_analysis.ipynb
ADDED
|
The diff for this file is too large to render.
See raw diff
|
|
|
config/README.md
ADDED
|
@@ -0,0 +1,127 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Advanced Sentiment Analysis System - Configuration
|
| 2 |
+
|
| 3 |
+
## Environment Configuration
|
| 4 |
+
|
| 5 |
+
This file contains configuration settings for different deployment environments.
|
| 6 |
+
|
| 7 |
+
### Development Environment (.env.development)
|
| 8 |
+
```env
|
| 9 |
+
# Development Configuration
|
| 10 |
+
OPENAI_API_KEY=your_development_api_key_here
|
| 11 |
+
ENVIRONMENT=development
|
| 12 |
+
DEBUG=true
|
| 13 |
+
LOG_LEVEL=DEBUG
|
| 14 |
+
|
| 15 |
+
# Database (if applicable)
|
| 16 |
+
DATABASE_URL=sqlite:///./dev_sentiment.db
|
| 17 |
+
|
| 18 |
+
# API Configuration
|
| 19 |
+
API_HOST=localhost
|
| 20 |
+
API_PORT=8000
|
| 21 |
+
API_WORKERS=1
|
| 22 |
+
|
| 23 |
+
# Rate Limiting (development - more lenient)
|
| 24 |
+
RATE_LIMIT_REQUESTS_PER_MINUTE=100
|
| 25 |
+
MAX_CONCURRENT_REQUESTS=10
|
| 26 |
+
|
| 27 |
+
# Security
|
| 28 |
+
CORS_ORIGINS=["http://localhost:3000", "http://localhost:8080"]
|
| 29 |
+
ALLOWED_HOSTS=["localhost", "127.0.0.1"]
|
| 30 |
+
|
| 31 |
+
# Monitoring
|
| 32 |
+
ENABLE_METRICS=true
|
| 33 |
+
METRICS_PORT=9090
|
| 34 |
+
```
|
| 35 |
+
|
| 36 |
+
### Production Environment (.env.production)
|
| 37 |
+
```env
|
| 38 |
+
# Production Configuration
|
| 39 |
+
OPENAI_API_KEY=your_production_api_key_here
|
| 40 |
+
ENVIRONMENT=production
|
| 41 |
+
DEBUG=false
|
| 42 |
+
LOG_LEVEL=INFO
|
| 43 |
+
|
| 44 |
+
# Database
|
| 45 |
+
DATABASE_URL=postgresql://user:password@db_host:5432/sentiment_analysis
|
| 46 |
+
|
| 47 |
+
# API Configuration
|
| 48 |
+
API_HOST=0.0.0.0
|
| 49 |
+
API_PORT=8000
|
| 50 |
+
API_WORKERS=4
|
| 51 |
+
|
| 52 |
+
# Rate Limiting (production - more restrictive)
|
| 53 |
+
RATE_LIMIT_REQUESTS_PER_MINUTE=1000
|
| 54 |
+
MAX_CONCURRENT_REQUESTS=100
|
| 55 |
+
|
| 56 |
+
# Security
|
| 57 |
+
CORS_ORIGINS=["https://yourdomain.com"]
|
| 58 |
+
ALLOWED_HOSTS=["yourdomain.com", "api.yourdomain.com"]
|
| 59 |
+
SECRET_KEY=your_secret_key_here
|
| 60 |
+
|
| 61 |
+
# Monitoring and Logging
|
| 62 |
+
ENABLE_METRICS=true
|
| 63 |
+
METRICS_PORT=9090
|
| 64 |
+
LOG_FILE=/var/log/sentiment_analysis.log
|
| 65 |
+
SENTRY_DSN=your_sentry_dsn_here
|
| 66 |
+
|
| 67 |
+
# Caching
|
| 68 |
+
REDIS_URL=redis://redis:6379/0
|
| 69 |
+
CACHE_TTL=3600
|
| 70 |
+
|
| 71 |
+
# Performance
|
| 72 |
+
WORKER_TIMEOUT=30
|
| 73 |
+
KEEP_ALIVE=2
|
| 74 |
+
```
|
| 75 |
+
|
| 76 |
+
### Testing Environment (.env.test)
|
| 77 |
+
```env
|
| 78 |
+
# Testing Configuration
|
| 79 |
+
OPENAI_API_KEY=test_api_key
|
| 80 |
+
ENVIRONMENT=test
|
| 81 |
+
DEBUG=true
|
| 82 |
+
LOG_LEVEL=DEBUG
|
| 83 |
+
|
| 84 |
+
# Test Database
|
| 85 |
+
DATABASE_URL=sqlite:///./test_sentiment.db
|
| 86 |
+
|
| 87 |
+
# API Configuration
|
| 88 |
+
API_HOST=localhost
|
| 89 |
+
API_PORT=8001
|
| 90 |
+
API_WORKERS=1
|
| 91 |
+
|
| 92 |
+
# Disable external services for testing
|
| 93 |
+
ENABLE_EXTERNAL_APIS=false
|
| 94 |
+
MOCK_RESPONSES=true
|
| 95 |
+
|
| 96 |
+
# Rate Limiting (testing - very lenient)
|
| 97 |
+
RATE_LIMIT_REQUESTS_PER_MINUTE=10000
|
| 98 |
+
MAX_CONCURRENT_REQUESTS=50
|
| 99 |
+
```
|
| 100 |
+
|
| 101 |
+
## Configuration Management
|
| 102 |
+
|
| 103 |
+
### Loading Configuration
|
| 104 |
+
The application automatically loads the appropriate configuration based on the `ENVIRONMENT` variable:
|
| 105 |
+
|
| 106 |
+
1. Check for environment-specific file (`.env.{ENVIRONMENT}`)
|
| 107 |
+
2. Fall back to `.env` file
|
| 108 |
+
3. Use default values for missing configurations
|
| 109 |
+
|
| 110 |
+
### Security Best Practices
|
| 111 |
+
- Never commit actual API keys to version control
|
| 112 |
+
- Use environment-specific configuration files
|
| 113 |
+
- Rotate API keys regularly
|
| 114 |
+
- Use strong secret keys for production
|
| 115 |
+
- Enable proper CORS settings for web applications
|
| 116 |
+
|
| 117 |
+
### Monitoring Configuration
|
| 118 |
+
- Enable metrics collection in production
|
| 119 |
+
- Configure proper log levels for each environment
|
| 120 |
+
- Set up error tracking with Sentry or similar service
|
| 121 |
+
- Configure health check endpoints
|
| 122 |
+
|
| 123 |
+
### Performance Tuning
|
| 124 |
+
- Adjust worker counts based on server resources
|
| 125 |
+
- Configure appropriate timeouts
|
| 126 |
+
- Enable caching in production
|
| 127 |
+
- Set reasonable rate limits
|
docker-compose.yml
ADDED
|
@@ -0,0 +1,71 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
version: '3.8'
|
| 2 |
+
|
| 3 |
+
services:
|
| 4 |
+
sentiment-analysis:
|
| 5 |
+
build: .
|
| 6 |
+
container_name: advanced-sentiment-analysis
|
| 7 |
+
ports:
|
| 8 |
+
- "8888:8000"
|
| 9 |
+
environment:
|
| 10 |
+
- OPENAI_API_KEY=${OPENAI_API_KEY}
|
| 11 |
+
- ENVIRONMENT=production
|
| 12 |
+
- MAX_CONCURRENT_REQUESTS=100
|
| 13 |
+
- RATE_LIMIT_REQUESTS_PER_MINUTE=1000
|
| 14 |
+
volumes:
|
| 15 |
+
- ./data:/app/data
|
| 16 |
+
- ./logs:/app/logs
|
| 17 |
+
env_file:
|
| 18 |
+
- .env
|
| 19 |
+
restart: unless-stopped
|
| 20 |
+
healthcheck:
|
| 21 |
+
test: ["CMD", "curl", "-f", "http://localhost:8000/health"]
|
| 22 |
+
interval: 30s
|
| 23 |
+
timeout: 10s
|
| 24 |
+
retries: 3
|
| 25 |
+
start_period: 60s
|
| 26 |
+
|
| 27 |
+
redis:
|
| 28 |
+
image: redis:7-alpine
|
| 29 |
+
container_name: sentiment-redis
|
| 30 |
+
ports:
|
| 31 |
+
- "6379:6379"
|
| 32 |
+
volumes:
|
| 33 |
+
- redis_data:/data
|
| 34 |
+
restart: unless-stopped
|
| 35 |
+
command: redis-server --appendonly yes
|
| 36 |
+
|
| 37 |
+
prometheus:
|
| 38 |
+
image: prom/prometheus:latest
|
| 39 |
+
container_name: sentiment-prometheus
|
| 40 |
+
ports:
|
| 41 |
+
- "9090:9090"
|
| 42 |
+
volumes:
|
| 43 |
+
- ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml
|
| 44 |
+
- prometheus_data:/prometheus
|
| 45 |
+
command:
|
| 46 |
+
- '--config.file=/etc/prometheus/prometheus.yml'
|
| 47 |
+
- '--storage.tsdb.path=/prometheus'
|
| 48 |
+
- '--web.console.libraries=/etc/prometheus/console_libraries'
|
| 49 |
+
- '--web.console.templates=/etc/prometheus/consoles'
|
| 50 |
+
restart: unless-stopped
|
| 51 |
+
|
| 52 |
+
grafana:
|
| 53 |
+
image: grafana/grafana:latest
|
| 54 |
+
container_name: sentiment-grafana
|
| 55 |
+
ports:
|
| 56 |
+
- "3000:3000"
|
| 57 |
+
environment:
|
| 58 |
+
- GF_SECURITY_ADMIN_PASSWORD=admin
|
| 59 |
+
volumes:
|
| 60 |
+
- grafana_data:/var/lib/grafana
|
| 61 |
+
- ./monitoring/grafana:/etc/grafana/provisioning
|
| 62 |
+
restart: unless-stopped
|
| 63 |
+
|
| 64 |
+
volumes:
|
| 65 |
+
redis_data:
|
| 66 |
+
prometheus_data:
|
| 67 |
+
grafana_data:
|
| 68 |
+
|
| 69 |
+
networks:
|
| 70 |
+
default:
|
| 71 |
+
name: sentiment-analysis-network
|
docs/README.md
ADDED
|
@@ -0,0 +1,70 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Documentation
|
| 2 |
+
|
| 3 |
+
## Project Documentation
|
| 4 |
+
|
| 5 |
+
Welcome to the Advanced Sentiment Analysis System documentation. This directory contains comprehensive guides, API documentation, and deployment instructions.
|
| 6 |
+
|
| 7 |
+
## Documentation Structure
|
| 8 |
+
|
| 9 |
+
```
|
| 10 |
+
docs/
|
| 11 |
+
├── README.md # This file
|
| 12 |
+
├── api/
|
| 13 |
+
│ ├── endpoints.md # API endpoint documentation
|
| 14 |
+
│ ├── authentication.md # Authentication guide
|
| 15 |
+
│ └── rate_limiting.md # Rate limiting information
|
| 16 |
+
├── deployment/
|
| 17 |
+
│ ├── docker.md # Docker deployment guide
|
| 18 |
+
│ ├── kubernetes.md # Kubernetes deployment
|
| 19 |
+
│ ├── cloud_platforms.md # Cloud platform guides
|
| 20 |
+
│ └── monitoring.md # Monitoring and observability
|
| 21 |
+
├── development/
|
| 22 |
+
│ ├── setup.md # Development environment setup
|
| 23 |
+
│ ├── contributing.md # Contribution guidelines
|
| 24 |
+
│ ├── coding_standards.md # Code style and standards
|
| 25 |
+
│ └── testing.md # Testing guidelines
|
| 26 |
+
├── user_guides/
|
| 27 |
+
│ ├── quick_start.md # Quick start guide
|
| 28 |
+
│ ├── advanced_usage.md # Advanced features
|
| 29 |
+
│ ├── troubleshooting.md # Common issues and solutions
|
| 30 |
+
│ └── examples.md # Usage examples
|
| 31 |
+
└── architecture/
|
| 32 |
+
├── overview.md # System architecture overview
|
| 33 |
+
├── components.md # Component descriptions
|
| 34 |
+
├── data_flow.md # Data flow diagrams
|
| 35 |
+
└── security.md # Security architecture
|
| 36 |
+
```
|
| 37 |
+
|
| 38 |
+
## Quick Links
|
| 39 |
+
|
| 40 |
+
- [Quick Start Guide](user_guides/quick_start.md)
|
| 41 |
+
- [API Documentation](api/endpoints.md)
|
| 42 |
+
- [Development Setup](development/setup.md)
|
| 43 |
+
- [Deployment Guide](deployment/docker.md)
|
| 44 |
+
- [Architecture Overview](architecture/overview.md)
|
| 45 |
+
|
| 46 |
+
## Getting Started
|
| 47 |
+
|
| 48 |
+
1. **New Users**: Start with the [Quick Start Guide](user_guides/quick_start.md)
|
| 49 |
+
2. **Developers**: See [Development Setup](development/setup.md)
|
| 50 |
+
3. **DevOps**: Check [Deployment Guide](deployment/docker.md)
|
| 51 |
+
4. **API Users**: Review [API Documentation](api/endpoints.md)
|
| 52 |
+
|
| 53 |
+
## Documentation Standards
|
| 54 |
+
|
| 55 |
+
- All documentation is written in Markdown
|
| 56 |
+
- Code examples are tested and verified
|
| 57 |
+
- Screenshots are kept up-to-date
|
| 58 |
+
- Links are checked for validity
|
| 59 |
+
- Documentation follows the project's style guide
|
| 60 |
+
|
| 61 |
+
## Contributing to Documentation
|
| 62 |
+
|
| 63 |
+
Please see [Contributing Guidelines](development/contributing.md) for information on how to contribute to the documentation.
|
| 64 |
+
|
| 65 |
+
## Support
|
| 66 |
+
|
| 67 |
+
If you find any issues with the documentation or need clarification, please:
|
| 68 |
+
1. Check the [Troubleshooting Guide](user_guides/troubleshooting.md)
|
| 69 |
+
2. Search existing [GitHub Issues](https://github.com/skkuhg/advanced-sentiment-analysis/issues)
|
| 70 |
+
3. Create a new issue with the "documentation" label
|
requirements.txt
ADDED
|
@@ -0,0 +1,34 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Core Dependencies
|
| 2 |
+
dspy-ai>=2.4.0
|
| 3 |
+
openai>=1.0.0
|
| 4 |
+
pandas>=1.5.0
|
| 5 |
+
numpy>=1.21.0
|
| 6 |
+
scikit-learn>=1.1.0
|
| 7 |
+
|
| 8 |
+
# Data Processing
|
| 9 |
+
matplotlib>=3.5.0
|
| 10 |
+
seaborn>=0.11.0
|
| 11 |
+
plotly>=5.0.0
|
| 12 |
+
openpyxl>=3.0.0
|
| 13 |
+
|
| 14 |
+
# Jupyter Environment
|
| 15 |
+
jupyter>=1.0.0
|
| 16 |
+
ipykernel>=6.0.0
|
| 17 |
+
ipywidgets>=7.0.0
|
| 18 |
+
|
| 19 |
+
# Production Features
|
| 20 |
+
python-dotenv>=0.19.0
|
| 21 |
+
requests>=2.28.0
|
| 22 |
+
flask>=2.0.0
|
| 23 |
+
gunicorn>=20.1.0
|
| 24 |
+
|
| 25 |
+
# Development Tools
|
| 26 |
+
pytest>=7.0.0
|
| 27 |
+
pytest-cov>=4.0.0
|
| 28 |
+
black>=22.0.0
|
| 29 |
+
flake8>=5.0.0
|
| 30 |
+
|
| 31 |
+
# Optional but Recommended
|
| 32 |
+
redis>=4.3.0
|
| 33 |
+
celery>=5.2.0
|
| 34 |
+
prometheus-client>=0.14.0
|
setup.py
ADDED
|
@@ -0,0 +1,227 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
#!/usr/bin/env python3
|
| 2 |
+
"""
|
| 3 |
+
Advanced Sentiment Analysis System - Setup Script
|
| 4 |
+
==================================================
|
| 5 |
+
|
| 6 |
+
This script helps you set up the Advanced Sentiment Analysis System
|
| 7 |
+
with proper environment configuration and security measures.
|
| 8 |
+
|
| 9 |
+
Usage:
|
| 10 |
+
python setup.py
|
| 11 |
+
"""
|
| 12 |
+
|
| 13 |
+
import os
|
| 14 |
+
import sys
|
| 15 |
+
import subprocess
|
| 16 |
+
import getpass
|
| 17 |
+
from pathlib import Path
|
| 18 |
+
|
| 19 |
+
def print_banner():
|
| 20 |
+
"""Print setup banner"""
|
| 21 |
+
print("=" * 70)
|
| 22 |
+
print("🚀 Advanced Sentiment Analysis System - Setup")
|
| 23 |
+
print("=" * 70)
|
| 24 |
+
print("Setting up your production-ready sentiment analysis platform...")
|
| 25 |
+
print()
|
| 26 |
+
|
| 27 |
+
def check_python_version():
|
| 28 |
+
"""Check Python version compatibility"""
|
| 29 |
+
if sys.version_info < (3, 8):
|
| 30 |
+
print("❌ Python 3.8 or higher is required")
|
| 31 |
+
print(f" Current version: {sys.version}")
|
| 32 |
+
sys.exit(1)
|
| 33 |
+
print(f"✅ Python version: {sys.version.split()[0]}")
|
| 34 |
+
|
| 35 |
+
def install_dependencies():
|
| 36 |
+
"""Install required dependencies"""
|
| 37 |
+
print("\n📦 Installing dependencies...")
|
| 38 |
+
|
| 39 |
+
requirements = [
|
| 40 |
+
"dspy-ai>=2.4.0",
|
| 41 |
+
"openai>=1.0.0",
|
| 42 |
+
"pandas>=1.5.0",
|
| 43 |
+
"numpy>=1.21.0",
|
| 44 |
+
"scikit-learn>=1.1.0",
|
| 45 |
+
"matplotlib>=3.5.0",
|
| 46 |
+
"seaborn>=0.11.0",
|
| 47 |
+
"plotly>=5.0.0",
|
| 48 |
+
"openpyxl>=3.0.0",
|
| 49 |
+
"jupyter>=1.0.0",
|
| 50 |
+
"ipykernel>=6.0.0",
|
| 51 |
+
"ipywidgets>=7.0.0",
|
| 52 |
+
"python-dotenv>=0.19.0",
|
| 53 |
+
"requests>=2.28.0"
|
| 54 |
+
]
|
| 55 |
+
|
| 56 |
+
for package in requirements:
|
| 57 |
+
try:
|
| 58 |
+
print(f" Installing {package}...")
|
| 59 |
+
subprocess.check_call([sys.executable, "-m", "pip", "install", package, "-q"])
|
| 60 |
+
except subprocess.CalledProcessError:
|
| 61 |
+
print(f" ⚠️ Warning: Failed to install {package}")
|
| 62 |
+
|
| 63 |
+
print("✅ Dependencies installation completed")
|
| 64 |
+
|
| 65 |
+
def setup_environment():
|
| 66 |
+
"""Setup environment configuration"""
|
| 67 |
+
print("\n🔧 Setting up environment configuration...")
|
| 68 |
+
|
| 69 |
+
env_file = Path(".env")
|
| 70 |
+
|
| 71 |
+
if env_file.exists():
|
| 72 |
+
print(" .env file already exists")
|
| 73 |
+
overwrite = input(" Do you want to overwrite it? (y/N): ").lower()
|
| 74 |
+
if overwrite != 'y':
|
| 75 |
+
print(" Keeping existing .env file")
|
| 76 |
+
return
|
| 77 |
+
|
| 78 |
+
# Get OpenAI API key
|
| 79 |
+
print("\n🔑 OpenAI API Key Configuration")
|
| 80 |
+
print(" You need an OpenAI API key to use this system.")
|
| 81 |
+
print(" Get one at: https://platform.openai.com/api-keys")
|
| 82 |
+
|
| 83 |
+
api_key = getpass.getpass(" Enter your OpenAI API key (input hidden): ").strip()
|
| 84 |
+
|
| 85 |
+
if not api_key:
|
| 86 |
+
print(" ⚠️ No API key provided. You can set it later.")
|
| 87 |
+
api_key = "your_openai_api_key_here"
|
| 88 |
+
elif not api_key.startswith("sk-"):
|
| 89 |
+
print(" ⚠️ Warning: API key should start with 'sk-'")
|
| 90 |
+
|
| 91 |
+
# Create .env file
|
| 92 |
+
env_content = f"""# Advanced Sentiment Analysis System - Environment Configuration
|
| 93 |
+
# Created by setup.py
|
| 94 |
+
|
| 95 |
+
# OpenAI API Configuration (REQUIRED)
|
| 96 |
+
OPENAI_API_KEY={api_key}
|
| 97 |
+
|
| 98 |
+
# Sentiment Analysis Thresholds (Optional - defaults provided)
|
| 99 |
+
SENTIMENT_CONFIDENCE_THRESHOLD=0.7
|
| 100 |
+
ESCALATION_RATE_THRESHOLD=0.15
|
| 101 |
+
PROCESSING_TIME_THRESHOLD=5.0
|
| 102 |
+
ERROR_RATE_THRESHOLD=0.05
|
| 103 |
+
|
| 104 |
+
# Production Configuration (Optional)
|
| 105 |
+
ENVIRONMENT=development
|
| 106 |
+
MAX_CONCURRENT_REQUESTS=100
|
| 107 |
+
RATE_LIMIT_REQUESTS_PER_MINUTE=1000
|
| 108 |
+
RATE_LIMIT_BURST_CAPACITY=50
|
| 109 |
+
|
| 110 |
+
# Monitoring Configuration (Optional)
|
| 111 |
+
METRICS_COLLECTION_ENABLED=true
|
| 112 |
+
|
| 113 |
+
# Logging Configuration (Optional)
|
| 114 |
+
LOG_LEVEL=INFO
|
| 115 |
+
LOG_FORMAT=json
|
| 116 |
+
|
| 117 |
+
# Cache Configuration (Optional)
|
| 118 |
+
CACHE_ENABLED=true
|
| 119 |
+
CACHE_TTL_SECONDS=300
|
| 120 |
+
|
| 121 |
+
# Performance Configuration (Optional)
|
| 122 |
+
BATCH_SIZE_DEFAULT=100
|
| 123 |
+
MAX_WORKERS_DEFAULT=10
|
| 124 |
+
PROCESSING_TIMEOUT_SECONDS=30
|
| 125 |
+
"""
|
| 126 |
+
|
| 127 |
+
with open(".env", "w") as f:
|
| 128 |
+
f.write(env_content)
|
| 129 |
+
|
| 130 |
+
print("✅ Environment configuration created (.env)")
|
| 131 |
+
|
| 132 |
+
def setup_jupyter():
|
| 133 |
+
"""Setup Jupyter environment"""
|
| 134 |
+
print("\n📚 Setting up Jupyter environment...")
|
| 135 |
+
|
| 136 |
+
try:
|
| 137 |
+
# Install Jupyter extensions
|
| 138 |
+
subprocess.check_call([sys.executable, "-m", "pip", "install", "jupyter_contrib_nbextensions", "-q"])
|
| 139 |
+
print("✅ Jupyter extensions installed")
|
| 140 |
+
|
| 141 |
+
# Enable widgets
|
| 142 |
+
subprocess.check_call([sys.executable, "-m", "jupyter", "nbextension", "enable", "--py", "widgetsnbextension", "--sys-prefix"])
|
| 143 |
+
print("✅ Jupyter widgets enabled")
|
| 144 |
+
|
| 145 |
+
except subprocess.CalledProcessError:
|
| 146 |
+
print(" ⚠️ Warning: Some Jupyter setup steps failed")
|
| 147 |
+
|
| 148 |
+
def verify_installation():
|
| 149 |
+
"""Verify the installation"""
|
| 150 |
+
print("\n🔍 Verifying installation...")
|
| 151 |
+
|
| 152 |
+
try:
|
| 153 |
+
# Test imports
|
| 154 |
+
import pandas
|
| 155 |
+
import numpy
|
| 156 |
+
import matplotlib
|
| 157 |
+
import seaborn
|
| 158 |
+
import plotly
|
| 159 |
+
import sklearn
|
| 160 |
+
import dspy
|
| 161 |
+
import openai
|
| 162 |
+
|
| 163 |
+
print("✅ All core packages imported successfully")
|
| 164 |
+
|
| 165 |
+
# Check environment
|
| 166 |
+
if os.path.exists(".env"):
|
| 167 |
+
print("✅ Environment configuration found")
|
| 168 |
+
else:
|
| 169 |
+
print("⚠️ Environment configuration not found")
|
| 170 |
+
|
| 171 |
+
# Check notebook
|
| 172 |
+
if os.path.exists("advanced_sentiment_analysis.ipynb"):
|
| 173 |
+
print("✅ Main notebook found")
|
| 174 |
+
else:
|
| 175 |
+
print("⚠️ Main notebook not found")
|
| 176 |
+
|
| 177 |
+
except ImportError as e:
|
| 178 |
+
print(f"❌ Import error: {e}")
|
| 179 |
+
return False
|
| 180 |
+
|
| 181 |
+
return True
|
| 182 |
+
|
| 183 |
+
def print_next_steps():
|
| 184 |
+
"""Print next steps for the user"""
|
| 185 |
+
print("\n" + "=" * 70)
|
| 186 |
+
print("🎉 Setup completed successfully!")
|
| 187 |
+
print("=" * 70)
|
| 188 |
+
print("\n📋 Next Steps:")
|
| 189 |
+
print(" 1. Start Jupyter Notebook:")
|
| 190 |
+
print(" jupyter notebook advanced_sentiment_analysis.ipynb")
|
| 191 |
+
print("\n 2. Run all cells in the notebook to initialize the system")
|
| 192 |
+
print("\n 3. The system will automatically use your configured API key")
|
| 193 |
+
print("\n 4. Check the README.md for detailed usage examples")
|
| 194 |
+
print("\n🔗 Useful Links:")
|
| 195 |
+
print(" • Documentation: README.md")
|
| 196 |
+
print(" • Contributing: CONTRIBUTING.md")
|
| 197 |
+
print(" • License: LICENSE")
|
| 198 |
+
print("\n💡 Tips:")
|
| 199 |
+
print(" • Keep your .env file secure and never commit it to git")
|
| 200 |
+
print(" • Monitor your OpenAI API usage at platform.openai.com")
|
| 201 |
+
print(" • Check CHANGELOG.md for updates and new features")
|
| 202 |
+
print("\n" + "=" * 70)
|
| 203 |
+
|
| 204 |
+
def main():
|
| 205 |
+
"""Main setup function"""
|
| 206 |
+
try:
|
| 207 |
+
print_banner()
|
| 208 |
+
check_python_version()
|
| 209 |
+
install_dependencies()
|
| 210 |
+
setup_environment()
|
| 211 |
+
setup_jupyter()
|
| 212 |
+
|
| 213 |
+
if verify_installation():
|
| 214 |
+
print_next_steps()
|
| 215 |
+
else:
|
| 216 |
+
print("\n❌ Setup completed with errors. Please check the output above.")
|
| 217 |
+
sys.exit(1)
|
| 218 |
+
|
| 219 |
+
except KeyboardInterrupt:
|
| 220 |
+
print("\n\n⚠️ Setup interrupted by user")
|
| 221 |
+
sys.exit(1)
|
| 222 |
+
except Exception as e:
|
| 223 |
+
print(f"\n❌ Setup failed with error: {e}")
|
| 224 |
+
sys.exit(1)
|
| 225 |
+
|
| 226 |
+
if __name__ == "__main__":
|
| 227 |
+
main()
|
tests/README.md
ADDED
|
@@ -0,0 +1,93 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
# Testing Framework
|
| 2 |
+
|
| 3 |
+
## Overview
|
| 4 |
+
This directory contains comprehensive tests for the Advanced Sentiment Analysis System.
|
| 5 |
+
|
| 6 |
+
## Test Structure
|
| 7 |
+
```
|
| 8 |
+
tests/
|
| 9 |
+
├── __init__.py
|
| 10 |
+
├── conftest.py # pytest configuration and fixtures
|
| 11 |
+
├── test_sentiment_analysis.py # Core sentiment analysis tests
|
| 12 |
+
├── test_api.py # API endpoint tests
|
| 13 |
+
├── test_security.py # Security and validation tests
|
| 14 |
+
├── test_performance.py # Performance and load tests
|
| 15 |
+
├── integration/ # Integration tests
|
| 16 |
+
│ ├── __init__.py
|
| 17 |
+
│ └── test_end_to_end.py
|
| 18 |
+
└── fixtures/ # Test data and fixtures
|
| 19 |
+
├── sample_texts.json
|
| 20 |
+
└── expected_results.json
|
| 21 |
+
```
|
| 22 |
+
|
| 23 |
+
## Running Tests
|
| 24 |
+
|
| 25 |
+
### All Tests
|
| 26 |
+
```bash
|
| 27 |
+
pytest tests/
|
| 28 |
+
```
|
| 29 |
+
|
| 30 |
+
### With Coverage
|
| 31 |
+
```bash
|
| 32 |
+
pytest tests/ --cov=./ --cov-report=html
|
| 33 |
+
```
|
| 34 |
+
|
| 35 |
+
### Specific Test Categories
|
| 36 |
+
```bash
|
| 37 |
+
# Unit tests only
|
| 38 |
+
pytest tests/test_*.py
|
| 39 |
+
|
| 40 |
+
# Integration tests
|
| 41 |
+
pytest tests/integration/
|
| 42 |
+
|
| 43 |
+
# Performance tests
|
| 44 |
+
pytest tests/test_performance.py -v
|
| 45 |
+
```
|
| 46 |
+
|
| 47 |
+
## Test Categories
|
| 48 |
+
|
| 49 |
+
### Unit Tests
|
| 50 |
+
- Sentiment analysis accuracy
|
| 51 |
+
- DSPy module functionality
|
| 52 |
+
- Data preprocessing
|
| 53 |
+
- Error handling
|
| 54 |
+
|
| 55 |
+
### Integration Tests
|
| 56 |
+
- End-to-end workflow
|
| 57 |
+
- API integration
|
| 58 |
+
- Database operations
|
| 59 |
+
- External service integration
|
| 60 |
+
|
| 61 |
+
### Performance Tests
|
| 62 |
+
- Response time benchmarks
|
| 63 |
+
- Memory usage validation
|
| 64 |
+
- Concurrent request handling
|
| 65 |
+
- Scalability testing
|
| 66 |
+
|
| 67 |
+
### Security Tests
|
| 68 |
+
- Input validation
|
| 69 |
+
- API key protection
|
| 70 |
+
- Rate limiting
|
| 71 |
+
- Data sanitization
|
| 72 |
+
|
| 73 |
+
## Fixtures and Mock Data
|
| 74 |
+
|
| 75 |
+
Test fixtures are located in `tests/fixtures/` and include:
|
| 76 |
+
- Sample text data for various sentiment scenarios
|
| 77 |
+
- Expected analysis results
|
| 78 |
+
- Mock API responses
|
| 79 |
+
- Test configuration data
|
| 80 |
+
|
| 81 |
+
## Continuous Integration
|
| 82 |
+
|
| 83 |
+
Tests are automatically run on:
|
| 84 |
+
- Every push to main/develop branches
|
| 85 |
+
- Pull request creation
|
| 86 |
+
- Scheduled nightly runs
|
| 87 |
+
|
| 88 |
+
## Coverage Requirements
|
| 89 |
+
|
| 90 |
+
Minimum coverage thresholds:
|
| 91 |
+
- Overall: 85%
|
| 92 |
+
- Critical modules: 90%
|
| 93 |
+
- API endpoints: 95%
|
tests/fixtures/sample_texts.json
ADDED
|
@@ -0,0 +1,62 @@
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
| 1 |
+
[
|
| 2 |
+
{
|
| 3 |
+
"text": "I absolutely love this product! It exceeded all my expectations.",
|
| 4 |
+
"expected_sentiment": "positive",
|
| 5 |
+
"expected_confidence": 0.95,
|
| 6 |
+
"tags": ["product_review", "high_confidence"]
|
| 7 |
+
},
|
| 8 |
+
{
|
| 9 |
+
"text": "This is the worst experience I've ever had. Completely disappointed.",
|
| 10 |
+
"expected_sentiment": "negative",
|
| 11 |
+
"expected_confidence": 0.92,
|
| 12 |
+
"tags": ["experience_review", "strong_negative"]
|
| 13 |
+
},
|
| 14 |
+
{
|
| 15 |
+
"text": "The weather today is okay, nothing special.",
|
| 16 |
+
"expected_sentiment": "neutral",
|
| 17 |
+
"expected_confidence": 0.75,
|
| 18 |
+
"tags": ["casual_comment", "neutral_tone"]
|
| 19 |
+
},
|
| 20 |
+
{
|
| 21 |
+
"text": "I'm not sure how I feel about this new policy. It has pros and cons.",
|
| 22 |
+
"expected_sentiment": "neutral",
|
| 23 |
+
"expected_confidence": 0.65,
|
| 24 |
+
"tags": ["mixed_opinion", "uncertainty"]
|
| 25 |
+
},
|
| 26 |
+
{
|
| 27 |
+
"text": "Amazing service! The staff was incredibly helpful and friendly.",
|
| 28 |
+
"expected_sentiment": "positive",
|
| 29 |
+
"expected_confidence": 0.89,
|
| 30 |
+
"tags": ["service_review", "staff_praise"]
|
| 31 |
+
},
|
| 32 |
+
{
|
| 33 |
+
"text": "Terrible quality, broke after one day. Don't waste your money!",
|
| 34 |
+
"expected_sentiment": "negative",
|
| 35 |
+
"expected_confidence": 0.94,
|
| 36 |
+
"tags": ["quality_complaint", "warning"]
|
| 37 |
+
},
|
| 38 |
+
{
|
| 39 |
+
"text": "The presentation was informative and well-structured.",
|
| 40 |
+
"expected_sentiment": "positive",
|
| 41 |
+
"expected_confidence": 0.78,
|
| 42 |
+
"tags": ["educational_content", "professional"]
|
| 43 |
+
},
|
| 44 |
+
{
|
| 45 |
+
"text": "I have mixed feelings about the new update. Some features are great, others not so much.",
|
| 46 |
+
"expected_sentiment": "neutral",
|
| 47 |
+
"expected_confidence": 0.58,
|
| 48 |
+
"tags": ["software_review", "mixed_feedback"]
|
| 49 |
+
},
|
| 50 |
+
{
|
| 51 |
+
"text": "Outstanding performance! This tool has revolutionized our workflow.",
|
| 52 |
+
"expected_sentiment": "positive",
|
| 53 |
+
"expected_confidence": 0.96,
|
| 54 |
+
"tags": ["business_tool", "workflow_improvement"]
|
| 55 |
+
},
|
| 56 |
+
{
|
| 57 |
+
"text": "Customer support was unresponsive and unhelpful. Very frustrating experience.",
|
| 58 |
+
"expected_sentiment": "negative",
|
| 59 |
+
"expected_confidence": 0.88,
|
| 60 |
+
"tags": ["support_complaint", "frustration"]
|
| 61 |
+
}
|
| 62 |
+
]
|