Stay organized with collections
Save and categorize content based on your preferences.
Vertex ML Metadata organizes resources hierarchically, where every
resource belongs to a MetadataStore. You must first have a MetadataStore before
you can create Metadata resources.
Vertex ML Metadata terminology
The following introduces the data model and
terminology that is used to describe Vertex ML Metadata resources and
components.
MetadataStore
A MetadataStore is the top-level container for metadata resources. MetadataStore is regionalized and associated with a specific Google Cloud project. Typically, an organization uses one shared MetadataStore for metadata resources within each project.
metadata resources
Vertex ML Metadata exposes a graph-like data model for representing metadata produced and consumed from ML workflows. The primary concepts are artifacts, executions, events, and contexts.
artifact
An artifact is a discrete entity or piece of data produced and consumed by a machine learning workflow. Examples of artifacts include datasets, models, input files, and training logs.
context
A context is used to group artifacts and executions together under a single, queryable, and typed category. Contexts can be used to represent sets of metadata. An example of a Context would be a run of a machine learning pipeline.
For example, you can use contexts to represent sets of metadata such as:
A Vertex AI Pipelines pipeline run. In this case, the context represents one run and each execution represents a step in the ML pipeline.
An experiment run from a notebook. In this case, the context could represent the notebook and each execution could represent a cell in that notebook.
event
An event describes the relationship between artifacts and executions. Each artifact can be produced by an execution and consumed by other executions. Events help you to determine the provenance of artifacts in their ML workflows by chaining together artifacts and executions.
execution
An execution is a record of an individual machine learning workflow step, typically annotated with its runtime parameters. Examples of executions include data ingestion, data validation, model training, model evaluation, and model deployment.
MetadataSchema
A MetadataSchema describes the schema for particular types of artifacts, executions, or contexts. MetadataSchemas are used to validate the key-value pairs during creation of the corresponding Metadata resources. Schema validation is only performed on matching fields between the resource and the MetadataSchema. Type schemas are represented using OpenAPI Schema Objects, which should be described using YAML.
MetadataSchema example
Type schemas are represented using OpenAPI Schema Objects,
which should be described using YAML.
The following is an example of how the predefined Model system type is
specified in YAML format.
title:system.Modeltype:objectproperties:framework:type:stringdescription:"The framework type, for example 'TensorFlow' or 'Scikit-Learn'."framework_version:type:stringdescription:"The framework version, for example '1.15' or '2.1'"payload_format:type:stringdescription:"The format of the Model payload, for example 'SavedModel' or 'TFLite'"
The title of the schema must use the format <namespace>.<type name>.
Vertex ML Metadata publishes and maintains system-defined schemas for
representing common types widely used in ML workflows. These schemas live under
the namespace system, and can be accessed as MetadataSchema resources in the
API. Schemas are always versioned.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-29 UTC."],[],[],null,["# Data model and resources\n\nVertex ML Metadata organizes resources hierarchically, where every\nresource belongs to a MetadataStore. You must first have a MetadataStore before\nyou can create Metadata resources.\n\nVertex ML Metadata terminology\n------------------------------\n\nThe following introduces the data model and\nterminology that is used to describe Vertex ML Metadata resources and\ncomponents.\n\n\n##### **MetadataStore**\n\n- A MetadataStore is the top-level container for metadata resources. MetadataStore is regionalized and associated with a specific Google Cloud project. Typically, an organization uses one shared MetadataStore for metadata resources within each project.\n\n##### **metadata resources**\n\n- Vertex ML Metadata exposes a graph-like data model for representing metadata produced and consumed from ML workflows. The primary concepts are artifacts, executions, events, and contexts.\n\n##### **artifact**\n\n- An artifact is a discrete entity or piece of data produced and consumed by a machine learning workflow. Examples of artifacts include datasets, models, input files, and training logs.\n\n##### **context**\n\n- A context is used to group artifacts and executions together under a single, queryable, and typed category. Contexts can be used to represent sets of metadata. An example of a Context would be a run of a machine learning pipeline.\n\nFor example, you can use contexts to represent sets of metadata such as:\n\n\u003cbr /\u003e\n\n- A Vertex AI Pipelines pipeline run. In this case, the context represents one run and each execution represents a step in the ML pipeline.\n\n- An experiment run from a notebook. In this case, the context could represent the notebook and each execution could represent a cell in that notebook.\n\n\n ##### **event**\n\n - An event describes the relationship between artifacts and executions. Each artifact can be produced by an execution and consumed by other executions. Events help you to determine the provenance of artifacts in their ML workflows by chaining together artifacts and executions.\n\n ##### **execution**\n\n - An execution is a record of an individual machine learning workflow step, typically annotated with its runtime parameters. Examples of executions include data ingestion, data validation, model training, model evaluation, and model deployment.\n\n ##### **MetadataSchema**\n\n - A MetadataSchema describes the schema for particular types of artifacts, executions, or contexts. MetadataSchemas are used to validate the key-value pairs during creation of the corresponding Metadata resources. Schema validation is only performed on matching fields between the resource and the MetadataSchema. Type schemas are represented using OpenAPI Schema Objects, which should be described using YAML.\n\n \u003cbr /\u003e\n\n#### MetadataSchema example\n\nType schemas are represented using [OpenAPI Schema Objects](https://swagger.io/specification/#schema-object),\nwhich should be described using YAML.\n\nThe following is an example of how the predefined `Model` system type is\nspecified in YAML format. \n\n title: system.Model\n type: object\n properties:\n framework:\n type: string\n description: \"The framework type, for example 'TensorFlow' or 'Scikit-Learn'.\"\n framework_version:\n type: string\n description: \"The framework version, for example '1.15' or '2.1'\"\n payload_format:\n type: string\n description: \"The format of the Model payload, for example 'SavedModel' or 'TFLite'\"\n\n| **Note:** Resources don't need to include all the fields defined in the corresponding MetadataSchema. They can also include additional fields that aren't defined in the MetadataSchema.\n\nThe title of the schema must use the format `\u003cnamespace\u003e.\u003ctype name\u003e`.\nVertex ML Metadata publishes and maintains system-defined schemas for\nrepresenting common types widely used in ML workflows. These schemas live under\nthe namespace `system`, and can be accessed as MetadataSchema resources in the\nAPI. Schemas are always versioned.\n\nTo learn more about schemas, see [System schemas](/vertex-ai/docs/ml-metadata/system-schemas).\nAdditionally, Vertex ML Metadata lets you create user-defined Custom Schemas.\nTo learn more about System Schemas, see\n[How to register your own custom schemas](/vertex-ai/docs/ml-metadata/custom-schemas#how_to_register_your_own_custom_schemas).\n\nThe Metadata resources exposed closely mirror those of the open source\nimplementation of [ML Metadata (MLMD)](https://github.com/google/ml-metadata).\n\nWhat's next\n-----------\n\n- [Learn more about predefined system schemas](/vertex-ai/docs/ml-metadata/system-schemas).\n- [Start tracking with Vertex ML Metadata](/vertex-ai/docs/ml-metadata/tracking)."]]
