Story (Required)

As a <PERSONA> trying to <ACTION> I want <THIS OUTCOME>

• As an AI developer, I would like to have a curated set of documentation in RHDH for models that are present in the RHOAI model catalog
• As a platform engineer, I would like for RHDH to automatically consume techdocs for models in RHOAI model catalog, if such ones exist.

Background (Required)

As part of our techdocs plan for the model catalog, we'll be focusing on manual techdoc generation for the Model Catalog for summit.

We'll be providing a curated set of techdocs for some of the models in the RHOAI model catalog, which will also aid in providing a set of reference example(s) for how to structure model/model server techdocs.

The attached screenshot from gmontero@redhat.com shows the default list of models present in the Model Catalog in RHOAI. We should determine which of these models we should have curated techdocs. We should then look at how the information needs to be conveyed in the techdocs based on the documented model catalog structure

Finally, there needs to be a mechanism for the Model Catalog Bridge to detect which of the models in the catalog have these curated techdocs, in order to associate them with the corresponding model entities in RHDH.

Out of scope

• Instructions for writing techdocs
• mechanism to pull techdocs in the Model Catalog Bridge

Approach (Required)

The Model Catalog Structure documentation highlights which metadata needs to be represented as Techdocs, and should inform us of the general techdoc structure.

We previously wrote up some example model / model server techdocs in https://github.com/redhat-ai-dev/model-catalog-example, based on the above structure, and could serve as a starting point.

Minimally, one or more GitHub repositories should be created which contains the techdocs for the models we are providing techdocs for. Once

Dependencies

-

Acceptance Criteria (Required)

• One or more GitHub repositories containing techdocs for RHOAI model catalog models
• Model Catalog Bridge can associate these techdocs with the models in the RHOAI model catalog, upon ingestion into RHDH
• Techdocs cover the documented model catalog structure

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