caikit.interfaces.runtime.data_model ==================================== .. py:module:: caikit.interfaces.runtime.data_model Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/caikit/interfaces/runtime/data_model/context/index /autoapi/caikit/interfaces/runtime/data_model/info/index /autoapi/caikit/interfaces/runtime/data_model/model_management/index /autoapi/caikit/interfaces/runtime/data_model/package/index /autoapi/caikit/interfaces/runtime/data_model/prediction_job_management/index /autoapi/caikit/interfaces/runtime/data_model/training_management/index Attributes ---------- .. autoapisummary:: caikit.interfaces.runtime.data_model.RuntimeServerContextType Classes ------- .. autoapisummary:: caikit.interfaces.runtime.data_model.ModelInfo caikit.interfaces.runtime.data_model.ModelInfoRequest caikit.interfaces.runtime.data_model.ModelInfoResponse caikit.interfaces.runtime.data_model.RuntimeInfoRequest caikit.interfaces.runtime.data_model.RuntimeInfoResponse caikit.interfaces.runtime.data_model.DeployModelRequest caikit.interfaces.runtime.data_model.UndeployModelRequest caikit.interfaces.runtime.data_model.PredictionJob caikit.interfaces.runtime.data_model.PredictionJobInfoRequest caikit.interfaces.runtime.data_model.PredictionJobStatusResponse caikit.interfaces.runtime.data_model.ModelPointer caikit.interfaces.runtime.data_model.TrainingInfoRequest caikit.interfaces.runtime.data_model.TrainingJob caikit.interfaces.runtime.data_model.TrainingStatusResponse Package Contents ---------------- .. py:data:: RuntimeServerContextType .. py:class:: ModelInfo Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Information regarding a specific Model instance .. py:attribute:: model_path :type: py_to_proto.dataclass_to_proto.Annotated[Optional[str], FieldNumber(1)] .. py:attribute:: name :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(2)] .. py:attribute:: size :type: py_to_proto.dataclass_to_proto.Annotated[Optional[int], FieldNumber(3)] .. py:attribute:: metadata :type: py_to_proto.dataclass_to_proto.Annotated[Optional[caikit.core.data_model.json_dict.JsonDict], FieldNumber(4)] .. py:attribute:: loaded :type: py_to_proto.dataclass_to_proto.Annotated[bool, FieldNumber(7)] .. py:attribute:: module_id :type: py_to_proto.dataclass_to_proto.Annotated[Optional[str], FieldNumber(5)] .. py:attribute:: module_metadata :type: py_to_proto.dataclass_to_proto.Annotated[Optional[Dict[str, str]], FieldNumber(6)] .. py:class:: ModelInfoRequest Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Empty request for runtime server information .. py:attribute:: model_ids :type: py_to_proto.dataclass_to_proto.Annotated[Optional[List[str]], FieldNumber(1)] .. py:class:: ModelInfoResponse Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Model Info response contains a list of ModelInfos .. py:attribute:: models :type: py_to_proto.dataclass_to_proto.Annotated[List[ModelInfo], FieldNumber(1)] .. py:class:: RuntimeInfoRequest Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Empty request for runtime server information .. py:class:: RuntimeInfoResponse Bases: :py:obj:`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. .. py:attribute:: runtime_version :type: py_to_proto.dataclass_to_proto.Annotated[Optional[str], FieldNumber(1)] .. py:attribute:: python_packages :type: py_to_proto.dataclass_to_proto.Annotated[Dict[str, str], FieldNumber(2)] .. py:class:: DeployModelRequest Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Request to deploy a model .. py:attribute:: model_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:attribute:: model_files :type: py_to_proto.dataclass_to_proto.Annotated[List[caikit.interfaces.common.data_model.File], FieldNumber(2)] .. py:class:: UndeployModelRequest Bases: :py:obj:`caikit.core.data_model.DataObjectBase` Request to undeploy a model .. py:attribute:: model_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:class:: PredictionJob Bases: :py:obj:`caikit.core.data_model.DataObjectBase` DataModel returned as a result of starting a PredictionJob .. py:attribute:: prediction_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:class:: PredictionJobInfoRequest Bases: :py:obj:`caikit.core.data_model.DataObjectBase` DataModel to request information about a PredictionJob .. py:attribute:: prediction_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:class:: PredictionJobStatusResponse Bases: :py:obj:`caikit.core.data_model.DataObjectBase` DataModel representing the status of a PredictionJob .. py:attribute:: prediction_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:attribute:: state :type: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.JobStatus, FieldNumber(2)] .. py:attribute:: submission_timestamp :type: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(3)] .. py:attribute:: completion_timestamp :type: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(4)] .. py:attribute:: reasons :type: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(5)] .. py:class:: ModelPointer Bases: :py:obj:`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. .. py:attribute:: model_id :type: str .. py:class:: TrainingInfoRequest Bases: :py:obj:`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. .. py:attribute:: training_id :type: str .. py:class:: TrainingJob Bases: :py:obj:`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. .. py:attribute:: training_id :type: str .. py:attribute:: model_name :type: str .. py:class:: TrainingStatusResponse Bases: :py:obj:`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. .. py:attribute:: training_id :type: py_to_proto.dataclass_to_proto.Annotated[str, FieldNumber(1)] .. py:attribute:: state :type: py_to_proto.dataclass_to_proto.Annotated[caikit.core.data_model.JobStatus, FieldNumber(2)] .. py:attribute:: submission_timestamp :type: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(3)] .. py:attribute:: completion_timestamp :type: py_to_proto.dataclass_to_proto.Annotated[datetime.datetime, FieldNumber(4)] .. py:attribute:: reasons :type: py_to_proto.dataclass_to_proto.Annotated[List[str], FieldNumber(5)]