caikit.runtime.client.remote_config
===================================

.. py:module:: caikit.runtime.client.remote_config

.. autoapi-nested-parse::

   The RemoteModuleConfig is a ModuleConfig subclass used to describe a Module's
   interface without referencing the source ModuleBase. 



Attributes
----------

.. autoapisummary::

   caikit.runtime.client.remote_config.log
   caikit.runtime.client.remote_config.error


Classes
-------

.. autoapisummary::

   caikit.runtime.client.remote_config.RemoteRPCDescriptor
   caikit.runtime.client.remote_config.RemoteModuleConfig


Module Contents
---------------

.. py:data:: log

.. py:data:: error

.. py:class:: RemoteRPCDescriptor

   Helper dataclass to store information about a Remote RPC.


   .. py:attribute:: signature
      :type:  caikit.core.signature_parsing.module_signature.CaikitMethodSignature


   .. py:attribute:: request_dm_name
      :type:  str


   .. py:attribute:: response_dm_name
      :type:  str


   .. py:attribute:: rpc_name
      :type:  str


   .. py:attribute:: input_streaming
      :type:  bool
      :value: False



   .. py:attribute:: output_streaming
      :type:  bool
      :value: False



.. py:class:: RemoteModuleConfig(config_dict)

   Bases: :py:obj:`caikit.core.modules.config.ModuleConfig`


   Helper class to differentiate a local ModuleConfig and a RemoteModuleConfig. The structure
   should contain the following fields/structure


   .. py:attribute:: connection
      :type:  caikit.interfaces.common.data_model.remote.ConnectionInfo


   .. py:attribute:: protocol
      :type:  str


   .. py:attribute:: model_key
      :type:  str


   .. py:attribute:: task_methods
      :type:  List[Tuple[Type[caikit.core.task.TaskBase], List[RemoteRPCDescriptor]]]


   .. py:attribute:: train_method
      :type:  RemoteRPCDescriptor


   .. py:attribute:: model_path
      :type:  str


   .. py:attribute:: module_id
      :type:  str


   .. py:attribute:: module_name
      :type:  str


   .. py:attribute:: reserved_keys
      :value: []



   .. py:method:: load_from_module(module_reference: Union[str, Type[caikit.core.modules.base.ModuleBase], caikit.core.modules.base.ModuleBase], connection_info: caikit.interfaces.common.data_model.remote.ConnectionInfo, protocol: str, model_key: str, model_path: str) -> RemoteModuleConfig
      :classmethod:


      Construct a new remote module configuration from an existing local Module

      Args:
          module_reference: Union[str, Type[ModuleBase]]:
              Module_reference should either be the id of the locally loaded module,
              or a module class

          model_path (str):
              The path used to load this module

          connection_info ConnectionInfo:
              The connection information of the remote to use

          protocol: str
              The protocol to connect with

          model_key: str
              The model key to use when sending GRPC requests. An example is mm-model-id

         Returns:
             model_config (RemoteModuleConfig): Instantiated RemoteModuleConfig for
             model given model_path.