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.2a1.tar.gz (150.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.7.2a1-py3-none-any.whl (122.1 kB view details)

Uploaded Python 3

File details

Details for the file hedit-0.7.2a1.tar.gz.

File metadata

  • Download URL: hedit-0.7.2a1.tar.gz
  • Upload date:
  • Size: 150.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.7.2a1.tar.gz
Algorithm Hash digest
SHA256 3ef221ff3d858e8fde7331344ac26021848c31f28a5fa3c8a8dc49fd3760fff6
MD5 c94eec104a0230bce19849dfb5a0227a
BLAKE2b-256 94956454a74dc7461fcb21dc3ad13165e5601ed98b03ec8ee61fac1d04a8ea36

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.7.2a1.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.2a1-py3-none-any.whl.

File metadata

  • Download URL: hedit-0.7.2a1-py3-none-any.whl
  • Upload date:
  • Size: 122.1 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.7.2a1-py3-none-any.whl
Algorithm Hash digest
SHA256 9971d697c7fe6dd36098d24bb97a3bf51673e27767e530a51fdc3688959b4043
MD5 1508de2c9e3046a9f2a262d301d444d6
BLAKE2b-256 752df565c5c03e26b7ba45955d84501558d11852d258e2bc4f22a322fb5ddc73

See more details on using hashes here.

Provenance

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