Convert natural language event descriptions into valid HED (Hierarchical Event Descriptors) annotations.
Part of the Annotation Garden Initiative.
# Default (lightweight API client, ~100MB)
pip install hedit
# Standalone mode (run locally without backend, ~2GB)
pip install hedit[standalone]# Configure your OpenRouter API key (https://openrouter.ai)
hedit init --api-key sk-or-v1-xxx
# Generate HED annotation from text
hedit annotate "participant pressed the left button"
# Generate HED from an image
hedit annotate-image stimulus.png
# Validate a HED string
hedit validate "Sensory-event, Visual-presentation"| Command | Description |
|---|---|
hedit init |
Configure API key and preferences |
hedit annotate "text" |
Convert natural language to HED |
hedit annotate-image <file> |
Generate HED from image |
hedit validate "HED-string" |
Validate HED annotation |
hedit health |
Check service status |
hedit config show |
Display configuration |
hedit annotate "text" -o json # JSON output for scripting
hedit annotate "text" --schema 8.3.0 # Specific HED schema version
hedit annotate "text" --standalone # Run locally (requires hedit[standalone])HEDit uses a multi-agent system (LangGraph) with feedback loops:
- Annotation Agent - Generates initial HED tags
- Validation Agent - Checks syntax and tag validity
- Evaluation Agent - Assesses faithfulness to input
- Assessment Agent - Identifies missing elements
Annotations are automatically refined until validation passes.
- Documentation
- GitHub Repository
- HED Standard
- OpenRouter - Get an API key
MIT