modal 1.1.0__py3-none-any.whl → 1.1.1__py3-none-any.whl

modal_proto/api.proto

@@ -240,6 +240,13 @@ enum SystemErrorCode {
   SYSTEM_ERROR_CODE_NOSPC = 28;         // ENOSPC: No space left on device
 }
 
+enum TaskSnapshotBehavior {
+  TASK_SNAPSHOT_BEHAVIOR_UNSPECIFIED = 0;
+  TASK_SNAPSHOT_BEHAVIOR_SNAPSHOT = 1;
+  TASK_SNAPSHOT_BEHAVIOR_RESTORE = 2;
+  TASK_SNAPSHOT_BEHAVIOR_NONE = 3;
+}
+
 enum TaskState {
   TASK_STATE_UNSPECIFIED = 0;
   TASK_STATE_CREATED = 6;
@@ -611,7 +618,7 @@ message AttemptStartRequest {
 
 message AttemptStartResponse {
   string attempt_token = 1;
-  FunctionRetryPolicy retry_policy = 2;
+  FunctionRetryPolicy retry_policy = 2; // TODO(ben-okeefe) TODO(nathan): Not currently used
 }
 
 message AuthTokenGetRequest {
@@ -858,6 +865,7 @@ message ContainerArguments {  // This is used to pass data from the worker to th
   string environment_name = 13;
   optional string checkpoint_id = 14;
   AppLayout app_layout = 15;
+  string input_plane_server_url = 16;
 }
 
 message ContainerCheckpointRequest {
@@ -1035,6 +1043,13 @@ message ContainerStopRequest {
 message ContainerStopResponse {
 }
 
+
+message CreationInfo {
+  // This message is used in metadata for resource objects like Dict, Queue, Volume, etc.
+  double created_at = 1;  // Timestamp of resource creation
+  string created_by = 2;  // User name or service name
+}
+
 message CustomDomainConfig {
   string name = 1;
 }
@@ -1099,6 +1114,7 @@ message DictGetOrCreateRequest {
 
 message DictGetOrCreateResponse {
   string dict_id = 1;
+  DictMetadata metadata = 2;
 }
 
 message DictGetRequest {
@@ -1125,15 +1141,24 @@ message DictLenResponse {
 
 message DictListRequest {
   string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message DictListResponse {
   message DictInfo {
     string name = 1;
-    double created_at = 2;
+    double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
+    string dict_id = 3;
+    DictMetadata metadata = 4;
   }
 
   repeated DictInfo dicts = 1;
+  string environment_name = 2;
+}
+
+message DictMetadata {
+  string name = 1;
+  CreationInfo creation_info = 2;
 }
 
 message DictPopRequest {
@@ -1464,6 +1489,7 @@ message FunctionBindParamsRequest {
   bytes serialized_params = 2;
   FunctionOptions function_options = 3;
   string environment_name = 4;
+  string auth_secret = 5; // Only used for the input plane.
 }
 
 message FunctionBindParamsResponse {
@@ -1487,7 +1513,7 @@ message FunctionCallCancelRequest {
 message FunctionCallGetDataRequest {
   string function_call_id = 1;
   uint64 last_index = 2;
-  reserved 3; // attempt_token
+  optional string attempt_token = 3;
 }
 
 message FunctionCallInfo {
@@ -1651,6 +1677,7 @@ message FunctionGetInputsItem {
   string function_call_id = 5;
   FunctionCallInvocationType function_call_invocation_type = 6;
   uint32 retry_count = 7;
+  optional int32 function_map_idx = 8; // intercepted and only used by the worker.
 }
 
 message FunctionGetInputsRequest {
@@ -1816,7 +1843,8 @@ message FunctionPutInputsItem {
   int32 idx = 1;
   FunctionInput input = 2;
   bool r2_failed = 3;
-  uint64 r2_latency_ms = 4;
+  reserved 4; // r2_latency_ms
+  uint64 r2_throughput_bytes_s = 5;
 }
 
 message FunctionPutInputsRequest {
@@ -1842,6 +1870,8 @@ message FunctionPutOutputsItem {
   double output_created_at = 4;
   DataFormat data_format = 7; // for result.data_oneof
   uint32 retry_count = 8;
+  string function_call_id = 9; // injected by the worker 
+  optional int32 function_map_idx = 10; // injected by the worker 
 }
 
 message FunctionPutOutputsRequest {
@@ -2069,6 +2099,53 @@ message InputInfo {
   bool task_first_input = 7;
 }
 
+message ListPagination {
+  int32 max_objects = 1;
+  double created_before = 2;
+}
+
+message MapAwaitRequest {
+  string function_call_id = 1;
+  string last_entry_id = 2;
+  double requested_at = 3; // Used for waypoints.
+  float timeout = 4;
+}
+
+message MapAwaitResponse {
+  repeated FunctionGetOutputsItem outputs = 1;
+  string last_entry_id = 2;
+}
+
+message MapCheckInputsRequest {
+  string last_entry_id = 1;
+  float timeout = 2;
+  repeated string attempt_tokens = 3;  
+}
+
+message MapCheckInputsResponse {
+  repeated bool lost = 1;
+}
+
+message MapStartOrContinueItem {
+  FunctionPutInputsItem input = 1;
+  optional string attempt_token = 2; // None if this is a fresh input, otherwise it is the attempt token for a retry.
+}
+
+message MapStartOrContinueRequest {
+  string function_id = 1;
+  string parent_input_id = 2;
+  optional string function_call_id = 3; // This is given iff this is a map continue request.
+  repeated MapStartOrContinueItem items = 4;
+}
+
+message MapStartOrContinueResponse {
+  string function_id = 1;
+  string function_call_id = 2;
+  uint32 max_inputs_outstanding = 3;
+  repeated string attempt_tokens = 4;
+  FunctionRetryPolicy retry_policy = 5; // TODO(ben-okeefe): Not currently used
+}
+
 message MethodDefinition {
   string function_name = 1;
   Function.FunctionType function_type = 2;
@@ -2340,6 +2417,7 @@ message QueueGetOrCreateRequest {
 
 message QueueGetOrCreateResponse {
   string queue_id = 1;
+  QueueMetadata metadata = 2;
 }
 
 message QueueGetRequest {
@@ -2374,19 +2452,27 @@ message QueueLenResponse {
 
 message QueueListRequest {
   string environment_name = 1;
-  // Allow client to report a bounded total size to reduce the number of partitions that need to be checked
-  int32 total_size_limit = 2;
+  int32 total_size_limit = 2;  // Limit on "number of partitions" reported, since checking them is costly
+  ListPagination pagination = 3;
 }
 
 message QueueListResponse {
   message QueueInfo {
     string name = 1;
-    double created_at = 2;
+    double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
     int32 num_partitions = 3;
     int32 total_size = 4;
+    string queue_id = 5;
+    QueueMetadata metadata = 6;
   }
 
   repeated QueueInfo queues = 1;
+  string environment_name = 2;
+}
+
+message QueueMetadata {
+  string name = 1;
+  CreationInfo creation_info = 2;
 }
 
 message QueueNextItemsRequest {
@@ -2520,6 +2606,9 @@ message Sandbox {
 
   // If set, the sandbox will be created with a name.
   optional string name = 30;
+
+  // Experimental options
+  map<string, bool> experimental_options = 31;
 }
 
 message SandboxCreateRequest {
@@ -2624,6 +2713,19 @@ message SandboxRestoreResponse {
   string sandbox_id = 1;
 }
 
+message SandboxSnapshotFsAsyncGetRequest {
+  string image_id = 1;
+  float timeout = 2;
+}
+
+message SandboxSnapshotFsAsyncRequest {
+  string sandbox_id = 1;
+}
+
+message SandboxSnapshotFsAsyncResponse {
+  string image_id = 1;
+}
+
 message SandboxSnapshotFsRequest {
   string sandbox_id = 1;
   float timeout = 2;
@@ -2761,25 +2863,35 @@ message SecretGetOrCreateRequest {
 
 message SecretGetOrCreateResponse {
   string secret_id = 1;
+  SecretMetadata metadata = 2;
 }
 
 message SecretListItem {
   string label = 1;
-  double created_at = 2;
+  double created_at = 2;  // Superseded by metadata, used by clients up to 1.1.1
   double last_used_at = 3;
-  string environment_name = 4;
+  string environment_name = 4;  // Unused by client
   string secret_id = 5;
+  SecretMetadata metadata = 6;
 }
 
 message SecretListRequest {
-  string environment_name = 1; // leaving empty will assume a singular environment
+  string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message SecretListResponse {
   repeated SecretListItem items = 1;
-  string environment_name = 2; // the environment that was listed (useful when relying on "default" logic)
+  string environment_name = 2;
 }
 
+message SecretMetadata {
+  string name = 1;
+  CreationInfo creation_info = 2;
+}
+
+// SharedVolume in the backend corresponds to NetworkFileSystem in the current API
+
 message SharedVolumeDeleteRequest {
   string shared_volume_id = 1;
 }
@@ -2878,8 +2990,9 @@ message TaskClusterHelloRequest {
 message TaskClusterHelloResponse {
   string cluster_id = 1;
   uint32 cluster_rank = 2;
-  // All IP addresses in cluster, ordered by cluster rank
+  // All IPv6 addresses in cluster, ordered by cluster rank
   repeated string container_ips = 3;
+  repeated string container_ipv4_ips = 4;
 }
 
 message TaskCurrentInputsResponse {
@@ -2894,6 +3007,8 @@ message TaskInfo {
   double enqueued_at = 5;
   string gpu_type = 6;
   string sandbox_id = 7;
+  TaskSnapshotBehavior snapshot_behavior = 8;
+  GPUConfig gpu_config = 9;
 }
 
 message TaskListRequest {
@@ -3087,7 +3202,7 @@ message VolumeGetOrCreateRequest {
 
 message VolumeGetOrCreateResponse {
   string volume_id = 1;
-  VolumeFsVersion version = 2;
+  VolumeFsVersion version = 2;  // Not used directly; version is part of the metadata
   VolumeMetadata metadata = 3;
 }
 
@@ -3120,11 +3235,13 @@ message VolumeListFilesResponse {
 message VolumeListItem {
   string label = 1;  // app name of object entity app
   string volume_id = 2;
-  double created_at = 3;
+  double created_at = 3;  // Superseded by metadata, used by clients up to 1.1.1
+  VolumeMetadata metadata = 4;
 }
 
 message VolumeListRequest {
   string environment_name = 1;
+  ListPagination pagination = 2;
 }
 
 message VolumeListResponse {
@@ -3134,6 +3251,8 @@ message VolumeListResponse {
 
 message VolumeMetadata {
   VolumeFsVersion version = 1;
+  string name = 2;
+  CreationInfo creation_info = 3;
 }
 
 message VolumeMount {
@@ -3393,6 +3512,11 @@ service ModalClient {
   rpc ImageGetOrCreate(ImageGetOrCreateRequest) returns (ImageGetOrCreateResponse);
   rpc ImageJoinStreaming(ImageJoinStreamingRequest) returns (stream ImageJoinStreamingResponse);
 
+  // Input Plane Map
+  rpc MapAwait(MapAwaitRequest) returns (MapAwaitResponse);
+  rpc MapCheckInputs(MapCheckInputsRequest) returns (MapCheckInputsResponse);
+  rpc MapStartOrContinue(MapStartOrContinueRequest) returns (MapStartOrContinueResponse);
+
   // Mounts
   rpc MountGetOrCreate(MountGetOrCreateRequest) returns (MountGetOrCreateResponse);
   rpc MountPutFile(MountPutFileRequest) returns (MountPutFileResponse);
@@ -3431,6 +3555,8 @@ service ModalClient {
   rpc SandboxRestore(SandboxRestoreRequest) returns (SandboxRestoreResponse);
   rpc SandboxSnapshot(SandboxSnapshotRequest) returns (SandboxSnapshotResponse);
   rpc SandboxSnapshotFs(SandboxSnapshotFsRequest) returns (SandboxSnapshotFsResponse);
+  rpc SandboxSnapshotFsAsync(SandboxSnapshotFsAsyncRequest) returns (SandboxSnapshotFsAsyncResponse);
+  rpc SandboxSnapshotFsAsyncGet(SandboxSnapshotFsAsyncGetRequest) returns (SandboxSnapshotFsResponse);
   rpc SandboxSnapshotGet(SandboxSnapshotGetRequest) returns (SandboxSnapshotGetResponse);
   rpc SandboxSnapshotWait(SandboxSnapshotWaitRequest) returns (SandboxSnapshotWaitResponse);
   rpc SandboxStdinWrite(SandboxStdinWriteRequest) returns (SandboxStdinWriteResponse);

modal_proto/api_grpc.py

@@ -362,6 +362,18 @@ class ModalClientBase(abc.ABC):
     async def ImageJoinStreaming(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.ImageJoinStreamingRequest, modal_proto.api_pb2.ImageJoinStreamingResponse]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def MapAwait(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.MapAwaitRequest, modal_proto.api_pb2.MapAwaitResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def MapCheckInputs(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.MapCheckInputsRequest, modal_proto.api_pb2.MapCheckInputsResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def MapStartOrContinue(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.MapStartOrContinueRequest, modal_proto.api_pb2.MapStartOrContinueResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def MountGetOrCreate(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.MountGetOrCreateRequest, modal_proto.api_pb2.MountGetOrCreateResponse]') -> None:
         pass
@@ -478,6 +490,14 @@ class ModalClientBase(abc.ABC):
     async def SandboxSnapshotFs(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxSnapshotFsRequest, modal_proto.api_pb2.SandboxSnapshotFsResponse]') -> None:
         pass
 
+    @abc.abstractmethod
+    async def SandboxSnapshotFsAsync(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxSnapshotFsAsyncRequest, modal_proto.api_pb2.SandboxSnapshotFsAsyncResponse]') -> None:
+        pass
+
+    @abc.abstractmethod
+    async def SandboxSnapshotFsAsyncGet(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxSnapshotFsAsyncGetRequest, modal_proto.api_pb2.SandboxSnapshotFsResponse]') -> None:
+        pass
+
     @abc.abstractmethod
     async def SandboxSnapshotGet(self, stream: 'grpclib.server.Stream[modal_proto.api_pb2.SandboxSnapshotGetRequest, modal_proto.api_pb2.SandboxSnapshotGetResponse]') -> None:
         pass
@@ -1172,6 +1192,24 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.ImageJoinStreamingRequest,
                 modal_proto.api_pb2.ImageJoinStreamingResponse,
             ),
+            '/modal.client.ModalClient/MapAwait': grpclib.const.Handler(
+                self.MapAwait,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.MapAwaitRequest,
+                modal_proto.api_pb2.MapAwaitResponse,
+            ),
+            '/modal.client.ModalClient/MapCheckInputs': grpclib.const.Handler(
+                self.MapCheckInputs,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.MapCheckInputsRequest,
+                modal_proto.api_pb2.MapCheckInputsResponse,
+            ),
+            '/modal.client.ModalClient/MapStartOrContinue': grpclib.const.Handler(
+                self.MapStartOrContinue,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.MapStartOrContinueRequest,
+                modal_proto.api_pb2.MapStartOrContinueResponse,
+            ),
             '/modal.client.ModalClient/MountGetOrCreate': grpclib.const.Handler(
                 self.MountGetOrCreate,
                 grpclib.const.Cardinality.UNARY_UNARY,
@@ -1346,6 +1384,18 @@ class ModalClientBase(abc.ABC):
                 modal_proto.api_pb2.SandboxSnapshotFsRequest,
                 modal_proto.api_pb2.SandboxSnapshotFsResponse,
             ),
+            '/modal.client.ModalClient/SandboxSnapshotFsAsync': grpclib.const.Handler(
+                self.SandboxSnapshotFsAsync,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.SandboxSnapshotFsAsyncRequest,
+                modal_proto.api_pb2.SandboxSnapshotFsAsyncResponse,
+            ),
+            '/modal.client.ModalClient/SandboxSnapshotFsAsyncGet': grpclib.const.Handler(
+                self.SandboxSnapshotFsAsyncGet,
+                grpclib.const.Cardinality.UNARY_UNARY,
+                modal_proto.api_pb2.SandboxSnapshotFsAsyncGetRequest,
+                modal_proto.api_pb2.SandboxSnapshotFsResponse,
+            ),
             '/modal.client.ModalClient/SandboxSnapshotGet': grpclib.const.Handler(
                 self.SandboxSnapshotGet,
                 grpclib.const.Cardinality.UNARY_UNARY,
@@ -2132,6 +2182,24 @@ class ModalClientStub:
             modal_proto.api_pb2.ImageJoinStreamingRequest,
             modal_proto.api_pb2.ImageJoinStreamingResponse,
         )
+        self.MapAwait = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/MapAwait',
+            modal_proto.api_pb2.MapAwaitRequest,
+            modal_proto.api_pb2.MapAwaitResponse,
+        )
+        self.MapCheckInputs = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/MapCheckInputs',
+            modal_proto.api_pb2.MapCheckInputsRequest,
+            modal_proto.api_pb2.MapCheckInputsResponse,
+        )
+        self.MapStartOrContinue = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/MapStartOrContinue',
+            modal_proto.api_pb2.MapStartOrContinueRequest,
+            modal_proto.api_pb2.MapStartOrContinueResponse,
+        )
         self.MountGetOrCreate = grpclib.client.UnaryUnaryMethod(
             channel,
             '/modal.client.ModalClient/MountGetOrCreate',
@@ -2306,6 +2374,18 @@ class ModalClientStub:
             modal_proto.api_pb2.SandboxSnapshotFsRequest,
             modal_proto.api_pb2.SandboxSnapshotFsResponse,
         )
+        self.SandboxSnapshotFsAsync = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/SandboxSnapshotFsAsync',
+            modal_proto.api_pb2.SandboxSnapshotFsAsyncRequest,
+            modal_proto.api_pb2.SandboxSnapshotFsAsyncResponse,
+        )
+        self.SandboxSnapshotFsAsyncGet = grpclib.client.UnaryUnaryMethod(
+            channel,
+            '/modal.client.ModalClient/SandboxSnapshotFsAsyncGet',
+            modal_proto.api_pb2.SandboxSnapshotFsAsyncGetRequest,
+            modal_proto.api_pb2.SandboxSnapshotFsResponse,
+        )
         self.SandboxSnapshotGet = grpclib.client.UnaryUnaryMethod(
             channel,
             '/modal.client.ModalClient/SandboxSnapshotGet',