We use cookies to improve site navigation, analyze site usage, and enhance your user experience. Click "Accept" to enable cookies or "Reject" to reject cookies.

main-concepts

No menu items for this category
Home/Main Concepts/Metadata Standard/Schemas/Api/Data/Createmlmodel
OpenMetadata Documentation

CreateMlModelRequest

Create Ml Model entity request

Properties

  • name: Name that identifies this ML model. Refer to ../../type/basic.json#/definitions/entityName.
  • displayName (string): Display Name that identifies this ML model. It could be title or label from the source services.
  • description: Description of the ML model instance. How it was trained and for what it is used. Refer to ../../type/basic.json#/definitions/markdown.
  • algorithm (string): Algorithm used to train the ML Model. Default: mlmodel.
  • mlFeatures (array): Features used to train the ML Model. Default: None.
    • Items: Refer to ../../entity/data/mlmodel.json#/definitions/mlFeature.
  • target: For supervised ML Models, the value to estimate. Refer to ../../type/basic.json#/definitions/entityName.
  • mlHyperParameters (array): Hyper Parameters used to train the ML Model. Default: None.
    • Items: Refer to ../../entity/data/mlmodel.json#/definitions/mlHyperParameter.
  • dashboard: Performance Dashboard fqn to track metric evolution. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • mlStore: Location containing the ML Model. It can be a storage layer and/or a container repository. Refer to ../../entity/data/mlmodel.json#/definitions/mlStore.
  • server: Endpoint that makes the ML Model available, e.g,. a REST API serving the data or computing predictions. Refer to ../../type/basic.json#/definitions/href.
  • tags (array): Tags for this ML Model. Default: None.
    • Items: Refer to ../../type/tagLabel.json.
  • owners: Owners of this database. Refer to ../../type/entityReferenceList.json. Default: None.
  • service: Link to the MLModel service fqn where this pipeline is hosted in. Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • extension: Entity extension data with custom attributes added to the entity. Refer to ../../type/basic.json#/definitions/entityExtension.
  • sourceUrl: Source URL of mlModel. Refer to ../../type/basic.json#/definitions/sourceUrl.
  • domains (array): Fully qualified names of the domains the MLModel belongs to.
    • Items (string)
  • dataProducts (array): List of fully qualified names of data products this entity is part of.
    • Items: Refer to ../../type/basic.json#/definitions/fullyQualifiedEntityName.
  • lifeCycle: Life Cycle of the entity. Refer to ../../type/lifeCycle.json.
  • sourceHash (string): Source hash of the entity.

Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.