caikit.interfaces.runtime.data_model

Submodules

Attributes

RuntimeServerContextType

Classes

`ModelInfo`	Information regarding a specific Model instance
`ModelInfoRequest`	Empty request for runtime server information
`ModelInfoResponse`	Model Info response contains a list of ModelInfos
`RuntimeInfoRequest`	Empty request for runtime server information
`RuntimeInfoResponse`	A DataObject is a data model class that is backed by a @dataclass.
`DeployModelRequest`	Request to deploy a model
`UndeployModelRequest`	Request to undeploy a model
`PredictionJob`	DataModel returned as a result of starting a PredictionJob
`PredictionJobInfoRequest`	DataModel to request information about a PredictionJob
`PredictionJobStatusResponse`	DataModel representing the status of a PredictionJob
`ModelPointer`	A DataObject is a data model class that is backed by a @dataclass.
`TrainingInfoRequest`	A DataObject is a data model class that is backed by a @dataclass.
`TrainingJob`	A DataObject is a data model class that is backed by a @dataclass.
`TrainingStatusResponse`	A DataObject is a data model class that is backed by a @dataclass.

Package Contents

caikit.interfaces.runtime.data_model.RuntimeServerContextType

class caikit.interfaces.runtime.data_model.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.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.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)]

class caikit.interfaces.runtime.data_model.RuntimeInfoRequest[source]

Bases: caikit.core.data_model.DataObjectBase

Empty request for runtime server information

class caikit.interfaces.runtime.data_model.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.DeployModelRequest[source]

Bases: caikit.core.data_model.DataObjectBase

Request to deploy a model

model_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

model_files: py_to_proto.dataclass_to_proto.Annotated[List[caikit.interfaces.common.data_model.File], FieldNumber(2)]

class caikit.interfaces.runtime.data_model.UndeployModelRequest[source]

Bases: caikit.core.data_model.DataObjectBase

Request to undeploy a model

model_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

class caikit.interfaces.runtime.data_model.PredictionJob[source]

Bases: caikit.core.data_model.DataObjectBase

DataModel returned as a result of starting a PredictionJob

prediction_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

class caikit.interfaces.runtime.data_model.PredictionJobInfoRequest[source]

Bases: caikit.core.data_model.DataObjectBase

DataModel to request information about a PredictionJob

prediction_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

class caikit.interfaces.runtime.data_model.PredictionJobStatusResponse[source]

Bases: caikit.core.data_model.DataObjectBase

DataModel representing the status of a PredictionJob

prediction_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

state: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.JobStatus, FieldNumber(2)]

submission_timestamp: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(3)]

completion_timestamp: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(4)]

reasons: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(5)]

class caikit.interfaces.runtime.data_model.ModelPointer[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.

model_id: str

class caikit.interfaces.runtime.data_model.TrainingInfoRequest[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.

training_id: str

class caikit.interfaces.runtime.data_model.TrainingJob[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.

training_id: str

model_name: str

class caikit.interfaces.runtime.data_model.TrainingStatusResponse[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.

training_id: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)]

state: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.JobStatus, FieldNumber(2)]

submission_timestamp: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(3)]

completion_timestamp: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(4)]

reasons: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(5)]