sequence-base 0.3.0__py3-none-any.whl

sequence_base/schemas/DeploymentRequest.json

@@ -0,0 +1,467 @@
+{
+  "$defs": {
+    "ActionContract": {
+      "additionalProperties": false,
+      "description": "The fixed obs→ActionChunk contract a policy promises. Every field required; `action_space` reuses\ncontract 4's enum (not a free string). Each ActionChunk echoes exactly these invariants back.",
+      "properties": {
+        "action_dim": {
+          "title": "Action Dim",
+          "type": "integer"
+        },
+        "action_space": {
+          "$ref": "#/$defs/ActionSpace"
+        },
+        "control_frequency_hz": {
+          "title": "Control Frequency Hz",
+          "type": "number"
+        },
+        "robot": {
+          "title": "Robot",
+          "type": "string"
+        }
+      },
+      "required": [
+        "robot",
+        "action_space",
+        "action_dim",
+        "control_frequency_hz"
+      ],
+      "title": "ActionContract",
+      "type": "object"
+    },
+    "ActionSpace": {
+      "description": "Must be explicit: the same floats mean opposite things across spaces — executing an absolute\njoint position as a delta flings the arm into its limit stops. {schema.py:124}",
+      "enum": [
+        "joint_absolute",
+        "joint_delta",
+        "ee_absolute",
+        "ee_delta"
+      ],
+      "title": "ActionSpace",
+      "type": "string"
+    },
+    "Autoscaler": {
+      "additionalProperties": false,
+      "description": "= Modal AutoscalerSettings. Defaults mirror PolicySpec so an omitted block scale-to-zeroes.",
+      "properties": {
+        "buffer_containers": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Buffer Containers"
+        },
+        "max_containers": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Max Containers"
+        },
+        "min_containers": {
+          "default": 0,
+          "title": "Min Containers",
+          "type": "integer"
+        },
+        "scaledown_window": {
+          "default": 600,
+          "title": "Scaledown Window",
+          "type": "integer"
+        }
+      },
+      "title": "Autoscaler",
+      "type": "object"
+    },
+    "CodeBundle": {
+      "additionalProperties": false,
+      "description": "The policy's own source, shipped with the deploy so the worker can import `policy.handler_ref`\n(what Modal's automount does for the entrypoint module). A gzip'd tar of the handler's top-level module\nor package, base64 on the wire, with the sha256 of the decoded bytes so a truncated or altered upload\nis refused at the edge instead of failing as an ImportError on a GPU.",
+      "properties": {
+        "data": {
+          "title": "Data",
+          "type": "string"
+        },
+        "format": {
+          "const": "tar.gz",
+          "default": "tar.gz",
+          "title": "Format",
+          "type": "string"
+        },
+        "sha256": {
+          "title": "Sha256",
+          "type": "string"
+        }
+      },
+      "required": [
+        "data",
+        "sha256"
+      ],
+      "title": "CodeBundle",
+      "type": "object"
+    },
+    "Concurrency": {
+      "additionalProperties": false,
+      "description": "= Modal max/target_concurrent_inputs. Both required.",
+      "properties": {
+        "max_inputs": {
+          "title": "Max Inputs",
+          "type": "integer"
+        },
+        "target_inputs": {
+          "title": "Target Inputs",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "max_inputs",
+        "target_inputs"
+      ],
+      "title": "Concurrency",
+      "type": "object"
+    },
+    "DeploymentPolicy": {
+      "additionalProperties": false,
+      "description": "The policy block of the deployments body. `handler_ref` and `action` are required; `action` is the\nfixed obs→ActionChunk contract, not a bare dict.\n\n`secrets` carries the policy's declared secret BUNDLES BY NAME ONLY (list[SecretRef]) — the gateway\nvalidates each name exists and belongs to the deployer at submit time (accounts ⑦ / S3 goal 14), and the\nworker bootstrap fetches the matching env group by name. A secret VALUE never travels here: SecretRef is\nname-only, so this field cannot carry one (S3 goal 15). Defaults to `[]` so a policy with no secrets is\nunaffected.",
+      "properties": {
+        "action": {
+          "$ref": "#/$defs/ActionContract"
+        },
+        "frames_per_chunk": {
+          "anyOf": [
+            {
+              "type": "integer"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Frames Per Chunk"
+        },
+        "handler_ref": {
+          "title": "Handler Ref",
+          "type": "string"
+        },
+        "secrets": {
+          "items": {
+            "$ref": "#/$defs/SecretRef"
+          },
+          "title": "Secrets",
+          "type": "array"
+        },
+        "streaming": {
+          "default": false,
+          "title": "Streaming",
+          "type": "boolean"
+        }
+      },
+      "required": [
+        "handler_ref",
+        "action"
+      ],
+      "title": "DeploymentPolicy",
+      "type": "object"
+    },
+    "ImageSpec": {
+      "additionalProperties": false,
+      "description": "Declarative image (gateway builds it via Cloud Build) — = Modal `Image` message. Exactly one of\n`base` (a pullable registry ref) or `dockerfile` (inline Dockerfile source) is set — the Dockerfile\nis its OWN component, never smuggled into the `base` string (S2 goal 4), so the gateway can tell a\nregistry build from a Dockerfile build. `steps` is an ordered list of the four-variant union above\n(a bare list[dict] is refused), extending whichever base was chosen.",
+      "properties": {
+        "base": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Base"
+        },
+        "dockerfile": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "default": null,
+          "title": "Dockerfile"
+        },
+        "steps": {
+          "items": {
+            "anyOf": [
+              {
+                "$ref": "#/$defs/ImageStepUvPip"
+              },
+              {
+                "$ref": "#/$defs/ImageStepApt"
+              },
+              {
+                "$ref": "#/$defs/ImageStepEnv"
+              },
+              {
+                "$ref": "#/$defs/ImageStepRun"
+              }
+            ]
+          },
+          "title": "Steps",
+          "type": "array"
+        }
+      },
+      "title": "ImageSpec",
+      "type": "object"
+    },
+    "ImageStepApt": {
+      "additionalProperties": false,
+      "properties": {
+        "apt_install": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Apt Install",
+          "type": "array"
+        }
+      },
+      "required": [
+        "apt_install"
+      ],
+      "title": "ImageStepApt",
+      "type": "object"
+    },
+    "ImageStepEnv": {
+      "additionalProperties": false,
+      "properties": {
+        "env": {
+          "additionalProperties": {
+            "type": "string"
+          },
+          "title": "Env",
+          "type": "object"
+        }
+      },
+      "required": [
+        "env"
+      ],
+      "title": "ImageStepEnv",
+      "type": "object"
+    },
+    "ImageStepRun": {
+      "additionalProperties": false,
+      "properties": {
+        "run_commands": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Run Commands",
+          "type": "array"
+        }
+      },
+      "required": [
+        "run_commands"
+      ],
+      "title": "ImageStepRun",
+      "type": "object"
+    },
+    "ImageStepUvPip": {
+      "additionalProperties": false,
+      "properties": {
+        "uv_pip_install": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Uv Pip Install",
+          "type": "array"
+        }
+      },
+      "required": [
+        "uv_pip_install"
+      ],
+      "title": "ImageStepUvPip",
+      "type": "object"
+    },
+    "Resources": {
+      "additionalProperties": false,
+      "description": "= Modal Resources + GPUConfig. `gpu` is list[str] (the PolicySpec `str | list[str]` normalized).",
+      "properties": {
+        "cpu": {
+          "title": "Cpu",
+          "type": "integer"
+        },
+        "gpu": {
+          "items": {
+            "type": "string"
+          },
+          "title": "Gpu",
+          "type": "array"
+        },
+        "memory_gb": {
+          "title": "Memory Gb",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "gpu",
+        "cpu",
+        "memory_gb"
+      ],
+      "title": "Resources",
+      "type": "object"
+    },
+    "SecretRef": {
+      "additionalProperties": false,
+      "description": "A by-name reference to a secret (PolicySpec.secrets / BenchmarkSpec.secrets). Name only — the\nvalue lives in Secret Manager and is injected at worker bootstrap. Never carries a value.",
+      "properties": {
+        "name": {
+          "title": "Name",
+          "type": "string"
+        }
+      },
+      "required": [
+        "name"
+      ],
+      "title": "SecretRef",
+      "type": "object"
+    },
+    "Timeouts": {
+      "additionalProperties": false,
+      "properties": {
+        "request": {
+          "title": "Request",
+          "type": "integer"
+        },
+        "startup": {
+          "title": "Startup",
+          "type": "integer"
+        }
+      },
+      "required": [
+        "request",
+        "startup"
+      ],
+      "title": "Timeouts",
+      "type": "object"
+    },
+    "VolumeAttach": {
+      "additionalProperties": false,
+      "description": "A non-weights volume mount in the deploy body (goal 7). Distinct from `weights` (a `VolumeMount`,\na provisioned pull at the reserved `/data`): an explicit `volumes=` attachment names a persistent\nvolume by `vol://<name>` ref, pins its container `mount`, and carries the `create_if_missing`\nprovisioning intent so the gateway either binds an existing volume or creates it — the semantic the\nwire `VolumeMount` deliberately does not carry. Not reused/extended from `VolumeMount` because\n`create_if_missing` is meaningless for the weights pull.",
+      "properties": {
+        "create_if_missing": {
+          "title": "Create If Missing",
+          "type": "boolean"
+        },
+        "mount": {
+          "title": "Mount",
+          "type": "string"
+        },
+        "uri": {
+          "title": "Uri",
+          "type": "string"
+        }
+      },
+      "required": [
+        "uri",
+        "mount",
+        "create_if_missing"
+      ],
+      "title": "VolumeAttach",
+      "type": "object"
+    },
+    "VolumeMount": {
+      "additionalProperties": false,
+      "description": "A concrete mount: where the data lives and where it lands in the container. Both required.",
+      "properties": {
+        "mount": {
+          "title": "Mount",
+          "type": "string"
+        },
+        "uri": {
+          "title": "Uri",
+          "type": "string"
+        }
+      },
+      "required": [
+        "uri",
+        "mount"
+      ],
+      "title": "VolumeMount",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The full `POST /v1/deployments` body. Required: name, image, weights, resources, policy (goal 18).\nautoscaler / concurrency / timeouts are typed optional knobs with sane defaults.",
+  "properties": {
+    "autoscaler": {
+      "$ref": "#/$defs/Autoscaler"
+    },
+    "code": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/CodeBundle"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "concurrency": {
+      "$ref": "#/$defs/Concurrency"
+    },
+    "image": {
+      "$ref": "#/$defs/ImageSpec"
+    },
+    "name": {
+      "title": "Name",
+      "type": "string"
+    },
+    "policy": {
+      "$ref": "#/$defs/DeploymentPolicy"
+    },
+    "resources": {
+      "$ref": "#/$defs/Resources"
+    },
+    "timeouts": {
+      "anyOf": [
+        {
+          "$ref": "#/$defs/Timeouts"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null
+    },
+    "volumes": {
+      "items": {
+        "$ref": "#/$defs/VolumeAttach"
+      },
+      "title": "Volumes",
+      "type": "array"
+    },
+    "weights": {
+      "$ref": "#/$defs/VolumeMount"
+    }
+  },
+  "required": [
+    "name",
+    "image",
+    "weights",
+    "resources",
+    "policy"
+  ],
+  "title": "DeploymentRequest",
+  "type": "object",
+  "x-contract-version": "0.4.1"
+}

sequence_base/schemas/DeploymentStatusResponse.json

@@ -0,0 +1,45 @@
+{
+  "$defs": {
+    "DeploymentState": {
+      "description": "GET status — a restricted enum, not a free string (same discipline as EvalStatus).",
+      "enum": [
+        "building",
+        "ready",
+        "failed"
+      ],
+      "title": "DeploymentState",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "description": "GET /v1/deployments/{id}. `error` carries the build-failure reason when status is FAILED —\nthe failure channel the spec and the old goal both lacked (goal 8).",
+  "properties": {
+    "error": {
+      "anyOf": [
+        {
+          "type": "string"
+        },
+        {
+          "type": "null"
+        }
+      ],
+      "default": null,
+      "description": "Build-failure reason; set only when FAILED",
+      "title": "Error"
+    },
+    "model": {
+      "title": "Model",
+      "type": "string"
+    },
+    "status": {
+      "$ref": "#/$defs/DeploymentState"
+    }
+  },
+  "required": [
+    "status",
+    "model"
+  ],
+  "title": "DeploymentStatusResponse",
+  "type": "object",
+  "x-contract-version": "0.4.1"
+}

sequence_base/schemas/ErrorBody.json

@@ -0,0 +1,32 @@
+{
+  "$defs": {
+    "ErrorCode": {
+      "description": "Restricted set — a client switches on this, so it is an enum, not a free string.",
+      "enum": [
+        "out_of_credit",
+        "unauthorized",
+        "warming"
+      ],
+      "title": "ErrorCode",
+      "type": "string"
+    }
+  },
+  "additionalProperties": false,
+  "description": "The base error body (402 / 401): a machine-readable `code` plus a human `message`.",
+  "properties": {
+    "code": {
+      "$ref": "#/$defs/ErrorCode"
+    },
+    "message": {
+      "title": "Message",
+      "type": "string"
+    }
+  },
+  "required": [
+    "code",
+    "message"
+  ],
+  "title": "ErrorBody",
+  "type": "object",
+  "x-contract-version": "0.4.1"
+}

sequence_base/schemas/Estimate.json

@@ -0,0 +1,25 @@
+{
+  "additionalProperties": false,
+  "properties": {
+    "cost_usd": {
+      "title": "Cost Usd",
+      "type": "number"
+    },
+    "vlm_calls": {
+      "title": "Vlm Calls",
+      "type": "integer"
+    },
+    "wall_clock_s": {
+      "title": "Wall Clock S",
+      "type": "number"
+    }
+  },
+  "required": [
+    "wall_clock_s",
+    "cost_usd",
+    "vlm_calls"
+  ],
+  "title": "Estimate",
+  "type": "object",
+  "x-contract-version": "0.4.1"
+}

sequence_base/schemas/EvalDryRunResponse.json

@@ -0,0 +1,41 @@
+{
+  "$defs": {
+    "Estimate": {
+      "additionalProperties": false,
+      "properties": {
+        "cost_usd": {
+          "title": "Cost Usd",
+          "type": "number"
+        },
+        "vlm_calls": {
+          "title": "Vlm Calls",
+          "type": "integer"
+        },
+        "wall_clock_s": {
+          "title": "Wall Clock S",
+          "type": "number"
+        }
+      },
+      "required": [
+        "wall_clock_s",
+        "cost_usd",
+        "vlm_calls"
+      ],
+      "title": "Estimate",
+      "type": "object"
+    }
+  },
+  "additionalProperties": false,
+  "description": "`dry_run=true` — estimate only. No eval_id, no gpus_granted: nothing was built, nothing to GET.",
+  "properties": {
+    "estimate": {
+      "$ref": "#/$defs/Estimate"
+    }
+  },
+  "required": [
+    "estimate"
+  ],
+  "title": "EvalDryRunResponse",
+  "type": "object",
+  "x-contract-version": "0.4.1"
+}