caikit.interfaces.runtime.data_model.info

This file contains interfaces to handle information requests

Attributes

log

RUNTIME_PACKAGE

Classes

RuntimeInfoRequest

Empty request for runtime server information

RuntimeInfoResponse

A DataObject is a data model class that is backed by a @dataclass.

ModelInfoRequest

Empty request for runtime server information

ModelInfo

Information regarding a specific Model instance

ModelInfoResponse

Model Info response contains a list of ModelInfos

Module Contents

caikit.interfaces.runtime.data_model.info.log[source]
caikit.interfaces.runtime.data_model.info.RUNTIME_PACKAGE = 'caikit_data_model.common.runtime'
class caikit.interfaces.runtime.data_model.info.RuntimeInfoRequest[source]

Bases: caikit.core.data_model.DataObjectBase

Empty request for runtime server information

class caikit.interfaces.runtime.data_model.info.RuntimeInfoResponse[source]

Bases: caikit.core.data_model.DataObjectBase

A DataObject is a data model class that is backed by a @dataclass.

Data model classes that use the @dataobject decorator must derive from this base class.

runtime_version: py_to_proto.dataclass_to_proto.Annotated[str | None, FieldNumber(1)]
python_packages: py_to_proto.dataclass_to_proto.Annotated[Dict[str, str], FieldNumber(2)]
class caikit.interfaces.runtime.data_model.info.ModelInfoRequest[source]

Bases: caikit.core.data_model.DataObjectBase

Empty request for runtime server information

model_ids: py_to_proto.dataclass_to_proto.Annotated[List[str] | None, FieldNumber(1)]
class caikit.interfaces.runtime.data_model.info.ModelInfo[source]

Bases: caikit.core.data_model.DataObjectBase

Information regarding a specific Model instance

model_path: py_to_proto.dataclass_to_proto.Annotated[str | None, FieldNumber(1)]
name: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)]
size: py_to_proto.dataclass_to_proto.Annotated[int | None, FieldNumber(3)]
metadata: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.json_dict.JsonDict | None, FieldNumber(4)]
loaded: py_to_proto.dataclass_to_proto.Annotated[bool, FieldNumber(7)]
module_id: py_to_proto.dataclass_to_proto.Annotated[str | None, FieldNumber(5)]
module_metadata: py_to_proto.dataclass_to_proto.Annotated[Dict[str, str] | None, FieldNumber(6)]
class caikit.interfaces.runtime.data_model.info.ModelInfoResponse[source]

Bases: caikit.core.data_model.DataObjectBase

Model Info response contains a list of ModelInfos

models: py_to_proto.dataclass_to_proto.Annotated[List[ModelInfo], FieldNumber(1)]