Synchronize MLflow

Synchronizing MLflow is the process of integrating metadata from MLflow and making the data available in Collibra Platform.

You can synchronize manually, or you can automate it by adding a synchronization schedule.

Before you begin

You have a resource role with the Configure external system resource permission, for example, Owner.
You have a global role with the Catalog global permission, for example, Catalog Author.
You have a global role with the View Edge connections and capabilities global permission, for example, Edge integration engineer. For example, Edge integration engineer.

On the main toolbar, click → Catalog.
The Catalog homepage opens.
On the main toolbar, click .
The Create dialog box appears.
In the Register with Edge section of the Create dialog box, click Integration Configuration.
The Integration Configuration page opens.
In the Connection name column, locate the MLflow AI connection that you used when you added the MLflow AI capability and click the link in the Capabilities column.
The Synchronization page opens.
In the Synchronization Configuration section, click Add Configuration.
In Domain, select the Domain asset in which you want to add the MLflow AI Model assets.
Optionally, in Custom AI Metrics Mappings, define which custom MLflow AI Model metrics you want to integrate. You do this by adding the mapping between the custom metric and the Collibra attribute.
Show me how...
Important
If you use this feature, make sure to add any custom attributes/characteristics, as needed, to the asset type assignment.
1. Click Add Custom AI Metrics Mappings.
2. In Metric, type the name of the custom metric manually.
  Use the exact name as in the MLflow AI Model asset.
3. In Attribute, select the attribute in which you want to see the value.
  Make sure to select an attribute that is included in the MLflow AI Model asset type assignment.
For more information, go to the MLflow documentation.
Click Save.
Click Synchronize.
A notification indicates the synchronization has started.

On the main toolbar, click → Catalog.
The Catalog homepage opens.
On the main toolbar, click .
The Create dialog box appears.
In the Register with Edge section of the Create dialog box, click Integration Configuration.
The Integration Configuration page opens.
In the Connection name column, locate the MLflow AI connection that you used when you added the MLflow AI capability and click the link in the Capabilities column.
The Synchronization page opens.
In the Synchronization Configuration section, click Add Configuration.
In Domain, select the Domain asset in which you want to add the MLflow AI Model assets.
Optionally, in Custom AI Metrics Mappings, define which custom MLflow AI Model metrics you want to integrate. You do this by adding the mapping between the custom metric and the Collibra attribute.
Show me how...
Important
If you use this feature, make sure to add any custom attributes/characteristics, as needed, to the asset type assignment.
1. Click Add Custom AI Metrics Mappings.
2. In Metric, type the name of the custom metric manually.
  Use the exact name as in the MLflow AI Model asset.
3. In Attribute, select the attribute in which you want to see the value.
  Make sure to select an attribute that is included in the MLflow AI Model asset type assignment.
For more information, go to the MLflow documentation.
Click Save.
In the Synchronization Schedule section, click Add schedule.

Enter the required information and click Save:

Field	Description
Repeat	The interval when you want to synchronize automatically. The possible values are: Daily, Weekly, Monthly, and Cron expression.
Cron	The Quartz Cron expression that determines when the synchronization takes place. This field is only visible if you select `Cron expression` in the Repeat field.
Every	The day on which you want to synchronize, for example, Sunday. This field is only visible if you select `Weekly` in the Repeat field.
Every first	The day of the month on which you want to synchronize, for example, Tuesday. This field is only visible if you select `Monthly` in the Repeat field.
At	The time at which you want to synchronize automatically, for example, 14:00. You can only schedule on the hour. For example, you can add a synchronization schedule at 8:00, but not at 8:45. This field is only visible if you select `Daily`, `Weekly`, or `Monthly` in the Repeat field.
Time zone	The time zone for the schedule.

The synchronization job synchronizes the MLflow data.
After the synchronization:

You can view a summary of the results from the Activities list.
The resulting assets get a relation to the Domain that you selected.
For information on the integrated data, go to Synchronized MLflow data.