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

Uploaded Python 3

File details

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

File metadata

  • Download URL: hedit-0.6.7a2.tar.gz
  • Upload date:
  • Size: 131.7 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.7a2.tar.gz
Algorithm Hash digest
SHA256 51689faf39754195bdbfed0bf0e1f0589a371ec6f02949b2b07555d6fcfab7f5
MD5 66070cdf882430bd8ed5bc4d7dfa441a
BLAKE2b-256 0e43ff0431672ce35b0437ee8cd0f14f9e33a4b687a37cf63982683733f15670

See more details on using hashes here.

Provenance

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

File metadata

  • Download URL: hedit-0.6.7a2-py3-none-any.whl
  • Upload date:
  • Size: 109.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.6.7a2-py3-none-any.whl
Algorithm Hash digest
SHA256 f940d9c08e68f239cb7ed1e5e9a7e2ea1d8efda5f6d9a379adbdf093c67a9099
MD5 6e62440697ecae0096f142291317acdd
BLAKE2b-256 010b5f88198440620956e4dc457236dd30b0f9e90fc47ef7e9fa6f9c21976e4b

See more details on using hashes here.

Provenance

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