Skip to main content

Multi-agent system for HED annotation generation and validation

Project description

HEDit

PyPI version Tests

Convert natural language event descriptions into valid HED (Hierarchical Event Descriptors) annotations.

Part of the Annotation Garden Initiative.

Installation

# Default (lightweight API client, ~100MB)
pip install hedit

# Standalone mode (run locally without backend, ~2GB)
pip install hedit[standalone]

Quick Start

# 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"

Commands

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

Options

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])

How It Works

HEDit uses a multi-agent system (LangGraph) with feedback loops:

  1. Annotation Agent - Generates initial HED tags
  2. Validation Agent - Checks syntax and tag validity
  3. Evaluation Agent - Assesses faithfulness to input
  4. Assessment Agent - Identifies missing elements

Annotations are automatically refined until validation passes.

Links

License

MIT

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

hedit-0.7.9.dev3.tar.gz (176.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

hedit-0.7.9.dev3-py3-none-any.whl (139.5 kB view details)

Uploaded Python 3

File details

Details for the file hedit-0.7.9.dev3.tar.gz.

File metadata

  • Download URL: hedit-0.7.9.dev3.tar.gz
  • Upload date:
  • Size: 176.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hedit-0.7.9.dev3.tar.gz
Algorithm Hash digest
SHA256 6996b9a98ceaf27a4edd05795405bc590098c3ab8394c54f52a203a73f33e5a2
MD5 d6210e3c02bc6708ddc891620ccff1a4
BLAKE2b-256 6bc3239a1444394f51555110954e0753061f5d58313eef254bd222be5d557ea4

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.7.9.dev3.tar.gz:

Publisher: publish.yml on Annotation-Garden/HEDit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file hedit-0.7.9.dev3-py3-none-any.whl.

File metadata

  • Download URL: hedit-0.7.9.dev3-py3-none-any.whl
  • Upload date:
  • Size: 139.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for hedit-0.7.9.dev3-py3-none-any.whl
Algorithm Hash digest
SHA256 5d0fe0ef4644659dbb465fbfca628b89f638245eba5f2d4759f1a323fd90a8a3
MD5 c63ca9a73a4701ab24492ea23dfd2eff
BLAKE2b-256 454603bae999faf19ee5d549508c7e54ab0ce97707aa23216f84ea13ccbca489

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.7.9.dev3-py3-none-any.whl:

Publisher: publish.yml on Annotation-Garden/HEDit

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page