Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up docstrings, reorganize, update example code #17

Merged
merged 4 commits into from
Apr 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,6 @@ coverage.xml

# DS_Store
.DS_Store

.zip
.nwb
18 changes: 17 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,19 @@
# HDMF-AI - an HDMF schema and API for AI/ML workflows

![Schema](paper/schema.png)
`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)](https://hdmf.readthedocs.io/en/stable/).

`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)](https://nwb-overview.readthedocs.io/), a popular data standard for neurophysiology, and [HDMF-Seq](https://github.com/exabiome/deep-taxon), 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.](paper/schema.png)

## Installation

```bash
pip install hdmf-ai
```

## Usage

For example usage, see `example_usage.ipynb`.
110 changes: 0 additions & 110 deletions example.py

This file was deleted.

Loading