From a2364dce75e4747e49cbb0a9ab44e3ce37f12e8c Mon Sep 17 00:00:00 2001 From: rly Date: Wed, 10 Apr 2024 03:07:32 -0700 Subject: [PATCH] Make code/model fields 1-dimensional --- example.py | 2 +- src/hdmf_ai/schema/results_table.yaml | 26 +++++++++++++++++++++++--- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/example.py b/example.py index 427d5fc..a041d42 100644 --- a/example.py +++ b/example.py @@ -81,7 +81,7 @@ # store metadata about the model # NOTE: not the actual model, just a placeholder for demonstration purposes -results_table.pre_trained_model = "Bloom v1.3" +results_table.pre_trained_model = ["Bloom v1.3"] # annotate the model with a DOI using HDMF HERD herd = HERD() herd.add_ref( diff --git a/src/hdmf_ai/schema/results_table.yaml b/src/hdmf_ai/schema/results_table.yaml index de979bb..020dab6 100644 --- a/src/hdmf_ai/schema/results_table.yaml +++ b/src/hdmf_ai/schema/results_table.yaml @@ -86,22 +86,42 @@ groups: attributes: - name: source_code dtype: text - doc: A link to the code used to generate the results, e.g., on GitHub. + doc: A link to the code used to generate the results, e.g., on GitHub. If multiple, links should be in order + of execution. + shape: + - null + dims: + - num_steps required: false - name: parameters dtype: text - doc: A JSON repreesentation of the parameters used to generate the results. + doc: A JSON representation of the parameters used to generate the results. If multiple scripts/models were run, + each element of the list should correspond to the elements in `source_code`. + shape: + - null + dims: + - num_steps required: false - name: model_description dtype: text doc: A description of the model used to generate the results. The string output of a PyTorch model can be stored here. Individual elements of the text string can be annotated with AI ontologies using the HDMF HERD feature. + If multiple, descriptions should be in order of execution. + shape: + - null + dims: + - num_steps required: false - name: pre_trained_model dtype: text doc: A description of the model used to generate the results. It is recommended a link to a model shared on a public model repository, e.g., HuggingFace Model Hub. It is also recommended to use the HDMF HERD - feature to annotate the string with a DOI or other persistent identifier. + feature to annotate the string with a DOI or other persistent identifier. If multiple, descriptions should + be in order of execution. + shape: + - null + dims: + - num_steps required: false datasets: