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.4a2.tar.gz (152.0 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.4a2-py3-none-any.whl (122.5 kB view details)

Uploaded Python 3

File details

Details for the file hedit-0.7.4a2.tar.gz.

File metadata

  • Download URL: hedit-0.7.4a2.tar.gz
  • Upload date:
  • Size: 152.0 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.4a2.tar.gz
Algorithm Hash digest
SHA256 5817d32398e51dc6568d62fcd4af5d1efc1ac2b0dd149a996ae44be66378618c
MD5 109cdd5a4cae50f19b17acd047b667dd
BLAKE2b-256 f2a31208194c0f345cf388eb21ea594c63fe5e204ab5cb930e986a636ced6f17

See more details on using hashes here.

Provenance

The following attestation bundles were made for hedit-0.7.4a2.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.4a2-py3-none-any.whl.

File metadata

  • Download URL: hedit-0.7.4a2-py3-none-any.whl
  • Upload date:
  • Size: 122.5 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.4a2-py3-none-any.whl
Algorithm Hash digest
SHA256 31738a9db744ae9e6e0b1050aea2a63209a9747c8ef5505e45850fc66646a068
MD5 a9681ae3943a0810e73a11832030b5de
BLAKE2b-256 4d5167dce35375b67acbfb5bf96ac9e5cda7b5654f01479d9560e330360538cb

See more details on using hashes here.

Provenance

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