yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-04 13:26:30 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.10.x-SNAPSHOT/main-concepts/metadata-standard/schemas/api/data/createMlModel.md
Aniket Katkar f224d4295e
Update docs for 1.9.0 (#22895)
2025-08-12 13:29:42 +05:30

2.7 KiB
Raw Blame History

title slug
createMlModel /main-concepts/metadata-standard/schemas/api/data/createmlmodel

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.