Skip to content

Add metadata when using API to retrieve bundles #770

@RomanFenioux

Description

@RomanFenioux

Is your feature request related to a problem? Please describe.
I have developped a tool that allows user to interactively retrieve model-zoo bundles and run them on their medical scan within 3D slicer (an medical image processing and vizualisation application).
I retrieve the available model from the api : https://api.github.com/repos/Project-MONAI/model-zoo/releases/tags/hosting_storage_v1

EDIT : I am now using the hugging_face api : https://huggingface.co/api/models?author=MONAI

I would like to present more information about the available models before downloading the bundles (which are heavy). Currently I only have access to the name and versions (extracted from the asset name) using the api linked above. In particular, I would like to retrieve the bundle description to help my users understand what each bundle can do.

I believe this would benefit anyone willing to provide access to the bundles from the Model Zoo through the api.

Describe the solution you'd like
My understanding is that this api uses the model_info.json file. I think adding the bundle description to this file would solve my problem, but maybe we could consider adding other relevant metadata (authors, name, version, task, copyright, dependencies...).

Describe alternatives you've considered
I could download the metadata.json files for each model from the repo, but that would create many unnecessary request. It would be much cleaner to simply have access to this information in a single request, without downloading all those files.

Please let me now if there are other alternatives available to achieve my goal (retrieve the list of available models with their names, versions and description) that I might have failed to consider.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions