Skip to main content

A schema and API for storing the results from AI/ML workflows

Project description

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.

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

hdmf_ai-0.2.0.tar.gz (212.7 kB view details)

Uploaded Source

Built Distribution

hdmf_ai-0.2.0-py3-none-any.whl (9.8 kB view details)

Uploaded Python 3

File details

Details for the file hdmf_ai-0.2.0.tar.gz.

File metadata

  • Download URL: hdmf_ai-0.2.0.tar.gz
  • Upload date:
  • Size: 212.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for hdmf_ai-0.2.0.tar.gz
Algorithm Hash digest
SHA256 aec4782d8f66a49e64c0db2e289ed419e657a10e378f37be9e4b527f4ee19e5b
MD5 86b658c6474a8791d55970c0846bb3c4
BLAKE2b-256 4b3b28b22febf3b3d66ca88ced8bc760a04b2d70144559d9cedcf306be9487cd

See more details on using hashes here.

Provenance

File details

Details for the file hdmf_ai-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: hdmf_ai-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 9.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.11.8

File hashes

Hashes for hdmf_ai-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d716e5ac8ccbc1c9fc0b4784b0012a14c5b1282b4b06a705502fa8f5ee80ecef
MD5 508a1c77210f9c8ec9a7b5f8af86b1a0
BLAKE2b-256 fcd391d9a0594f9bd6e5bd461ae452eeac011e1766e6ddeab851e8578f7938c6

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page