Learning Paths
- Beginner (1–2 hrs): new to Semantica and knowledge graphs. Start with Installation →
- Intermediate (4–6 hrs): comfortable with basics, building real applications. Start with Modules →
- Advanced (8+ hrs): enterprise deployments, customization, and extension. Start with Architecture →
- Beginner (1–2 hrs)
- Intermediate (4–6 hrs)
- Advanced (8+ hrs)
New to Semantica and knowledge graphs. No prior graph database experience required.
1
Set up your environment
Installation Guide: virtual environments, optional extras, platform-specific fixes.
2
Understand the core ideas
Core Concepts: what knowledge graphs are, how embeddings work, what extraction does.
3
Run your first example
Getting Started: 5-minute code walkthrough with pattern-based extraction (no API key needed).
4
Build your first knowledge graph
Quickstart Tutorial: full 6-step pipeline from ingestion to visualization.
5
Explore interactively
Welcome to Semantica notebook: Jupyter walkthrough of every module.
Configuration Reference
All settings can be overridden with environment variables: no code changes needed.Troubleshooting
ModuleNotFoundError: No module named 'semantica'
ModuleNotFoundError: No module named 'semantica'
Verify installation and that the correct Python environment is active:For optional features, install the relevant extra:
AuthenticationError
AuthenticationError
Set your API key as an environment variable (never hardcode keys in source files):
MemoryError or OOM crashes
MemoryError or OOM crashes
Switch from the default in-memory NetworkX backend to a persistent graph database:Also reduce batch sizes and enable streaming ingestion for large corpora.
Slow processing on large datasets
Slow processing on large datasets
Enable parallel execution and GPU acceleration:
Windows [all] installation fails
Windows [all] installation fails
Upgrade to the latest release:Or install extras individually:
pip install semantica, then add [llm-openai], [gpu], etc. as needed.cp1252 encoding crash on Windows
cp1252 encoding crash on Windows
Set the encoding environment variable:
Performance Optimization
Backend selection: development vs. production
Backend selection: development vs. production
Use NetworkX for local development and prototyping. Switch to a persistent backend before deploying to production.
Batch processing for large corpora
Batch processing for large corpora
Process documents in batches rather than one at a time. Split large texts into chunks and extract entities in batches:
Deduplication v2: up to 7× faster
Deduplication v2: up to 7× faster
If deduplication is a bottleneck, use candidate blocking to reduce O(n²) comparisons before similarity scoring:The
blocking_v2 and hybrid_v2 candidate strategies filter candidate pairs before calculating fine-grained similarity.Security Best Practices
- API keys: store in environment variables or a secrets manager; never commit them to version control; rotate on a schedule
- Sensitive data: use local embedding models (Ollama, HuggingFace) for PII or classified content; avoid sending sensitive data to external APIs without data handling agreements
-
Graph exports: encrypt sensitive exports at rest; use SSRF-safe
base_urlvalidation when configuring custom LLM gateways -
XML ingestion: always use
XMLIngestor, which uses the XXE-safe lxml backend; never parse untrusted XML with the standard library parser - Cookbook: interactive Jupyter notebooks from beginner to advanced.
- FAQ: common questions answered.
- API Reference: complete technical documentation.
