Uploaded image for project: 'Red Hat Internal Developer Platform'
  1. Red Hat Internal Developer Platform
  2. RHIDP-10401

Map Hugging Face REST API to our Backstage Model Catalog API

    • Icon: Story Story
    • Resolution: Obsolete
    • Icon: Major Major
    • None
    • None
    • model-catalog
    • None

      Story (Required)

      As a AI platform engineer trying to provide AI model to my org's application developer  I want an uniform mapping of the metadata from HuggingFace's REST API for AI models to the proscribed API for expressing AI Model in the Backstage Catatlog.

      <Describes high level purpose and goal for this story. Answers the questions: Who is impacted, what is it and why do we need it? How does it improve the customer’s experience?>

      Background (Required)

      Under RHDP-1014 we created a Model Catalog API.  And then under stories like DEVAI-139 and DEVAI-140 we took what was available from Kubeflow Model Registry REST API and ultimately  created Backstage catalog-info.yaml files (with the 'bac' CLI for example) that conformed to the Model Catalog API defined under RHDH-1014.

       

      We want to start a similar exercise with HuggingFace in place of Kubeflow as the "Model Registry".

      Out of scope

       

      Approach (Required)

      Taking what is documented at https://huggingface.co/docs/hub/en/api for the HuggingFace REST API, via curl or an equivalent http client , start examining how to fetch model metadata (the IBM granite models would be a good example to start with) and document how it maps to the model catalog API defined at 

       

      https://docs.google.com/document/d/1ArB8w-TawZ_DuMbZoukk4inVsAgqHntB8yN2lttwjyo/edit?tab=t.0#heading=h.vb3kc1uzrgdu  

      Dependencies

       

      Acceptance Criteria (Required)

      • A google document under https://drive.google.com/drive/folders/1ETbQCGc0LJFsH0zBqs2V2c_gfSfq5ziY that details the mapping, with green/orange/red to indicate what is obviously available from the Hugging Face REST API (green), what is maybe available, but you need to squint at it (orange), and what if anything does not appear available (red)
      • stretch goal: product a catalog-info.yaml file built from data pulled for one of the IBM granite 3.x models from the HuggingFace REST API that is (manually if need be, tooling if possible ) that can be imported into RHDH
        • Unit Tests if not produced manually

       

       

       

      documentation updates (design docs, release notes etc)
      demo needed
      SOP required
      education module update (Filled by RHDHPAI team only)
      R&D label required (Filled by RHDHPAI team only)

      Done Checklist

      Code is completed, reviewed, documented and checked in
      Unit and integration test automation have been delivered and running cleanly in continuous integration/staging/canary environment
      Continuous Delivery pipeline(s) is able to proceed with new code included
      Customer facing documentation, API docs, design docs etc. are produced/updated, reviewed and published
      Acceptance criteria are met
      If the Grafana dashboard is updated, ensure the corresponding SOP is updated as well

              Unassigned Unassigned
              gmontero@redhat.com Gabe Montero
              RHIDP - AI
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: