Administering AI Factsheets
After you install AI Factsheets, you can administer your model inventory provided you have admin permissions for Watson™ Knowledge Catalog or Watson Studio.
About this task
You might need to have Create Catalog permissions for some tasks to set up or customize AI Factsheets for your specific business needs. As an admin, you can open the Manage tab in your catalog and do the following tasks:
Creating a Platform Asset catalog
You might be prompted to create a Platform Asset catalog for managing your model inventory. If you do not have a Platform Asset catalog, you are sent a notification to create one after you click the Manage tab. Then you must do the following steps:
- Click the link in the notification.
- Complete the details for the catalog.
- Click Create to create the catalog.
- Close the tab to return to the model inventory.
Creating a custom report template
AI Factsheets includes default report templates for presenting data from model use cases and factsheets. You can customize the report templates to suit the needs of your organization.
If the default report templates provided with AI Factsheets do not meet your needs, you can download a default report template, customize it for your needs, and upload the new template. Currently, you must use the AI Factsheets API to download the template, but you can upload it from the model inventory UI.
Download a report template- Use the
GET
endpoint for/v1/aigov/report_templates
in the IBM Watson Data API to list the available templates. Note the id for the template you want to download. - Use the
GET
endpoint/v1/aigov/report_templates/{template_id}/content
with the template id to download the template file. - Open the
<report-name>.ftl
file in an editor. - Edit the template, using instructions from Apache FreeMarker or the API commands.
- Open the model inventory and click the Manage tab.
- Click Add template.
- Specify a name for the template and an optional description.
- Choose the type of template: model or model use case. Note that the reports are available for external models as well as Watson Machine Learning models.
- Upload the updated
FTL
file. Restriction: Theftl
file that you upload must not import any other files. Support is not yet available forimport
statements in theftl
file.
The custom template displays in the Report templates section and will be available for creating reports. Click Edit or Delete from the action menu for a custom template to update the template details or to remove the template.
Adding attachments for factsheets
- Define attachment groups and manage attachment definitions from the Manage page of the model inventory.
- Attach files and manage attachments using the Python client. For details, see Adding and managing attachments for factsheets.
To create an attachment group:
- Open the model inventory, click the Manage tab and navigate to the Attachments section.
- Create a new attachment group, assigning a name and optional description.
Reviewing and updating attachments for factsheets
You can also review or update existing attachment groups.
- From an attachment group, add attachment fact definitions that will specify how a user can add an attachment to a factsheet. Attachment definitions display as available slots in the attachment section for a factsheet.
- Use the up and down arrow keys to reorder attachments in the list.
When you save your attachment fact definitions, an attachment slot and description display on the factsheet for attaching a file in the definition from the UI. A pin icon indicates an available attachment slot. Users can upload attachments.
The attachment displays as part of the use case.
If you delete a fact definition, the images that were showing in the group section would show up in Other attachments instead.
What to do next
To get started with AI Factsheets, see AI Factsheets.