Define attachment placeholders and organize them in groups for an AI use case or factsheet.
Attachment placeholders and groups
If you have the manage_catalog role for an inventory, you can define attachment placeholders for the AI use cases or factsheets in the inventory. Use an attachment group to organize a set of related attachment facts and render them together. Attachments can provide supporting information and extra details for a use case. For example, data scientists might want to attach visualizations from their model. Model requesters might want to attach a file of requirements to describe a business need.
When you define attachment groups and placeholders, you associate them with a lifecycle phase. This allows for attachments to display with the phase they relate to. For example, if you define attachment placeholders for the Validate section, data scientists can attach visualizations of validation results in that section.
Creating a group for attachment placeholders
- Open the AI uses cases settings and click the Attachments tab. If you do not see this tab, you might have insufficient access.
- Choose whether to add an attachment placeholder group to an AI use case or to the factsheet template.
- Choose the lifecycle phase where you want the group to display.
- Click the Add group icon from the toolbar.
- Enter a name and an optional description for the group. An identifier is created from the name of the group. The identifier can be used for programmatic access to the group.
Creating an attachment placeholder to a group
- Click the group where you want to add a placeholder.
- Click the Add attachment placeholder icon from the toolbar.
- Enter a name and an optional description for the attachment placeholder. An identifier is created from the name of the attachment placeholder. The identifier can be used for programmatic access to the attachment.
- Save your changes and optionally repeat to create additional placeholders.
- Optionally use the toolbar to move, edit, or remove attachment placeholder.
In the following example, the factsheet will have a group named Model approval for attachment placeholders in the Develop phase, and a group named Validation results in the Validate phase.
Supported attachment types
The following file types are supported for file attachments:
Image file types:
- png
- jpg
- jpeg
Other file types:
- html
- csv
- docx
- zip
- text file
- Markdown
Viewing the attachment placeholders
Attachment placeholders you define display in the Attachments section of the lifecycle phase. In the following image, the attachment group Approvals displays two placeholders in the Attachments section of the Develop phase of a factsheet. Users can upload the relevant files to the attachment placeholders.
Attachments from previous releases
If you created attachments in earlier versions of AI Factsheets or watsonx.governance before support was added for associating attachment placeholders with lifecycle phases, the attachment placeholders display in the Legacy section of the administration page. You can edit or remove the legacy attachment placeholders, but you cannot add new ones. Existing attachments display at the bottom of factsheets.
Parent topic: Managing AI use cases