viam-sdk 0.46.0__py3-none-linux_armv7l.whl → 0.47.0__py3-none-linux_armv7l.whl

viam/app/data_client.py

@@ -7,6 +7,7 @@ from typing import Any, Dict, List, Mapping, Optional, Sequence, Tuple, Union, c
 import bson
 from google.protobuf.struct_pb2 import Struct
 from grpclib.client import Channel, Stream
+from typing_extensions import Self
 
 from viam import logging
 from viam.proto.app.data import (
@@ -54,9 +55,30 @@ from viam.proto.app.data import (
     TabularDataByMQLResponse,
     TabularDataBySQLRequest,
     TabularDataBySQLResponse,
+    TabularDataSource,
+    TabularDataSourceType,
     TagsByFilterRequest,
     TagsByFilterResponse,
 )
+from viam.proto.app.datapipelines import (
+    CreateDataPipelineRequest,
+    CreateDataPipelineResponse,
+    DataPipelineRunStatus,
+    DataPipelinesServiceStub,
+    DeleteDataPipelineRequest,
+    GetDataPipelineRequest,
+    GetDataPipelineResponse,
+    ListDataPipelineRunsRequest,
+    ListDataPipelineRunsResponse,
+    ListDataPipelinesRequest,
+    ListDataPipelinesResponse,
+)
+from viam.proto.app.datapipelines import (
+    DataPipeline as ProtoDataPipeline,
+)
+from viam.proto.app.datapipelines import (
+    DataPipelineRun as ProtoDataPipelineRun,
+)
 from viam.proto.app.dataset import (
     CreateDatasetRequest,
     CreateDatasetResponse,
@@ -220,6 +242,121 @@ class DataClient:
             )
             return self.resource_api
 
+    @dataclass
+    class DataPipeline:
+        """Represents a data pipeline and its associated metadata."""
+
+        id: str
+        """The ID of the data pipeline"""
+
+        organization_id: str
+        """The organization ID"""
+
+        name: str
+        """The name of the data pipeline"""
+
+        mql_binary: List[Dict[str, Any]]
+        """The MQL binary of the data pipeline"""
+
+        schedule: str
+        """The schedule of the data pipeline"""
+
+        created_on: datetime
+        """The time the data pipeline was created"""
+
+        updated_at: datetime
+        """The time the data pipeline was last updated"""
+
+        enabled: bool
+        """Whether the data pipeline is enabled"""
+
+        @classmethod
+        def from_proto(cls, data_pipeline: ProtoDataPipeline) -> Self:
+            return cls(
+                id=data_pipeline.id,
+                organization_id=data_pipeline.organization_id,
+                name=data_pipeline.name,
+                mql_binary=[bson.decode(bson_bytes) for bson_bytes in data_pipeline.mql_binary],
+                schedule=data_pipeline.schedule,
+                created_on=data_pipeline.created_on.ToDatetime(),
+                updated_at=data_pipeline.updated_at.ToDatetime(),
+                enabled=data_pipeline.enabled,
+            )
+
+    @dataclass
+    class DataPipelineRun:
+        """Represents a data pipeline run and its associated metadata."""
+
+        id: str
+        """The ID of the data pipeline run"""
+
+        status: DataPipelineRunStatus.ValueType
+        """The status of the data pipeline run"""
+
+        start_time: datetime
+        """The time the data pipeline run started"""
+
+        end_time: datetime
+        """The time the data pipeline run ended"""
+
+        data_start_time: datetime
+        """The start time of the data that was processed in the run."""
+        data_end_time: datetime
+        """The end time of the data that was processed in the run."""
+
+        @classmethod
+        def from_proto(cls, data_pipeline_run: ProtoDataPipelineRun) -> Self:
+            return cls(
+                id=data_pipeline_run.id,
+                status=data_pipeline_run.status,
+                start_time=data_pipeline_run.start_time.ToDatetime(),
+                end_time=data_pipeline_run.end_time.ToDatetime(),
+                data_start_time=data_pipeline_run.data_start_time.ToDatetime(),
+                data_end_time=data_pipeline_run.data_end_time.ToDatetime(),
+            )
+
+    @dataclass
+    class DataPipelineRunsPage:
+        """Represents a page of data pipeline runs and provides pagination functionality."""
+
+        _client: "DataClient"
+        """The data client used to make API calls"""
+
+        pipeline_id: str
+        """The ID of the pipeline these runs belong to"""
+
+        page_size: int
+        """The number of runs per page"""
+
+        runs: List["DataClient.DataPipelineRun"]
+        """The list of runs in this page"""
+
+        next_page_token: str
+        """The token to use to get the next page of results"""
+
+        async def next_page(self) -> "DataClient.DataPipelineRunsPage":
+            """Get the next page of data pipeline runs.
+
+            Returns:
+                DataPipelineRunsPage: The next page of runs, or an empty page if there are no more runs
+            """
+            if not self.next_page_token:
+                # no token, return empty next page
+                return DataClient.DataPipelineRunsPage(
+                    _client=self._client, pipeline_id=self.pipeline_id, page_size=self.page_size, runs=[], next_page_token=""
+                )
+            return await self._client._list_data_pipeline_runs(self.pipeline_id, self.page_size, self.next_page_token)
+
+        @classmethod
+        def from_proto(cls, data_pipeline_runs_page: ListDataPipelineRunsResponse, client: "DataClient", page_size: int) -> Self:
+            return cls(
+                _client=client,
+                pipeline_id=data_pipeline_runs_page.pipeline_id,
+                page_size=page_size,
+                runs=[DataClient.DataPipelineRun.from_proto(run) for run in data_pipeline_runs_page.runs],
+                next_page_token=data_pipeline_runs_page.next_page_token,
+            )
+
     def __init__(self, channel: Channel, metadata: Mapping[str, str]):
         """Create a :class:`DataClient` that maintains a connection to app.
 
@@ -231,11 +368,13 @@ class DataClient:
         self._data_client = DataServiceStub(channel)
         self._data_sync_client = DataSyncServiceStub(channel)
         self._dataset_client = DatasetServiceStub(channel)
+        self._data_pipelines_client = DataPipelinesServiceStub(channel)
         self._channel = channel
 
     _data_client: DataServiceStub
     _data_sync_client: DataSyncServiceStub
     _dataset_client: DatasetServiceStub
+    _data_pipelines_client: DataPipelinesServiceStub
     _metadata: Mapping[str, str]
     _channel: Channel
 
@@ -345,7 +484,12 @@ class DataClient:
 
     @_alias_param("query", param_alias="mql_binary")
     async def tabular_data_by_mql(
-        self, organization_id: str, query: Union[List[bytes], List[Dict[str, Any]]], use_recent_data: Optional[bool] = None
+        self,
+        organization_id: str,
+        query: Union[List[bytes], List[Dict[str, Any]]],
+        use_recent_data: Optional[bool] = None,
+        tabular_data_source_type: TabularDataSourceType.ValueType = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_STANDARD,
+        pipeline_id: Optional[str] = None,
     ) -> List[Dict[str, Union[ValueTypes, datetime]]]:
         """Obtain unified tabular data and metadata, queried with MQL.
 
@@ -366,7 +510,12 @@ class DataClient:
             query (Union[List[bytes], List[Dict[str, Any]]]): The MQL query to run, as a list of MongoDB aggregation pipeline stages.
                 Each stage can be provided as either a dictionary or raw BSON bytes, but support for bytes will be removed in the
                 future, so prefer the dictionary option.
-            use_recent_data (bool): Whether to query blob storage or your recent data store. Defaults to ``False``.
+            use_recent_data (bool): Whether to query blob storage or your recent data store. Defaults to ``False``..
+                Deprecated, use `tabular_data_source_type` instead.
+            tabular_data_source_type (viam.proto.app.data.TabularDataSourceType): The data source to query.
+                Defaults to `TABULAR_DATA_SOURCE_TYPE_STANDARD`.
+            pipeline_id (str): The ID of the data pipeline to query. Defaults to `None`.
+                Required if `tabular_data_source_type` is `TABULAR_DATA_SOURCE_TYPE_PIPELINE_SINK`.
 
         Returns:
             List[Dict[str, Union[ValueTypes, datetime]]]: An array of decoded BSON data objects.
@@ -374,7 +523,10 @@ class DataClient:
         For more information, see `Data Client API <https://docs.viam.com/dev/reference/apis/data-client/#tabulardatabymql>`_.
         """
         binary: List[bytes] = [bson.encode(query) for query in query] if isinstance(query[0], dict) else query  # type: ignore
-        request = TabularDataByMQLRequest(organization_id=organization_id, mql_binary=binary, use_recent_data=use_recent_data)
+        data_source = TabularDataSource(type=tabular_data_source_type, pipeline_id=pipeline_id)
+        if use_recent_data:
+            data_source.type = TabularDataSourceType.TABULAR_DATA_SOURCE_TYPE_HOT_STORAGE
+        request = TabularDataByMQLRequest(organization_id=organization_id, mql_binary=binary, data_source=data_source)
         response: TabularDataByMQLResponse = await self._data_client.TabularDataByMQL(request, metadata=self._metadata)
         return [bson.decode(bson_bytes) for bson_bytes in response.raw_data]
 
@@ -1696,6 +1848,115 @@ class DataClient:
                 raise TypeError("Response cannot be empty")
             return response
 
+    async def get_data_pipeline(self, id: str) -> DataPipeline:
+        """Get a data pipeline by its ID.
+
+        ::
+
+            data_pipeline = await data_client.get_data_pipeline(id="<YOUR-DATA-PIPELINE-ID>")
+
+        Args:
+            id (str): The ID of the data pipeline to get.
+
+        Returns:
+            DataPipeline: The data pipeline with the given ID.
+        """
+        request = GetDataPipelineRequest(id=id)
+        response: GetDataPipelineResponse = await self._data_pipelines_client.GetDataPipeline(request, metadata=self._metadata)
+        return DataClient.DataPipeline.from_proto(response.data_pipeline)
+
+    async def list_data_pipelines(self, organization_id: str) -> List[DataPipeline]:
+        """List all of the data pipelines for an organization.
+
+        ::
+
+            data_pipelines = await data_client.list_data_pipelines(organization_id="<YOUR-ORGANIZATION-ID>")
+
+        Args:
+            organization_id (str): The ID of the organization that owns the pipelines.
+                You can obtain your organization ID from the Viam app's organization settings page.
+
+        Returns:
+            List[DataPipeline]: A list of all of the data pipelines for the given organization.
+        """
+        request = ListDataPipelinesRequest(organization_id=organization_id)
+        response: ListDataPipelinesResponse = await self._data_pipelines_client.ListDataPipelines(request, metadata=self._metadata)
+        return [DataClient.DataPipeline.from_proto(pipeline) for pipeline in response.data_pipelines]
+
+    async def create_data_pipeline(self, organization_id: str, name: str, mql_binary: List[Dict[str, Any]], schedule: str) -> str:
+        """Create a new data pipeline.
+
+        ::
+
+            data_pipeline_id = await data_client.create_data_pipeline(
+                organization_id="<YOUR-ORGANIZATION-ID>",
+                name="<YOUR-PIPELINE-NAME>",
+                mql_binary=[<YOUR-MQL-PIPELINE-AGGREGATION>],
+                schedule="<YOUR-SCHEDULE>"
+            )
+
+        Args:
+            organization_id (str): The ID of the organization that will own the pipeline.
+                You can obtain your organization ID from the Viam app's organization settings page.
+            name (str): The name of the pipeline.
+            mql_binary (List[Dict[str, Any]]):The MQL pipeline to run, as a list of MongoDB aggregation pipeline stages.
+            schedule (str): A cron expression representing the expected execution schedule in UTC (note this also
+                defines the input time window; an hourly schedule would process 1 hour of data at a time).
+
+        Returns:
+            str: The ID of the newly created pipeline.
+        """
+        binary: List[bytes] = [bson.encode(query) for query in mql_binary]
+        request = CreateDataPipelineRequest(organization_id=organization_id, name=name, mql_binary=binary, schedule=schedule)
+        response: CreateDataPipelineResponse = await self._data_pipelines_client.CreateDataPipeline(request, metadata=self._metadata)
+        return response.id
+
+    async def delete_data_pipeline(self, id: str) -> None:
+        """Delete a data pipeline by its ID.
+
+        ::
+
+            await data_client.delete_data_pipeline(id="<YOUR-DATA-PIPELINE-ID>")
+
+        Args:
+            id (str): The ID of the data pipeline to delete.
+        """
+        request = DeleteDataPipelineRequest(id=id)
+        await self._data_pipelines_client.DeleteDataPipeline(request, metadata=self._metadata)
+
+    async def list_data_pipeline_runs(self, id: str, page_size: int = 10) -> DataPipelineRunsPage:
+        """List all of the data pipeline runs for a data pipeline.
+
+        ::
+
+            data_pipeline_runs = await data_client.list_data_pipeline_runs(id="<YOUR-DATA-PIPELINE-ID>")
+            while len(data_pipeline_runs.runs) > 0:
+                data_pipeline_runs = await data_pipeline_runs.next_page()
+
+        Args:
+            id (str): The ID of the pipeline to list runs for
+            page_size (int): The number of runs to return per page. Defaults to 10.
+
+        Returns:
+            DataPipelineRunsPage: A page of data pipeline runs with pagination support
+        """
+        return await self._list_data_pipeline_runs(id, page_size)
+
+    async def _list_data_pipeline_runs(self, id: str, page_size: int, page_token: str = "") -> DataPipelineRunsPage:
+        """Internal method to list data pipeline runs with pagination.
+
+        Args:
+            id (str): The ID of the pipeline to list runs for
+            page_size (int): The number of runs to return per page
+            page_token (str): The token to use to get the next page of results
+
+        Returns:
+            DataPipelineRunsPage: A page of data pipeline runs with pagination support
+        """
+        request = ListDataPipelineRunsRequest(id=id, page_size=page_size, page_token=page_token)
+        response: ListDataPipelineRunsResponse = await self._data_pipelines_client.ListDataPipelineRuns(request, metadata=self._metadata)
+        return DataClient.DataPipelineRunsPage.from_proto(response, self, page_size)
+
     @staticmethod
     def create_filter(
         component_name: Optional[str] = None,

viam/gen/app/mltraining/v1/ml_training_pb2.py

@@ -9,7 +9,7 @@ _sym_db = _symbol_database.Default()
 from google.protobuf import timestamp_pb2 as google_dot_protobuf_dot_timestamp__pb2
 from google.rpc import status_pb2 as google_dot_rpc_dot_status__pb2
 from ....tagger.v1 import tagger_pb2 as tagger_dot_v1_dot_tagger__pb2
-DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n#app/mltraining/v1/ml_training.proto\x12\x16viam.app.mltraining.v1\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\x1a\x16tagger/v1/tagger.proto"\x90\x05\n\x18SubmitTrainingJobRequest\x12G\n\ndataset_id\x18\x07 \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12[\n\x0forganization_id\x18\x02 \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\x03 \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x04 \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12j\n\nmodel_type\x18\x05 \x01(\x0e2!.viam.app.mltraining.v1.ModelTypeB(\x9a\x84\x9e\x03#bson:"model_type" json:"model_type"R\tmodelType\x12\x83\x01\n\x0fmodel_framework\x18\x08 \x01(\x0e2&.viam.app.mltraining.v1.ModelFrameworkB2\x9a\x84\x9e\x03-bson:"model_framework" json:"model_framework"R\x0emodelFramework\x120\n\x04tags\x18\x06 \x03(\tB\x1c\x9a\x84\x9e\x03\x17bson:"tags" json:"tags"R\x04tagsJ\x04\x08\x01\x10\x02R\x06filter"+\n\x19SubmitTrainingJobResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\xdb\x05\n\x1eSubmitCustomTrainingJobRequest\x12G\n\ndataset_id\x18\x01 \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12^\n\x10registry_item_id\x18\x02 \x01(\tB4\x9a\x84\x9e\x03/bson:"registry_item_id" json:"registry_item_id"R\x0eregistryItemId\x12r\n\x15registry_item_version\x18\x06 \x01(\tB>\x9a\x84\x9e\x039bson:"registry_item_version" json:"registry_item_version"R\x13registryItemVersion\x12[\n\x0forganization_id\x18\x03 \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\x04 \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x05 \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12c\n\targuments\x18\x07 \x03(\x0b2E.viam.app.mltraining.v1.SubmitCustomTrainingJobRequest.ArgumentsEntryR\targuments\x1a<\n\x0eArgumentsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x028\x01"1\n\x1fSubmitCustomTrainingJobResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\'\n\x15GetTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"a\n\x16GetTrainingJobResponse\x12G\n\x08metadata\x18\x01 \x01(\x0b2+.viam.app.mltraining.v1.TrainingJobMetadataR\x08metadata"\x82\x01\n\x17ListTrainingJobsRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId\x12>\n\x06status\x18\x02 \x01(\x0e2&.viam.app.mltraining.v1.TrainingStatusR\x06status"[\n\x18ListTrainingJobsResponse\x12?\n\x04jobs\x18\x01 \x03(\x0b2+.viam.app.mltraining.v1.TrainingJobMetadataR\x04jobs"\xe6\r\n\x13TrainingJobMetadata\x123\n\x02id\x18\x07 \x01(\tB#\x9a\x84\x9e\x03\x1ebson:"_id" json:"id,omitempty"R\x02id\x12G\n\ndataset_id\x18\x0b \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12[\n\x0forganization_id\x18\x0c \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\r \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x0e \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12j\n\nmodel_type\x18\x0f \x01(\x0e2!.viam.app.mltraining.v1.ModelTypeB(\x9a\x84\x9e\x03#bson:"model_type" json:"model_type"R\tmodelType\x12\x83\x01\n\x0fmodel_framework\x18\x11 \x01(\x0e2&.viam.app.mltraining.v1.ModelFrameworkB2\x9a\x84\x9e\x03-bson:"model_framework" json:"model_framework"R\x0emodelFramework\x12R\n\ris_custom_job\x18\x12 \x01(\x08B.\x9a\x84\x9e\x03)bson:"is_custom_job" json:"is_custom_job"R\x0bisCustomJob\x12^\n\x10registry_item_id\x18\x13 \x01(\tB4\x9a\x84\x9e\x03/bson:"registry_item_id" json:"registry_item_id"R\x0eregistryItemId\x12r\n\x15registry_item_version\x18\x14 \x01(\tB>\x9a\x84\x9e\x039bson:"registry_item_version" json:"registry_item_version"R\x13registryItemVersion\x12`\n\x06status\x18\x02 \x01(\x0e2&.viam.app.mltraining.v1.TrainingStatusB \x9a\x84\x9e\x03\x1bbson:"status" json:"status"R\x06status\x12c\n\x0cerror_status\x18\x08 \x01(\x0b2\x12.google.rpc.StatusB,\x9a\x84\x9e\x03\'bson:"error_status" json:"error_status"R\x0berrorStatus\x12c\n\ncreated_on\x18\x03 \x01(\x0b2\x1a.google.protobuf.TimestampB(\x9a\x84\x9e\x03#bson:"created_on" json:"created_on"R\tcreatedOn\x12o\n\rlast_modified\x18\x04 \x01(\x0b2\x1a.google.protobuf.TimestampB.\x9a\x84\x9e\x03)bson:"last_modified" json:"last_modified"R\x0clastModified\x12{\n\x10training_started\x18\t \x01(\x0b2\x1a.google.protobuf.TimestampB4\x9a\x84\x9e\x03/bson:"training_started" json:"training_started"R\x0ftrainingStarted\x12s\n\x0etraining_ended\x18\n \x01(\x0b2\x1a.google.protobuf.TimestampB0\x9a\x84\x9e\x03+bson:"training_ended" json:"training_ended"R\rtrainingEnded\x12Z\n\x0fsynced_model_id\x18\x05 \x01(\tB2\x9a\x84\x9e\x03-bson:"synced_model_id" json:"synced_model_id"R\rsyncedModelId\x120\n\x04tags\x18\x10 \x03(\tB\x1c\x9a\x84\x9e\x03\x17bson:"tags" json:"tags"R\x04tagsJ\x04\x08\x01\x10\x02J\x04\x08\x06\x10\x07R\x07requestR\nuser_email"*\n\x18CancelTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1b\n\x19CancelTrainingJobResponse"3\n!DeleteCompletedTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"$\n"DeleteCompletedTrainingJobResponse"u\n\x13TrainingJobLogEntry\x12\x14\n\x05level\x18\x01 \x01(\tR\x05level\x12.\n\x04time\x18\x02 \x01(\x0b2\x1a.google.protobuf.TimestampR\x04time\x12\x18\n\x07message\x18\x03 \x01(\tR\x07message"^\n\x19GetTrainingJobLogsRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12"\n\npage_token\x18\x02 \x01(\tH\x00R\tpageToken\x88\x01\x01B\r\n\x0b_page_token"\x85\x01\n\x1aGetTrainingJobLogsResponse\x12?\n\x04logs\x18\x01 \x03(\x0b2+.viam.app.mltraining.v1.TrainingJobLogEntryR\x04logs\x12&\n\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken*\x9f\x01\n\tModelType\x12\x1a\n\x16MODEL_TYPE_UNSPECIFIED\x10\x00\x12*\n&MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION\x10\x01\x12)\n%MODEL_TYPE_MULTI_LABEL_CLASSIFICATION\x10\x02\x12\x1f\n\x1bMODEL_TYPE_OBJECT_DETECTION\x10\x03*\xa4\x01\n\x0eModelFramework\x12\x1f\n\x1bMODEL_FRAMEWORK_UNSPECIFIED\x10\x00\x12\x1a\n\x16MODEL_FRAMEWORK_TFLITE\x10\x01\x12\x1e\n\x1aMODEL_FRAMEWORK_TENSORFLOW\x10\x02\x12\x1b\n\x17MODEL_FRAMEWORK_PYTORCH\x10\x03\x12\x18\n\x14MODEL_FRAMEWORK_ONNX\x10\x04*\xe7\x01\n\x0eTrainingStatus\x12\x1f\n\x1bTRAINING_STATUS_UNSPECIFIED\x10\x00\x12\x1b\n\x17TRAINING_STATUS_PENDING\x10\x01\x12\x1f\n\x1bTRAINING_STATUS_IN_PROGRESS\x10\x02\x12\x1d\n\x19TRAINING_STATUS_COMPLETED\x10\x03\x12\x1a\n\x16TRAINING_STATUS_FAILED\x10\x04\x12\x1c\n\x18TRAINING_STATUS_CANCELED\x10\x05\x12\x1d\n\x19TRAINING_STATUS_CANCELING\x10\x062\x8f\x07\n\x11MLTrainingService\x12x\n\x11SubmitTrainingJob\x120.viam.app.mltraining.v1.SubmitTrainingJobRequest\x1a1.viam.app.mltraining.v1.SubmitTrainingJobResponse\x12\x8a\x01\n\x17SubmitCustomTrainingJob\x126.viam.app.mltraining.v1.SubmitCustomTrainingJobRequest\x1a7.viam.app.mltraining.v1.SubmitCustomTrainingJobResponse\x12o\n\x0eGetTrainingJob\x12-.viam.app.mltraining.v1.GetTrainingJobRequest\x1a..viam.app.mltraining.v1.GetTrainingJobResponse\x12u\n\x10ListTrainingJobs\x12/.viam.app.mltraining.v1.ListTrainingJobsRequest\x1a0.viam.app.mltraining.v1.ListTrainingJobsResponse\x12x\n\x11CancelTrainingJob\x120.viam.app.mltraining.v1.CancelTrainingJobRequest\x1a1.viam.app.mltraining.v1.CancelTrainingJobResponse\x12\x93\x01\n\x1aDeleteCompletedTrainingJob\x129.viam.app.mltraining.v1.DeleteCompletedTrainingJobRequest\x1a:.viam.app.mltraining.v1.DeleteCompletedTrainingJobResponse\x12{\n\x12GetTrainingJobLogs\x121.viam.app.mltraining.v1.GetTrainingJobLogsRequest\x1a2.viam.app.mltraining.v1.GetTrainingJobLogsResponseB#Z!go.viam.com/api/app/mltraining/v1b\x06proto3')
+DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(b'\n#app/mltraining/v1/ml_training.proto\x12\x16viam.app.mltraining.v1\x1a\x1fgoogle/protobuf/timestamp.proto\x1a\x17google/rpc/status.proto\x1a\x16tagger/v1/tagger.proto"\x90\x05\n\x18SubmitTrainingJobRequest\x12G\n\ndataset_id\x18\x07 \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12[\n\x0forganization_id\x18\x02 \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\x03 \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x04 \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12j\n\nmodel_type\x18\x05 \x01(\x0e2!.viam.app.mltraining.v1.ModelTypeB(\x9a\x84\x9e\x03#bson:"model_type" json:"model_type"R\tmodelType\x12\x83\x01\n\x0fmodel_framework\x18\x08 \x01(\x0e2&.viam.app.mltraining.v1.ModelFrameworkB2\x9a\x84\x9e\x03-bson:"model_framework" json:"model_framework"R\x0emodelFramework\x120\n\x04tags\x18\x06 \x03(\tB\x1c\x9a\x84\x9e\x03\x17bson:"tags" json:"tags"R\x04tagsJ\x04\x08\x01\x10\x02R\x06filter"+\n\x19SubmitTrainingJobResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\xdb\x05\n\x1eSubmitCustomTrainingJobRequest\x12G\n\ndataset_id\x18\x01 \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12^\n\x10registry_item_id\x18\x02 \x01(\tB4\x9a\x84\x9e\x03/bson:"registry_item_id" json:"registry_item_id"R\x0eregistryItemId\x12r\n\x15registry_item_version\x18\x06 \x01(\tB>\x9a\x84\x9e\x039bson:"registry_item_version" json:"registry_item_version"R\x13registryItemVersion\x12[\n\x0forganization_id\x18\x03 \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\x04 \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x05 \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12c\n\targuments\x18\x07 \x03(\x0b2E.viam.app.mltraining.v1.SubmitCustomTrainingJobRequest.ArgumentsEntryR\targuments\x1a<\n\x0eArgumentsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x028\x01"1\n\x1fSubmitCustomTrainingJobResponse\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\'\n\x15GetTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"a\n\x16GetTrainingJobResponse\x12G\n\x08metadata\x18\x01 \x01(\x0b2+.viam.app.mltraining.v1.TrainingJobMetadataR\x08metadata"\x82\x01\n\x17ListTrainingJobsRequest\x12\'\n\x0forganization_id\x18\x01 \x01(\tR\x0eorganizationId\x12>\n\x06status\x18\x02 \x01(\x0e2&.viam.app.mltraining.v1.TrainingStatusR\x06status"[\n\x18ListTrainingJobsResponse\x12?\n\x04jobs\x18\x01 \x03(\x0b2+.viam.app.mltraining.v1.TrainingJobMetadataR\x04jobs"\xa7\x0f\n\x13TrainingJobMetadata\x123\n\x02id\x18\x07 \x01(\tB#\x9a\x84\x9e\x03\x1ebson:"_id" json:"id,omitempty"R\x02id\x12G\n\ndataset_id\x18\x0b \x01(\tB(\x9a\x84\x9e\x03#bson:"dataset_id" json:"dataset_id"R\tdatasetId\x12[\n\x0forganization_id\x18\x0c \x01(\tB2\x9a\x84\x9e\x03-bson:"organization_id" json:"organization_id"R\x0eorganizationId\x12G\n\nmodel_name\x18\r \x01(\tB(\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"R\tmodelName\x12S\n\rmodel_version\x18\x0e \x01(\tB.\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"R\x0cmodelVersion\x12j\n\nmodel_type\x18\x0f \x01(\x0e2!.viam.app.mltraining.v1.ModelTypeB(\x9a\x84\x9e\x03#bson:"model_type" json:"model_type"R\tmodelType\x12\x83\x01\n\x0fmodel_framework\x18\x11 \x01(\x0e2&.viam.app.mltraining.v1.ModelFrameworkB2\x9a\x84\x9e\x03-bson:"model_framework" json:"model_framework"R\x0emodelFramework\x12R\n\ris_custom_job\x18\x12 \x01(\x08B.\x9a\x84\x9e\x03)bson:"is_custom_job" json:"is_custom_job"R\x0bisCustomJob\x12^\n\x10registry_item_id\x18\x13 \x01(\tB4\x9a\x84\x9e\x03/bson:"registry_item_id" json:"registry_item_id"R\x0eregistryItemId\x12r\n\x15registry_item_version\x18\x14 \x01(\tB>\x9a\x84\x9e\x039bson:"registry_item_version" json:"registry_item_version"R\x13registryItemVersion\x12`\n\x06status\x18\x02 \x01(\x0e2&.viam.app.mltraining.v1.TrainingStatusB \x9a\x84\x9e\x03\x1bbson:"status" json:"status"R\x06status\x12c\n\x0cerror_status\x18\x08 \x01(\x0b2\x12.google.rpc.StatusB,\x9a\x84\x9e\x03\'bson:"error_status" json:"error_status"R\x0berrorStatus\x12c\n\ncreated_on\x18\x03 \x01(\x0b2\x1a.google.protobuf.TimestampB(\x9a\x84\x9e\x03#bson:"created_on" json:"created_on"R\tcreatedOn\x12o\n\rlast_modified\x18\x04 \x01(\x0b2\x1a.google.protobuf.TimestampB.\x9a\x84\x9e\x03)bson:"last_modified" json:"last_modified"R\x0clastModified\x12{\n\x10training_started\x18\t \x01(\x0b2\x1a.google.protobuf.TimestampB4\x9a\x84\x9e\x03/bson:"training_started" json:"training_started"R\x0ftrainingStarted\x12s\n\x0etraining_ended\x18\n \x01(\x0b2\x1a.google.protobuf.TimestampB0\x9a\x84\x9e\x03+bson:"training_ended" json:"training_ended"R\rtrainingEnded\x12Z\n\x0fsynced_model_id\x18\x05 \x01(\tB2\x9a\x84\x9e\x03-bson:"synced_model_id" json:"synced_model_id"R\rsyncedModelId\x120\n\x04tags\x18\x10 \x03(\tB\x1c\x9a\x84\x9e\x03\x17bson:"tags" json:"tags"R\x04tags\x12\x80\x01\n\targuments\x18\x15 \x03(\x0b2:.viam.app.mltraining.v1.TrainingJobMetadata.ArgumentsEntryB&\x9a\x84\x9e\x03!bson:"arguments" json:"arguments"R\targuments\x1a<\n\x0eArgumentsEntry\x12\x10\n\x03key\x18\x01 \x01(\tR\x03key\x12\x14\n\x05value\x18\x02 \x01(\tR\x05value:\x028\x01J\x04\x08\x01\x10\x02J\x04\x08\x06\x10\x07R\x07requestR\nuser_email"*\n\x18CancelTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"\x1b\n\x19CancelTrainingJobResponse"3\n!DeleteCompletedTrainingJobRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id"$\n"DeleteCompletedTrainingJobResponse"u\n\x13TrainingJobLogEntry\x12\x14\n\x05level\x18\x01 \x01(\tR\x05level\x12.\n\x04time\x18\x02 \x01(\x0b2\x1a.google.protobuf.TimestampR\x04time\x12\x18\n\x07message\x18\x03 \x01(\tR\x07message"^\n\x19GetTrainingJobLogsRequest\x12\x0e\n\x02id\x18\x01 \x01(\tR\x02id\x12"\n\npage_token\x18\x02 \x01(\tH\x00R\tpageToken\x88\x01\x01B\r\n\x0b_page_token"\x85\x01\n\x1aGetTrainingJobLogsResponse\x12?\n\x04logs\x18\x01 \x03(\x0b2+.viam.app.mltraining.v1.TrainingJobLogEntryR\x04logs\x12&\n\x0fnext_page_token\x18\x02 \x01(\tR\rnextPageToken*\x9f\x01\n\tModelType\x12\x1a\n\x16MODEL_TYPE_UNSPECIFIED\x10\x00\x12*\n&MODEL_TYPE_SINGLE_LABEL_CLASSIFICATION\x10\x01\x12)\n%MODEL_TYPE_MULTI_LABEL_CLASSIFICATION\x10\x02\x12\x1f\n\x1bMODEL_TYPE_OBJECT_DETECTION\x10\x03*\xa4\x01\n\x0eModelFramework\x12\x1f\n\x1bMODEL_FRAMEWORK_UNSPECIFIED\x10\x00\x12\x1a\n\x16MODEL_FRAMEWORK_TFLITE\x10\x01\x12\x1e\n\x1aMODEL_FRAMEWORK_TENSORFLOW\x10\x02\x12\x1b\n\x17MODEL_FRAMEWORK_PYTORCH\x10\x03\x12\x18\n\x14MODEL_FRAMEWORK_ONNX\x10\x04*\xe7\x01\n\x0eTrainingStatus\x12\x1f\n\x1bTRAINING_STATUS_UNSPECIFIED\x10\x00\x12\x1b\n\x17TRAINING_STATUS_PENDING\x10\x01\x12\x1f\n\x1bTRAINING_STATUS_IN_PROGRESS\x10\x02\x12\x1d\n\x19TRAINING_STATUS_COMPLETED\x10\x03\x12\x1a\n\x16TRAINING_STATUS_FAILED\x10\x04\x12\x1c\n\x18TRAINING_STATUS_CANCELED\x10\x05\x12\x1d\n\x19TRAINING_STATUS_CANCELING\x10\x062\x8f\x07\n\x11MLTrainingService\x12x\n\x11SubmitTrainingJob\x120.viam.app.mltraining.v1.SubmitTrainingJobRequest\x1a1.viam.app.mltraining.v1.SubmitTrainingJobResponse\x12\x8a\x01\n\x17SubmitCustomTrainingJob\x126.viam.app.mltraining.v1.SubmitCustomTrainingJobRequest\x1a7.viam.app.mltraining.v1.SubmitCustomTrainingJobResponse\x12o\n\x0eGetTrainingJob\x12-.viam.app.mltraining.v1.GetTrainingJobRequest\x1a..viam.app.mltraining.v1.GetTrainingJobResponse\x12u\n\x10ListTrainingJobs\x12/.viam.app.mltraining.v1.ListTrainingJobsRequest\x1a0.viam.app.mltraining.v1.ListTrainingJobsResponse\x12x\n\x11CancelTrainingJob\x120.viam.app.mltraining.v1.CancelTrainingJobRequest\x1a1.viam.app.mltraining.v1.CancelTrainingJobResponse\x12\x93\x01\n\x1aDeleteCompletedTrainingJob\x129.viam.app.mltraining.v1.DeleteCompletedTrainingJobRequest\x1a:.viam.app.mltraining.v1.DeleteCompletedTrainingJobResponse\x12{\n\x12GetTrainingJobLogs\x121.viam.app.mltraining.v1.GetTrainingJobLogsRequest\x1a2.viam.app.mltraining.v1.GetTrainingJobLogsResponseB#Z!go.viam.com/api/app/mltraining/v1b\x06proto3')
 _globals = globals()
 _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
 _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, 'app.mltraining.v1.ml_training_pb2', _globals)
@@ -44,6 +44,8 @@ if not _descriptor._USE_C_DESCRIPTORS:
     _globals['_SUBMITCUSTOMTRAININGJOBREQUEST'].fields_by_name['model_name']._serialized_options = b'\x9a\x84\x9e\x03#bson:"model_name" json:"model_name"'
     _globals['_SUBMITCUSTOMTRAININGJOBREQUEST'].fields_by_name['model_version']._loaded_options = None
     _globals['_SUBMITCUSTOMTRAININGJOBREQUEST'].fields_by_name['model_version']._serialized_options = b'\x9a\x84\x9e\x03)bson:"model_version" json:"model_version"'
+    _globals['_TRAININGJOBMETADATA_ARGUMENTSENTRY']._loaded_options = None
+    _globals['_TRAININGJOBMETADATA_ARGUMENTSENTRY']._serialized_options = b'8\x01'
     _globals['_TRAININGJOBMETADATA'].fields_by_name['id']._loaded_options = None
     _globals['_TRAININGJOBMETADATA'].fields_by_name['id']._serialized_options = b'\x9a\x84\x9e\x03\x1ebson:"_id" json:"id,omitempty"'
     _globals['_TRAININGJOBMETADATA'].fields_by_name['dataset_id']._loaded_options = None
@@ -80,12 +82,14 @@ if not _descriptor._USE_C_DESCRIPTORS:
     _globals['_TRAININGJOBMETADATA'].fields_by_name['synced_model_id']._serialized_options = b'\x9a\x84\x9e\x03-bson:"synced_model_id" json:"synced_model_id"'
     _globals['_TRAININGJOBMETADATA'].fields_by_name['tags']._loaded_options = None
     _globals['_TRAININGJOBMETADATA'].fields_by_name['tags']._serialized_options = b'\x9a\x84\x9e\x03\x17bson:"tags" json:"tags"'
-    _globals['_MODELTYPE']._serialized_start = 4285
-    _globals['_MODELTYPE']._serialized_end = 4444
-    _globals['_MODELFRAMEWORK']._serialized_start = 4447
-    _globals['_MODELFRAMEWORK']._serialized_end = 4611
-    _globals['_TRAININGSTATUS']._serialized_start = 4614
-    _globals['_TRAININGSTATUS']._serialized_end = 4845
+    _globals['_TRAININGJOBMETADATA'].fields_by_name['arguments']._loaded_options = None
+    _globals['_TRAININGJOBMETADATA'].fields_by_name['arguments']._serialized_options = b'\x9a\x84\x9e\x03!bson:"arguments" json:"arguments"'
+    _globals['_MODELTYPE']._serialized_start = 4478
+    _globals['_MODELTYPE']._serialized_end = 4637
+    _globals['_MODELFRAMEWORK']._serialized_start = 4640
+    _globals['_MODELFRAMEWORK']._serialized_end = 4804
+    _globals['_TRAININGSTATUS']._serialized_start = 4807
+    _globals['_TRAININGSTATUS']._serialized_end = 5038
     _globals['_SUBMITTRAININGJOBREQUEST']._serialized_start = 146
     _globals['_SUBMITTRAININGJOBREQUEST']._serialized_end = 802
     _globals['_SUBMITTRAININGJOBRESPONSE']._serialized_start = 804
@@ -105,20 +109,22 @@ if not _descriptor._USE_C_DESCRIPTORS:
     _globals['_LISTTRAININGJOBSRESPONSE']._serialized_start = 1907
     _globals['_LISTTRAININGJOBSRESPONSE']._serialized_end = 1998
     _globals['_TRAININGJOBMETADATA']._serialized_start = 2001
-    _globals['_TRAININGJOBMETADATA']._serialized_end = 3767
-    _globals['_CANCELTRAININGJOBREQUEST']._serialized_start = 3769
-    _globals['_CANCELTRAININGJOBREQUEST']._serialized_end = 3811
-    _globals['_CANCELTRAININGJOBRESPONSE']._serialized_start = 3813
-    _globals['_CANCELTRAININGJOBRESPONSE']._serialized_end = 3840
-    _globals['_DELETECOMPLETEDTRAININGJOBREQUEST']._serialized_start = 3842
-    _globals['_DELETECOMPLETEDTRAININGJOBREQUEST']._serialized_end = 3893
-    _globals['_DELETECOMPLETEDTRAININGJOBRESPONSE']._serialized_start = 3895
-    _globals['_DELETECOMPLETEDTRAININGJOBRESPONSE']._serialized_end = 3931
-    _globals['_TRAININGJOBLOGENTRY']._serialized_start = 3933
-    _globals['_TRAININGJOBLOGENTRY']._serialized_end = 4050
-    _globals['_GETTRAININGJOBLOGSREQUEST']._serialized_start = 4052
-    _globals['_GETTRAININGJOBLOGSREQUEST']._serialized_end = 4146
-    _globals['_GETTRAININGJOBLOGSRESPONSE']._serialized_start = 4149
-    _globals['_GETTRAININGJOBLOGSRESPONSE']._serialized_end = 4282
-    _globals['_MLTRAININGSERVICE']._serialized_start = 4848
-    _globals['_MLTRAININGSERVICE']._serialized_end = 5759
+    _globals['_TRAININGJOBMETADATA']._serialized_end = 3960
+    _globals['_TRAININGJOBMETADATA_ARGUMENTSENTRY']._serialized_start = 1521
+    _globals['_TRAININGJOBMETADATA_ARGUMENTSENTRY']._serialized_end = 1581
+    _globals['_CANCELTRAININGJOBREQUEST']._serialized_start = 3962
+    _globals['_CANCELTRAININGJOBREQUEST']._serialized_end = 4004
+    _globals['_CANCELTRAININGJOBRESPONSE']._serialized_start = 4006
+    _globals['_CANCELTRAININGJOBRESPONSE']._serialized_end = 4033
+    _globals['_DELETECOMPLETEDTRAININGJOBREQUEST']._serialized_start = 4035
+    _globals['_DELETECOMPLETEDTRAININGJOBREQUEST']._serialized_end = 4086
+    _globals['_DELETECOMPLETEDTRAININGJOBRESPONSE']._serialized_start = 4088
+    _globals['_DELETECOMPLETEDTRAININGJOBRESPONSE']._serialized_end = 4124
+    _globals['_TRAININGJOBLOGENTRY']._serialized_start = 4126
+    _globals['_TRAININGJOBLOGENTRY']._serialized_end = 4243
+    _globals['_GETTRAININGJOBLOGSREQUEST']._serialized_start = 4245
+    _globals['_GETTRAININGJOBLOGSREQUEST']._serialized_end = 4339
+    _globals['_GETTRAININGJOBLOGSRESPONSE']._serialized_start = 4342
+    _globals['_GETTRAININGJOBLOGSRESPONSE']._serialized_end = 4475
+    _globals['_MLTRAININGSERVICE']._serialized_start = 5041
+    _globals['_MLTRAININGSERVICE']._serialized_end = 5952

viam/gen/app/mltraining/v1/ml_training_pb2.pyi

@@ -245,6 +245,20 @@ global___ListTrainingJobsResponse = ListTrainingJobsResponse
 @typing.final
 class TrainingJobMetadata(google.protobuf.message.Message):
     DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    @typing.final
+    class ArgumentsEntry(google.protobuf.message.Message):
+        DESCRIPTOR: google.protobuf.descriptor.Descriptor
+        KEY_FIELD_NUMBER: builtins.int
+        VALUE_FIELD_NUMBER: builtins.int
+        key: builtins.str
+        value: builtins.str
+
+        def __init__(self, *, key: builtins.str=..., value: builtins.str=...) -> None:
+            ...
+
+        def ClearField(self, field_name: typing.Literal['key', b'key', 'value', b'value']) -> None:
+            ...
     ID_FIELD_NUMBER: builtins.int
     DATASET_ID_FIELD_NUMBER: builtins.int
     ORGANIZATION_ID_FIELD_NUMBER: builtins.int
@@ -263,6 +277,7 @@ class TrainingJobMetadata(google.protobuf.message.Message):
     TRAINING_ENDED_FIELD_NUMBER: builtins.int
     SYNCED_MODEL_ID_FIELD_NUMBER: builtins.int
     TAGS_FIELD_NUMBER: builtins.int
+    ARGUMENTS_FIELD_NUMBER: builtins.int
     id: builtins.str
     dataset_id: builtins.str
     organization_id: builtins.str
@@ -300,13 +315,17 @@ class TrainingJobMetadata(google.protobuf.message.Message):
     def tags(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
         ...
 
-    def __init__(self, *, id: builtins.str=..., dataset_id: builtins.str=..., organization_id: builtins.str=..., model_name: builtins.str=..., model_version: builtins.str=..., model_type: global___ModelType.ValueType=..., model_framework: global___ModelFramework.ValueType=..., is_custom_job: builtins.bool=..., registry_item_id: builtins.str=..., registry_item_version: builtins.str=..., status: global___TrainingStatus.ValueType=..., error_status: google.rpc.status_pb2.Status | None=..., created_on: google.protobuf.timestamp_pb2.Timestamp | None=..., last_modified: google.protobuf.timestamp_pb2.Timestamp | None=..., training_started: google.protobuf.timestamp_pb2.Timestamp | None=..., training_ended: google.protobuf.timestamp_pb2.Timestamp | None=..., synced_model_id: builtins.str=..., tags: collections.abc.Iterable[builtins.str] | None=...) -> None:
+    @property
+    def arguments(self) -> google.protobuf.internal.containers.ScalarMap[builtins.str, builtins.str]:
+        ...
+
+    def __init__(self, *, id: builtins.str=..., dataset_id: builtins.str=..., organization_id: builtins.str=..., model_name: builtins.str=..., model_version: builtins.str=..., model_type: global___ModelType.ValueType=..., model_framework: global___ModelFramework.ValueType=..., is_custom_job: builtins.bool=..., registry_item_id: builtins.str=..., registry_item_version: builtins.str=..., status: global___TrainingStatus.ValueType=..., error_status: google.rpc.status_pb2.Status | None=..., created_on: google.protobuf.timestamp_pb2.Timestamp | None=..., last_modified: google.protobuf.timestamp_pb2.Timestamp | None=..., training_started: google.protobuf.timestamp_pb2.Timestamp | None=..., training_ended: google.protobuf.timestamp_pb2.Timestamp | None=..., synced_model_id: builtins.str=..., tags: collections.abc.Iterable[builtins.str] | None=..., arguments: collections.abc.Mapping[builtins.str, builtins.str] | None=...) -> None:
         ...
 
     def HasField(self, field_name: typing.Literal['created_on', b'created_on', 'error_status', b'error_status', 'last_modified', b'last_modified', 'training_ended', b'training_ended', 'training_started', b'training_started']) -> builtins.bool:
         ...
 
-    def ClearField(self, field_name: typing.Literal['created_on', b'created_on', 'dataset_id', b'dataset_id', 'error_status', b'error_status', 'id', b'id', 'is_custom_job', b'is_custom_job', 'last_modified', b'last_modified', 'model_framework', b'model_framework', 'model_name', b'model_name', 'model_type', b'model_type', 'model_version', b'model_version', 'organization_id', b'organization_id', 'registry_item_id', b'registry_item_id', 'registry_item_version', b'registry_item_version', 'status', b'status', 'synced_model_id', b'synced_model_id', 'tags', b'tags', 'training_ended', b'training_ended', 'training_started', b'training_started']) -> None:
+    def ClearField(self, field_name: typing.Literal['arguments', b'arguments', 'created_on', b'created_on', 'dataset_id', b'dataset_id', 'error_status', b'error_status', 'id', b'id', 'is_custom_job', b'is_custom_job', 'last_modified', b'last_modified', 'model_framework', b'model_framework', 'model_name', b'model_name', 'model_type', b'model_type', 'model_version', b'model_version', 'organization_id', b'organization_id', 'registry_item_id', b'registry_item_id', 'registry_item_version', b'registry_item_version', 'status', b'status', 'synced_model_id', b'synced_model_id', 'tags', b'tags', 'training_ended', b'training_ended', 'training_started', b'training_started']) -> None:
         ...
 global___TrainingJobMetadata = TrainingJobMetadata
 

viam/module/module.py

@@ -3,6 +3,7 @@ import io
 import logging as pylogging
 import os
 import sys
+from collections.abc import Iterable
 from inspect import iscoroutinefunction
 from threading import Lock
 from typing import List, Mapping, Optional, Sequence, Tuple
@@ -275,7 +276,28 @@ class Module:
         model = Model.from_string(config.model)
         validator = Registry.lookup_validator(api, model)
         try:
-            dependencies = validator(config)
-            return ValidateConfigResponse(dependencies=dependencies)
+            # backwards compatibility. Support both ([], []) or [] with deprecation warning.
+            # If user's validate returns [str], it will be treated as required dependencies only.
+            # Incorect formats, e.g. int, will raise ValidationError.
+            _validator_return_test = validator(config)
+            if not (isinstance(_validator_return_test, tuple) and len(_validator_return_test) == 2):
+                msg = f"Your validate function {validator.__name__} did not return \
+                        type tuple[Sequence[str], Sequence[str]]. Got {_validator_return_test}."
+                self.logger.warning(msg)
+                if (isinstance(_validator_return_test, Iterable) and not isinstance(_validator_return_test, str)) and all(
+                    isinstance(e, str)
+                    for e in _validator_return_test  # type: ignore
+                ):
+                    self.logger.warning(
+                        f"Detected deprecated validate function signature. \
+                                        Treating all dependencies {_validator_return_test} as required dependencies. \
+                                        Please update to new signature Tuple[Sequence[str], Sequence[str]] soon."
+                    )
+                    return ValidateConfigResponse(dependencies=_validator_return_test)
+                else:
+                    raise ValidationError(msg)
+
+            dependencies, optional_dependencies = _validator_return_test
+            return ValidateConfigResponse(dependencies=dependencies, optional_dependencies=optional_dependencies)
         except Exception as e:
             raise ValidationError(f"{type(Exception)}: {e}").grpc_error

viam/resource/easy_resource.py

@@ -1,7 +1,7 @@
 import inspect
 import re
 from abc import ABCMeta
-from typing import Callable, ClassVar, Mapping, Sequence, Union
+from typing import Callable, ClassVar, Mapping, Sequence, Tuple, Union
 
 from viam.proto.app.robot import ComponentConfig
 from viam.proto.common import ResourceName
@@ -122,7 +122,7 @@ class EasyResource:
         return self
 
     @classmethod
-    def validate_config(cls, config: ComponentConfig) -> Sequence[str]:
+    def validate_config(cls, config: ComponentConfig) -> Tuple[Sequence[str], Sequence[str]]:
         """This method allows you to validate the configuration object received from the machine,
         as well as to return any implicit dependencies based on that `config`.
 
@@ -130,9 +130,9 @@ class EasyResource:
             config (ComponentConfig): The configuration for this resource
 
         Returns:
-            Sequence[str]: A list of implicit dependencies
+            Tuple[Sequence[str], Sequence[str]]: One list of required implicit dependencies and one of optional deps.
         """
-        return []
+        return [], []
 
     @classmethod
     def register(cls):

viam/resource/registry.py

@@ -27,7 +27,7 @@ class ResourceCreatorRegistration:
     """A function that can create a resource given a mapping of dependencies (``ResourceName`` to ``ResourceBase``
     """
 
-    validator: "Validator" = lambda x: []
+    validator: "Validator" = lambda x: ([], [])
     """A function that can validate a resource and return implicit dependencies.
 
     If called without a validator function, default to a function returning an empty Sequence
@@ -170,7 +170,7 @@ class Registry:
         try:
             return cls._RESOURCES[f"{api}/{model}"].validator
         except AttributeError:
-            return lambda x: []
+            return lambda x: ([], [])
         except KeyError:
             raise ResourceNotFoundError(api.resource_type, api.resource_subtype)
 

viam/resource/types.py

@@ -1,6 +1,6 @@
 import re
 import sys
-from typing import TYPE_CHECKING, Callable, ClassVar, Mapping, Optional, Protocol, Sequence, runtime_checkable
+from typing import TYPE_CHECKING, Callable, ClassVar, Mapping, Optional, Protocol, Sequence, Tuple, runtime_checkable
 
 if sys.version_info >= (3, 10):
     from typing import TypeAlias
@@ -203,7 +203,7 @@ def resource_name_from_string(string: str) -> ResourceName:
 
 
 ResourceCreator: TypeAlias = Callable[[ComponentConfig, Mapping[ResourceName, "ResourceBase"]], "ResourceBase"]
-Validator: TypeAlias = Callable[[ComponentConfig], Sequence[str]]
+Validator: TypeAlias = Callable[[ComponentConfig], Tuple[Sequence[str], Sequence[str]]]
 
 
 @runtime_checkable

viam/version_metadata.py

@@ -1,4 +1,4 @@
-__version__ = "0.46.0"
+__version__ = "0.47.0"
 
-API_VERSION = "v0.1.436"
+API_VERSION = "v0.1.437"
 SDK_VERSION = __version__

{viam_sdk-0.46.0.dist-info → viam_sdk-0.47.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: viam-sdk
-Version: 0.46.0
+Version: 0.47.0
 Summary: Viam Robotics Python SDK
 Project-URL: Homepage, https://www.viam.com
 Project-URL: Documentation, https://python.viam.dev

{viam_sdk-0.46.0.dist-info → viam_sdk-0.47.0.dist-info}/RECORD

@@ -7,12 +7,12 @@ viam/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/sessions_client.py,sha256=E4ThFCK1HCX_iAvEymvCdJ-H0ZlouzgoIwIE_nywfqc,9414
 viam/streams.py,sha256=VoM8FSMuGZmv4RPDHQy4FfHvJq36r4NY--gkQoaFkzs,1042
 viam/utils.py,sha256=xz7qb6bM-2qzOSQSsYHBheBidMbUAlQ2dHCi_GyPFnk,13579
-viam/version_metadata.py,sha256=T599kf8kpNHMzUitay_erZYU8IGeGXsidM0U2q8MdAQ,75
+viam/version_metadata.py,sha256=eukUREKq_2FPu6RinvsfKUpNmEuHXG_eSHPj7ptyrhM,75
 viam/app/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/app/_logs.py,sha256=hWxRELRJCux-fQIQtDwztD3odjkBm7Vo8HUQ7XGICek,806
 viam/app/app_client.py,sha256=kTQOyrN1LTRDEcozTcwAK-IDzmZ_YL0cCfbmVWKLiJ0,114986
 viam/app/billing_client.py,sha256=eZ0KOpKOVEcqPxzAhUfn3XXJdhwAPVv_jPbIg1sc0uk,5767
-viam/app/data_client.py,sha256=jnTpo1us5RZuhdkk6x6PJzPH6mpmz9OpQYkG5aWx_Ew,76367
+viam/app/data_client.py,sha256=f2kcr9bLWWbobwfjV4VzbNowPn9Io--n3Xfh5TM98sE,87278
 viam/app/ml_training_client.py,sha256=qcnVrYETdIRusfHLpIOG8Q-QmqDIU43dKmv0pTJ5mA8,9269
 viam/app/provisioning_client.py,sha256=Irh3waRpggZe-pPyrgk4D9fAQ48JjDE5spYyIFOJc3Y,3536
 viam/app/viam_client.py,sha256=fJYa79_WwHFRKcDBzJWzV7Hgo0U1CBwoaDuW8vhkWLU,10820
@@ -130,8 +130,8 @@ viam/gen/app/mlinference/v1/ml_inference_pb2.pyi,sha256=F7Rd9y3rZoM3KZ114xxF8Klb
 viam/gen/app/mltraining/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/mltraining/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/mltraining/v1/ml_training_grpc.py,sha256=pNG71h3FqXQBHsfEgRA8GOm_MxKjN-4lAjkDJINjrJU,8047
-viam/gen/app/mltraining/v1/ml_training_pb2.py,sha256=8_rk9-JamJUfEAhS64AG1_vp8yUxu6PoC0jwk1LdIno,19627
-viam/gen/app/mltraining/v1/ml_training_pb2.pyi,sha256=1boVJgPntKoEof4FqfWoqL8DrtigYfUQFl1BM-oOZgQ,17754
+viam/gen/app/mltraining/v1/ml_training_pb2.py,sha256=blCC52-wPG9SaJBfkBSTf5hr7NIKdw6PT5yJKYjJF2M,20456
+viam/gen/app/mltraining/v1/ml_training_pb2.pyi,sha256=hCmnEVRJvQIATIguh--GC4-xjv2gGVE_bUoarM3QHxc,18517
 viam/gen/app/packages/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/packages/v1/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/gen/app/packages/v1/packages_grpc.py,sha256=r_wO6tv0MEzVhRIA2R6ryJWCRkxzW6IUatpr8tkMJgI,4260
@@ -360,7 +360,7 @@ viam/media/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,
 viam/media/utils/pil/__init__.py,sha256=b8jSuxOzm1o9CMaJ186V5dMufw4_jXZG5g2U_EJ3bKQ,1466
 viam/media/utils/pil/viam_rgba_plugin.py,sha256=3vIevKK4pnB9EJV_n7bho3XEAzFyuMb3uRTedsvizxI,2563
 viam/module/__init__.py,sha256=BV5kJ-qjlGJzlHdTyR2fZGblymflEcuJU2bFVqPjyeU,56
-viam/module/module.py,sha256=p2uR5uSdRn8Wl5WoSouwYzxsO4zZ0D4IjG5sbRi4CLc,11907
+viam/module/module.py,sha256=u1o-wRO-HSmEfCDFGpVCTXu13jqED4XhQsEwKm_uPfs,13436
 viam/module/service.py,sha256=QdMVFXWI1aylZOdnSeDUu-LuZ8qIWEs9QihMDyCqnjg,2383
 viam/module/types.py,sha256=SLcSFN99lon-9q0eqXt5vTELS1HaAyROh27XIzX2LlU,793
 viam/proto/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -424,12 +424,12 @@ viam/proto/stream/__init__.py,sha256=ZTjtPqIsjEiH5AkXj2yqgJesAkTx2Z4iJzKRZKZg7Bs
 viam/proto/tagger/__init__.py,sha256=8qjke19IIdi8HlxjlE9ntAS7GTPzR2SVla8lhslZNTs,64
 viam/resource/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/resource/base.py,sha256=3HGO5KQ6kgEeFlsyJWYr2Nlem7BYERPrYXyNyvydP2w,3694
-viam/resource/easy_resource.py,sha256=8xQ_ZHfGflgszX9yf9rsiK1dEUo4F0VL14g7I20B1_U,5529
+viam/resource/easy_resource.py,sha256=S8gVJi1FB0XiTrNpmGJC8O8CQLMM9ycBBrOyqz1rLWw,5621
 viam/resource/manager.py,sha256=aCJs-a0fHqvV-suiYkIn3CKUnvj-qgsI2FHK5CKj3M0,4913
-viam/resource/registry.py,sha256=Xsu8fTbnNdL0lPX0dTfwtnrK_cRWG-5SUIIwhF4k7so,7355
+viam/resource/registry.py,sha256=XAiJsf3y0C5VnJl-Iy77CqMzFdq1RBLOXqSiFXZ7QmE,7367
 viam/resource/rpc_client_base.py,sha256=2OqcRHZLShuJqcmKimzU4Wr3VuHGNc8fzV4HbtIOAXU,2054
 viam/resource/rpc_service_base.py,sha256=f2vGY4mfcdOPCgBVk7EVFKDIwGAPxu66e0XJ55VIen8,1612
-viam/resource/types.py,sha256=E1eqzJR8HzkDWW6-lM2fAT86wOUe6akD_FBAJ21Mg7M,6710
+viam/resource/types.py,sha256=8r2RjTQN9hOg6Po9XHMgj7xfR5kTsFr9_KNNn_62qGk,6739
 viam/robot/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 viam/robot/client.py,sha256=eLxP_lpiQq7t8bRZCIzWFWMr83nCfqrA3Lf8H7CtzIo,33590
 viam/robot/service.py,sha256=4kn2px4YRkM7083CNgs01FO7xPRe7nhtuDst3IMXjo8,2764
@@ -471,7 +471,7 @@ viam/services/vision/__init__.py,sha256=g4Dnz6BFgVZpvE6j6sNwxAc2baZfAKLA6XS2GaGg
 viam/services/vision/client.py,sha256=uaFMlYwKE5N_Qp803aFGfk8k6KCWPKNwUxyV_fnlBp4,7776
 viam/services/vision/service.py,sha256=NWV3yY1ZyEbl4rrp28CtX9n-uIgyxSQbbKJTeoIVjCg,6942
 viam/services/vision/vision.py,sha256=MrQsTarahwGMEmqWX4ODCJT5wLOGHXNEuEyTQgOvsg4,12527
-viam_sdk-0.46.0.dist-info/METADATA,sha256=OPy6rDGrzFofYepwBb9INQ-Wx7dsyB_3Af2g9ZjzEhA,10310
-viam_sdk-0.46.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-viam_sdk-0.46.0.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358
-viam_sdk-0.46.0.dist-info/RECORD,,
+viam_sdk-0.47.0.dist-info/METADATA,sha256=t1rIDXHknEldULZV8OjlcVSeG1IRqk5vEDrgpcqmzIs,10310
+viam_sdk-0.47.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+viam_sdk-0.47.0.dist-info/licenses/LICENSE,sha256=yVuuHRzgI17MzTVgt3LsHvuX80innw--CmNPDCzO_iw,11358
+viam_sdk-0.47.0.dist-info/RECORD,,