Getting Started¶
Welcome to Sentimatrix! This section will help you get up and running with sentiment analysis in just a few minutes.
Overview¶
Sentimatrix provides a comprehensive toolkit for:
- Sentiment Analysis - Classify text as positive, negative, or neutral
- Emotion Detection - Identify emotions like joy, anger, sadness, and more
- Review Scraping - Collect reviews from Amazon, Steam, YouTube, Reddit, and other platforms
- LLM Integration - Enhance analysis with GPT-4, Claude, Gemini, and 16 other providers
Quick Navigation¶
:material-download: Installation
Install Sentimatrix and its dependencies using pip, poetry, or uv.
:material-rocket-launch: Quick Start
Get started with basic sentiment analysis in under 5 minutes.
:material-test-tube: First Analysis
Build your first complete analysis pipeline with web scraping.
Prerequisites¶
Before installing Sentimatrix, ensure you have:
- Python 3.10+ - Sentimatrix requires Python 3.10 or later
- pip - Python package installer (comes with Python)
- Git - For cloning the repository (optional)
Optional Dependencies¶
Depending on your use case, you may need:
| Feature | Requirement |
|---|---|
| Web Scraping | Playwright browsers (playwright install) |
| LLM Providers | API keys for your chosen provider |
| Local LLMs | Ollama, LM Studio, or vLLM running locally |
| Caching | Redis server (optional, for distributed caching) |
System Requirements¶
| Component | Minimum | Recommended |
|---|---|---|
| CPU | 2 cores | 4+ cores |
| RAM | 4 GB | 8+ GB |
| Storage | 500 MB | 2+ GB |
| Python | 3.10 | 3.11+ |
GPU Support
GPU acceleration is optional but recommended for:
- Local transformer models
- Local LLMs (Ollama, vLLM)
- Batch processing large datasets
Next Steps¶
- Install Sentimatrix - Get the library installed
- Quick Start Guide - Run your first analysis
- First Analysis - Build a complete pipeline
Need help? Check our troubleshooting guide or open an issue.