Skip to main content

HDMF-AI - an HDMF schema and API for AI/ML workflows

HDMF-AI is a schema and Python API for storing the common results of AI algorithms in a standardized way within the Hierarchical Data Modeling Framework (HDMF).

HDMF-AI is designed to be flexible and extensible, allowing users to store a range of AI and machine learning results and metadata, such as from classification, regression, and clustering. These results are stored in the ResultsTable data type, which extends the DynamicTable data type within the base HDMF schema. The ResultsTable schema represents each data sample as a row and includes columns for storing model outputs and information about the AI/ML workflow, such as which data were used for training, validation, and testing.

By leveraging existing HDMF tools and standards, HDMF-AI provides a scalable and extensible framework for storing AI results in an accessible, standardized way that is compatible with other HDMF-based data formats, such as Neurodata Without Borders (NWB), a popular data standard for neurophysiology, and HDMF-Seq, a format for storing taxonomic and genomic sequence data. By enabling standardized co-storage of data and AI results, HDMF-AI may enhance the reproducibility and explainability of AI for science.

UML diagram of the HDMF-AI schema. Data types with orange headers are introduced by HDMF-AI. Data types with blue headers are defined in HDMF. Fields colored in gray are optional.

Installation

pip install hdmf-ai

Usage

For example usage, see example_usage.ipynb.

Metadata

Release files for hdmf-ai 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for hdmf-ai 0.2.0
File Size Uploaded
hdmf_ai-0.2.0.tar.gz 212.7 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for hdmf-ai 0.2.0
File Interpreter ABI Platform
hdmf_ai-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 222.5 kB

Release files / hdmf_ai-0.2.0.tar.gz

Download URL hdmf_ai-0.2.0.tar.gz
Size 212.7 kB
Tags Source
SHA-256 checksum
How to use checksums
aec4782d8f66a49e64c0db2e289ed419e657a10e378f37be9e4b527f4ee19e5b
BLAKE2b-256 checksum
How to use checksums
4b3b28b22febf3b3d66ca88ced8bc760a04b2d70144559d9cedcf306be9487cd
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.8

Release files / hdmf_ai-0.2.0-py3-none-any.whl

Download URL hdmf_ai-0.2.0-py3-none-any.whl
Size 9.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d716e5ac8ccbc1c9fc0b4784b0012a14c5b1282b4b06a705502fa8f5ee80ecef
BLAKE2b-256 checksum
How to use checksums
fcd391d9a0594f9bd6e5bd461ae452eeac011e1766e6ddeab851e8578f7938c6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.0.0 CPython/3.11.8

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page