> ## Documentation Index
> Fetch the complete documentation index at: https://openmetadata-format-2-0-connector-overview-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# MLflow Connector | OpenMetadata ML Model Integration

> Connect MLflow to OpenMetadata seamlessly with our comprehensive connector guide. Learn setup, configuration, and ML model metadata integration in minutes.

export const ConnectorDetailsHeader = ({name, icon, stage, availableFeatures, unavailableFeatures = [], availableFeaturesCollate = []}) => {
  const showSubHeading = availableFeatures?.length > 0 || unavailableFeatures?.length > 0 || availableFeaturesCollate?.length > 0;
  const totalAvailableFeatures = [...availableFeatures || [], ...availableFeaturesCollate || []];
  return <div className="container">
      <div className="Heading">
        <div className="flex items-center gap-3">
          {icon && <div className="IconContainer">
              <img src={icon} alt={name} noZoom className="ConnectorIcon" />
            </div>}
          <h1 className="ConnectorName">{name}</h1>
          <span className={`StageBadge ${stage === 'PROD' ? 'prod' : 'beta'}`}>
            {stage}
          </span>
        </div>
      </div>
      {showSubHeading && <div className="SubHeading">
          <div className="FeaturesHeading">Feature List</div>
          <div className="FeaturesList">
            {totalAvailableFeatures.map(feature => <div className="FeatureTag AvailableFeature" key={feature}>
                ✓ {feature}
              </div>)}
            {unavailableFeatures.map(feature => <div className="FeatureTag UnavailableFeature" key={feature}>
                ✕ {feature}
              </div>)}
          </div>
        </div>}
    </div>;
};

<ConnectorDetailsHeader icon="/public/images/connectors/mlflow.webp" name="MLflow" stage="PROD" availableFeatures={["ML Features", "Hyperparameters", "ML Store"]} unavailableFeatures={[]} />

In this section, we provide guides and references to use the MLflow connector.
Configure and schedule MLflow metadata and profiler workflows from the OpenMetadata UI:

* [Requirements](#requirements)
* [Metadata Ingestion](#metadata-ingestion)
* [Troubleshooting](/v2.0.x-SNAPSHOT/connectors/ml-model/mlflow/troubleshooting)

## Requirements

To extract metadata, OpenMetadata needs two elements:

* **Tracking URI**: Address of local or remote tracking server. More information on the MLflow documentation [here](https://www.mlflow.org/docs/latest/tracking.html#where-runs-are-recorded)
* **Registry URI**: Address of local or remote model registry server.

## Metadata Ingestion

To ingest metadata from MLflow, you need to create a service connection. The service connects MLflow with OpenMetadata. Once you create a service, OpenMetadata automatically starts ingesting metadata.

### Step 1: Add New Service

1. Navigate to **Settings** > **Services**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-services.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=1d8b1bddab7b8b43c20d4384be39e12a" alt="Navigate to Settings and Services" width="3004" height="1578" data-path="public/images/connector2.0/metadata-ingestion/access-services.png" />

2. Click **Add New Service**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-new-service.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=792f4403f83940c398633345505482a0" alt="Add New Service" width="3002" height="1514" data-path="public/images/connector2.0/metadata-ingestion/add-new-service.png" />

### Step 2: Select a Service and Connector

From the service type dropdown, select **ML Model Services**, then click the **MLflow** connector tile.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/select-service/mlflow.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=af13af5434006fa7b4b021794b2822f2" alt="Select Service" width="2362" height="868" data-path="public/images/connector2.0/metadata-ingestion/MLModel/select-service/mlflow.png" />

### Step 3: Add Service Name and Description

* Enter a unique, descriptive **Service Name**. OpenMetadata identifies services by their service name. Enter a name that distinguishes this deployment from other MLflow services you are ingesting metadata from.
* Optional: Enter a **Description** for the service.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/service-name/mlflow.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=695cd2b1d96f041513e2cf5974080132" alt="Add New Service Name" width="1460" height="806" data-path="public/images/connector2.0/metadata-ingestion/MLModel/service-name/mlflow.png" />

<Note>
  **Note**: The service name cannot be changed after it is set.
</Note>

### Step 4: Configure Connection Options

Specify your source credentials and verify the connection.

#### Enter Connection Details

Enter the connection details for MLflow. The right-hand panel in the UI displays inline help for each field.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/connection-details/mlflow.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=60efb0d828a970c87ba5df13d5b57601" alt="Configure Service Connection" width="1464" height="458" data-path="public/images/connector2.0/metadata-ingestion/MLModel/connection-details/mlflow.png" />

* **Tracking URI**: MLflow experiment tracking URI, for example `http://localhost:5000`.
* **Registry URI**: MLflow model registry backend, for example `mysql+pymysql://mlflow:password@localhost:3307/experiments`.

#### Test Connection

Once the credentials have been added, click on **Test Connection** and **Save** the changes.

<img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/2XRXwl2QkxBakIS8/public/images/connectors/test-connection.png?fit=max&auto=format&n=2XRXwl2QkxBakIS8&q=85&s=abe3b568c662295afc530c6c6819f9a5" alt="Test Connection" width="1494" height="310" data-path="public/images/connectors/test-connection.png" />

### Step 5: Configure Ingestion Options

In the **What to Ingest** step, use filter patterns to control which assets OpenMetadata ingests from your ML model service. Filter patterns use regular expressions applied to model names.

#### How Filter Patterns Work

* **Include**: Add one or more comma-separated regular expressions. OpenMetadata ingests only assets whose names match at least one expression. Leave blank to include all assets.
* **Exclude**: Add one or more comma-separated regular expressions. OpenMetadata skips any asset whose name matches an expression. Leave blank to exclude nothing.

Rules match asset names using one of five expressions:

* **contains**: matches any name containing the value. For example, `sales` matches `my_sales_data` and `sales_2024`.
* **starts with**: matches names beginning with the value. For example, `prod_` matches `prod_db` and `prod_schema`.
* **ends with**: matches names ending with the value. For example, `_raw` matches `events_raw` and `logs_raw`.
* **is exactly**: matches the exact name only. For example, `analytics` matches only `analytics`.
* **matches regex**: matches names using a regular expression. For example, `^prod_.*_v\d+$` matches `prod_events_v1`.

When both Include and Exclude are set, Exclude takes priority.

<Tip>
  Leave the filter pattern empty to ingest all ML models available in the source.
</Tip>

**Filter Options**

The ML Model section includes the following filter options:

* **ML Model**: Controls which ML models OpenMetadata ingests from the source.

Each section provides the following controls:

* **Scan Mode**: You can choose between the following scan modes:
  * **Scan all**: Ingests every asset of that type the connector can access. This is the default.
  * **Only specific**: Enables include rules so only assets matching at least one rule are ingested.
* **Exclude system toggle**: Use this toggle to automatically filter out system-reserved names defined by the connector, for example, **Exclude system databases** for the Databases section.
* **Always exclude**: Add permanent exclusion rules (shown in red). Assets matching these rules are never ingested, regardless of include rules.
* **Preview**: Shows a real-time summary of what will be in scope based on your current rules.
* **Include rules** *(available only in **Only specific** mode)*: Click **+ Add** to define a rule. Added rules appear as chips; an asset is included if it matches any rule.

### Step 6: Create & Deploy

Click **Create & Deploy** to deploy the agent and start the first metadata ingestion run. OpenMetadata saves the service configuration and immediately begins pulling metadata from the source.

To monitor ingestion progress or view the service you just added, go to **Settings** > **Services** and select your service.

## Configure Metadata Agent and Schedule Ingestion

The **Metadata Agent** extracts ML models, features, and other structural metadata from your source and keeps your OpenMetadata catalog in sync. It powers discovery, lineage, and governance across your data assets.

When you click **Create & Deploy**, OpenMetadata automatically deploys a Metadata Agent for this service and triggers the first ingestion run. View its status and run history from the **Agents** tab on the service detail page.

To configure the additional Metadata Agent and schedule ingestion, follow these steps:

1. Navigate to **Settings** > **Services** and select the service type.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/access-service-type.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=3c2d6613c061c17412ec5c800c0f3833" alt="Navigate to Settings and Services" width="2992" height="1612" data-path="public/images/connector2.0/metadata-ingestion/access-service-type.png" />

2. Click the service you have added.

3. Select the **Agents** tab and click **Add Agent** > **Metadata**.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/add-metadata-agent.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=9a59a29bca844f3035d14a7211574c57" alt="Add Metadata Agent" width="2398" height="1144" data-path="public/images/connector2.0/metadata-ingestion/add-metadata-agent.png" />

   For some services, the dropdown is not available and clicking **Add Agent** takes you directly to the agent configuration page.

4. On the **Configure Ingestion** page, do the following and click **Next**.

   * **Name this Ingestion**: Enter a unique recognizable name for this ingestion pipeline.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/aexFmzYHE_P6Lrks/public/images/connector2.0/metadata-ingestion/metadata-agent-name.png?fit=max&auto=format&n=aexFmzYHE_P6Lrks&q=85&s=fa31ef8cb17d501983dd958c19e0c414" alt="Name this Ingestion" width="1578" height="644" data-path="public/images/connector2.0/metadata-ingestion/metadata-agent-name.png" />

   * **Agent Setup**: Configure the core parameters for this agent. The following fields are available:

     | Field                  | Default | Description                                                                                                                                                                                                                |
     | ---------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Db Service Prefixes    | —       | List of database service name prefixes used to resolve lineage between ML models and database assets. Accepted formats: `DBService`, `DBService.Database`, `DBService.Database.Schema`, `DBService.Database.Schema.Table`. |
     | Mark Deleted ML Models | On      | Soft-delete ML models in OpenMetadata when they are removed from the source. Associated entities like lineage are also deleted.                                                                                            |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-agent-setup.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=e668568dc979aedccc5172fc010514c5" alt="Agent Setup" width="1560" height="560" data-path="public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-agent-setup.png" />

   * **Filter Patterns**: Apply include or exclude rules to scope which ML models this agent ingests. These follow the same filter options described in **Step 5: Configure Ingestion Options**.

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-filter-pattern.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=0d2ade4c0c7b276b0d2188f99c6cb9a0" alt="Filter Patterns" width="1552" height="378" data-path="public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-filter-pattern.png" />

   * **Scope & Behaviour**: Control what metadata to include and how to handle deletions. Toggle each option on or off based on your needs:

     | Toggle            | Default | Description                                                                                                                                                                      |
     | ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
     | Enable Debug Log  | Off     | Sets the ingestion log level to DEBUG. Useful for troubleshooting.                                                                                                               |
     | Override Metadata | Off     | When on, source values overwrite existing descriptions, tags, owners, and display names in OpenMetadata. When off, OpenMetadata only updates fields that have no existing value. |
     | Override Lineage  | Off     | When on, existing lineage is replaced with newly extracted lineage on each run.                                                                                                  |

     <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/gRbSGI6PilrVY_cm/public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-scope-behaviour.png?fit=max&auto=format&n=gRbSGI6PilrVY_cm&q=85&s=2e66c724728e96c4bdf95e8945277ca3" alt="Scope & Behaviour" width="1560" height="696" data-path="public/images/connector2.0/metadata-ingestion/MLModel/mlmodel-scope-behaviour.png" />

5. On the **Schedule Interval** page, set when the agent runs:

   * **Schedule**: Choose a preset interval (Hourly, Daily, Weekly, Monthly) or enter a custom cron expression.
   * **On-Demand**: No automatic schedule; trigger the agent manually when needed.

   <img src="https://mintcdn.com/openmetadata-format-2-0-connector-overview-pages/wI1VkO40X1vdRc0T/public/images/connectors/schedule.png?fit=max&auto=format&n=wI1VkO40X1vdRc0T&q=85&s=14df1dfeef735efd1ad9fb45da8a7352" alt="Schedule Interval" width="2733" height="1083" data-path="public/images/connectors/schedule.png" />

6. Click **Add** to deploy the agent.

## Related

<Columns cols={2}>
  <Card title="Usage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/usage">
    Learn more about how to configure the Usage Workflow to ingest Query information from the UI.
  </Card>

  <Card title="Lineage Workflow" href="/v2.0.x-SNAPSHOT/connectors/ingestion/workflows/lineage">
    Learn more about how to configure the Lineage from the UI.
  </Card>

  <Card title="Profiler Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/profiler/profiler-workflow">
    Learn more about how to configure the Data Profiler from the UI.
  </Card>

  <Card title="Data Quality Workflow" href="/v2.0.x-SNAPSHOT/how-to-guides/data-quality-observability/quality/configure">
    Learn more about how to configure the Data Quality tests from the UI.
  </Card>

  <Card title="dbt Integration" href="/v2.0.x-SNAPSHOT/connectors/database/dbt">
    Learn more about how to ingest dbt models' definitions and their lineage.
  </Card>
</Columns>
