> ## Documentation Index
> Fetch the complete documentation index at: https://docs.open-metadata.org/llms.txt
> Use this file to discover all available pages before exploring further.

# ML Models

> Create and manage ML models within an ML model service

# ML Models

An **ML Model** represents a machine learning model registered within an ML Model Service. It captures metadata such as algorithm, features, hyperparameters, and lineage.

<Info>
  Entity schema follows the [OpenMetadata Standard](https://openmetadatastandards.org/data-assets/ml/mlmodel/).
</Info>

## Entity Hierarchy

ML Models belong to an ML Model Service:

<CodeGroup>
  ```txt ML Model theme={null}
  MlModelService
  └── MlModel (this page)
  ```
</CodeGroup>

## Fully Qualified Name

The FQN format for an ML model is:

```
service.modelName
```

For example: `mlflow_svc.customer_segmentation`

***

## API Endpoints

| Method   | Endpoint                               | Description                                                                             |
| -------- | -------------------------------------- | --------------------------------------------------------------------------------------- |
| `PUT`    | `/v1/mlmodels`                         | [Create or update an ML model](/v1.12.x/api-reference/data-assets/mlmodels/create)      |
| `POST`   | `/v1/mlmodels`                         | [Create an ML model (POST variant)](/v1.12.x/api-reference/data-assets/mlmodels/create) |
| `GET`    | `/v1/mlmodels`                         | [List ML models](/v1.12.x/api-reference/data-assets/mlmodels/list)                      |
| `GET`    | `/v1/mlmodels/{id}`                    | [Get by ID](/v1.12.x/api-reference/data-assets/mlmodels/retrieve)                       |
| `GET`    | `/v1/mlmodels/name/{fqn}`              | [Get by FQN](/v1.12.x/api-reference/data-assets/mlmodels/retrieve)                      |
| `PATCH`  | `/v1/mlmodels/{id}`                    | [Update by ID](/v1.12.x/api-reference/data-assets/mlmodels/update)                      |
| `PATCH`  | `/v1/mlmodels/name/{fqn}`              | [Update by name](/v1.12.x/api-reference/data-assets/mlmodels/update)                    |
| `DELETE` | `/v1/mlmodels/{id}`                    | [Delete by ID](/v1.12.x/api-reference/data-assets/mlmodels/delete)                      |
| `DELETE` | `/v1/mlmodels/name/{fqn}`              | [Delete by name](/v1.12.x/api-reference/data-assets/mlmodels/delete)                    |
| `PUT`    | `/v1/mlmodels/restore`                 | [Restore soft-deleted ML model](/v1.12.x/api-reference/data-assets/mlmodels/delete)     |
| `GET`    | `/v1/mlmodels/{id}/versions`           | [List versions](/v1.12.x/api-reference/data-assets/mlmodels/versions)                   |
| `GET`    | `/v1/mlmodels/{id}/versions/{version}` | [Get specific version](/v1.12.x/api-reference/data-assets/mlmodels/versions)            |
| `PUT`    | `/v1/mlmodels/{id}/followers`          | [Add follower](/v1.12.x/api-reference/data-assets/mlmodels/followers-votes)             |
| `DELETE` | `/v1/mlmodels/{id}/followers/{userId}` | [Remove follower](/v1.12.x/api-reference/data-assets/mlmodels/followers-votes)          |
| `PUT`    | `/v1/mlmodels/{id}/vote`               | [Add/update vote](/v1.12.x/api-reference/data-assets/mlmodels/followers-votes)          |