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.6.4a0.tar.gz (115.3 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.6.4a0-py3-none-any.whl (95.8 kB view details)

Uploaded Python 3

File details

Details for the file hedit-0.6.4a0.tar.gz.

File metadata

  • Download URL: hedit-0.6.4a0.tar.gz
  • Upload date:
  • Size: 115.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hedit-0.6.4a0.tar.gz
Algorithm Hash digest
SHA256 6d717a88f7a8516af1c7fa6e089031747aed030bc7635c13ca97ffa81679ecb1
MD5 9d6810409fd37243582df38c28a5151a
BLAKE2b-256 8dc93557ccfc2bc9a7b5e1b9ecac0829d405ea9e7eb77396a3f7593a5f764599

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.6.4a0.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.6.4a0-py3-none-any.whl.

File metadata

  • Download URL: hedit-0.6.4a0-py3-none-any.whl
  • Upload date:
  • Size: 95.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for hedit-0.6.4a0-py3-none-any.whl
Algorithm Hash digest
SHA256 8fb416770ce218e5e7fd76ee635408b256bbc317c980e30075dff17fed2bc80d
MD5 0a0e1834152514f4cb1649bdac8de776
BLAKE2b-256 fe0e19c0e10924d813ef65fd36dfa760a11717a83c72da5f0a59b28a7cda15b9

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.6.4a0-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