Attaching files to a factsheet using the Python client

Add file attachments to a factsheet to provide supplemental detail. For example, attach model visualizations or a requirements document to support the use case.

You can attach images or files that support your use case to a factsheet by using the AIGovFacts python client utility.

Service The required service is not available by default. An administrator must install the AI Factsheets service and dependent services on the Cloud Pak for Data platform. To determine whether the service is installed, open the Services catalog, and check whether the service is enabled.

If you want to define attachment definitions and attachment groups so that users can attach files to a factsheet by using the model inventory, see Administering AI Factsheets.

The code for attaching a file or image looks as follows:

model=facts_client.assets.get_model(model_id='94566964-de43-4cdf-8af4-10ad12e268db')
model.set_attachment_fact(file_to_upload="./artifacts/roc_curve.jpeg",description="Roc curve for the model",fact_id="roc_curve_001",html_rendering_hint="inline_image")

Once attached, the images display as follows:

When the facts are added to a model, you can view them in the model details page in the Other Attachments section. From that section, you can preview, download and delete the file attachment or image facts.