viam.services.mlmodel.mlmodel
Module Contents
Classes
MLModel represents a Machine Learning Model service. |
- class viam.services.mlmodel.mlmodel.MLModel(name: str)[source]
Bases:
viam.services.service_base.ServiceBase
MLModel represents a Machine Learning Model service.
This acts as an abstract base class for any drivers representing specific arm implementations. This cannot be used on its own. If the
__init__()
function is overridden, it must call thesuper().__init__()
function.- SUBTYPE: Final
- abstract async infer(input_tensors: Dict[str, numpy.typing.NDArray], *, timeout: Optional[float]) Dict[str, numpy.typing.NDArray] [source]
Take an already ordered input tensor as an array, make an inference on the model, and return an output tensor map.
- Parameters:
input_tensors (Dict[str, NDArray]) – A dictionary of input flat tensors as specified in the metadata
- Returns:
A dictionary of output flat tensors as specified in the metadata
- Return type:
Dict[str, NDArray]
- abstract async metadata(*, timeout: Optional[float]) viam.proto.service.mlmodel.Metadata [source]
Get the metadata (such as name, type, expected tensor/array shape, inputs, and outputs) associated with the ML model.
- Returns:
The metadata
- Return type:
- classmethod from_robot(robot: viam.robot.client.RobotClient, name: str) typing_extensions.Self
Get the service named
name
from the provided robot.- Parameters:
robot (RobotClient) – The robot
name (str) – The name of the service
- Returns:
The service, if it exists on the robot
- Return type:
Self
- abstract async do_command(command: Mapping[str, viam.utils.ValueTypes], *, timeout: Optional[float] = None, **kwargs) Mapping[str, viam.utils.ValueTypes]
Send/Receive arbitrary commands to the Resource
- Parameters:
command (Mapping[str, ValueTypes]) – The command to execute
- Raises:
NotImplementedError – Raised if the Resource does not support arbitrary commands
- Returns:
Result of the executed command
- Return type:
Mapping[str, ValueTypes]
- classmethod get_resource_name(name: str) viam.proto.common.ResourceName
Get the ResourceName for this Resource with the given name
- Parameters:
name (str) – The name of the Resource
- get_operation(kwargs: Mapping[str, Any]) viam.operations.Operation
Get the
Operation
associated with the currently running function.When writing custom resources, you should get the
Operation
by calling this function and check to see if it’s cancelled. If theOperation
is cancelled, then you can perform any necessary (terminating long running tasks, cleaning up connections, etc. ).- Parameters:
kwargs (Mapping[str, Any]) – The kwargs object containing the operation
- Returns:
The operation associated with this function
- Return type: