Epic Goal

The AI catalog will provide a templated AI Catalog that can be used by the user to generate catalog entries for their models and model servers by capturing in a template form:

• information about the model(s) to be added to the catalog: Type, description, location of data files, license, and necessary usage information
• Information about the model server to be added to the catalog: API type, access instructions, and an API specification (if available)

The templated AI catalog should support  1 to N sources for the models/model servers. 

From those prompts, the software template should generate an AI catalog file based on the format defined previously, as well any necessary techdocs. This information should be automatically registered with RHDH, if not, instructions should be provided on how to register it. 

Why is this important?

• This will provide a way for organizations and users to generate AI catalogs based on what they have deployed

Scenarios

1. AI Catalog Template file: What needs to be collected from the user to generate an AI Catalog instance, and the corresponding templated catalog. It should support 1 to N many sources.
2. AI Catalog Generation: The user can create an AI catalog from the template configuration file (e.g. via software template)
3. Import into Backstage: The generated AI catalog should be imported into RHDH without the user needing to manually register the assets
4. Catalog RBAC: Private/public model catalog entries should be sufficiently distinguished in the UI. Users without access to the private entities should not be able to see/access them
5. Full Catalog Functions: Sync with UX on the necessary changes needed to achieve the full catalog function shown in the mockups
6. Dogfooding: Dog food the model catalog software templates to create/manage our model catalog entries
7. Test automation: DEVAI-36

Acceptance Criteria (Mandatory)

• CI - MUST be running successfully with tests automated
• Release Technical Enablement - Provide necessary release enablement details and documents.
• A templated AI catalog repo has been created, and can be used to generate valid AI catalogs in RHDH (via software template)
• Generated AI catalogs should be automatically imported into RHDH
• Already present AI catalogs can be updated/edited by the user without needing to reimport their catalog(s).

Dependencies (internal and external)

1. ...

Previous Work (Optional):

1. …

Open questions::

1. …

Done Checklist

• Acceptance criteria are met
• Non-functional properties of the Feature have been validated (such as performance, resource, UX, security or privacy aspects)
• User Journey automation is delivered
• Support and SRE teams are provided with enough skills to support the feature in production environment