This page was generated from examples/models/metadata/metadata_schema_examples.ipynb.

Metadata Schema and Validation

import yaml

from seldon_core.metadata import validate_model_metadata

Examples Description

Simple and transparent list of valid model metadata definitions

kfserving Schema

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- datatype: BYTES
  name: input
  shape: [ 1, 4 ]
outputs:
- datatype: BYTES
  name: output
  shape: [ 3 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'datatype': 'BYTES', 'name': 'input', 'shape': [1, 4]}],
 'outputs': [{'datatype': 'BYTES', 'name': 'output', 'shape': [3]}]}

Seldon Schema

array

payload examples: - {"data": {"names": ["a", "b"], "ndarray": [[1, 2], [3, 4]]}} - {"data": {"names": ["a", "b"], "tensor": {"values": [1, 2, 3, 4], "shape": [2, 2]}}

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- messagetype: tensor
  schema:
    names: [a, b, c, d]
    shape: [ 4 ]
outputs:
- messagetype: tensor
  schema:
    shape: [ 1 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'messagetype': 'tensor',
   'schema': {'names': ['a', 'b', 'c', 'd'], 'shape': [4]}}],
 'outputs': [{'messagetype': 'tensor', 'schema': {'shape': [1]}}]}

json data

payload example: {"jsonData": {"my-custom-field": "my-custom-data"}}

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- messagetype: jsonData
outputs:
- messagetype: tensor
  schema:
    shape: [ 1 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'messagetype': 'jsonData'}],
 'outputs': [{'messagetype': 'tensor', 'schema': {'shape': [1]}}]}

json data with user’s schema

payload example: {"jsonData": {"names": ["a", "b"], "data": [1, 2]}}

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- messagetype: jsonData
  schema:
      type: object
      properties:
          names:
              type: array
              items:
                  type: string
          data:
            type: array
            items:
                type: number
                format: double
outputs:
- messagetype: tensor
  schema:
    shape: [ 1 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'messagetype': 'jsonData',
   'schema': {'type': 'object',
    'properties': {'names': {'type': 'array', 'items': {'type': 'string'}},
     'data': {'type': 'array',
      'items': {'type': 'number', 'format': 'double'}}}}}],
 'outputs': [{'messagetype': 'tensor', 'schema': {'shape': [1]}}]}

str data

payload example: {"strData": "some test input"}

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- messagetype: strData
outputs:
- messagetype: tensor
  schema:
    shape: [ 1 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'messagetype': 'strData'}],
 'outputs': [{'messagetype': 'tensor', 'schema': {'shape': [1]}}]}

custom

data = """
name: my-model-name
versions: [ my-model-version-01 ]
platform: seldon
inputs:
- messagetype: customData
  schema:
    my-names: ["a", "b", "c"]
outputs:
- messagetype: tensor
  schema:
    shape: [ 1 ]
"""

validate_model_metadata(yaml.safe_load(data))

{'name': 'my-model-name',
 'versions': ['my-model-version-01'],
 'platform': 'seldon',
 'inputs': [{'messagetype': 'customData',
   'schema': {'my-names': ['a', 'b', 'c']}}],
 'outputs': [{'messagetype': 'tensor', 'schema': {'shape': [1]}}]}