simulo-interfaces 0.20.1__tar.gz → 0.21.0__tar.gz

{simulo_interfaces-0.20.1/src/simulo_interfaces.egg-info → simulo_interfaces-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: simulo-interfaces
-Version: 0.20.1
+Version: 0.21.0
 Summary: Typed Python contracts for the Simulo cloud robotics SDK and managed simulation runtime.
 Author-email: Simulo Team <team@simulo.ai>
 License: BSD-3-Clause
@@ -9,6 +9,7 @@ Project-URL: Documentation, https://docs.simulo.ai
 Project-URL: Quickstart, https://docs.simulo.ai/getting-started/quickstart/
 Project-URL: Examples, https://github.com/simulo-org/simulo-samples
 Project-URL: Simulo SDK, https://pypi.org/project/simulo/
+Project-URL: Console, https://console.simulo.ai
 Keywords: simulo,robotics,robotics SDK,robotics simulation,robot learning,cloud robotics,Python typing,type contracts,protocols
 Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: Developers
@@ -46,7 +47,7 @@ Requires-Dist: twine>=5.1; extra == "release"
 shared by the [Simulo SDK](https://pypi.org/project/simulo/) and its managed
 cloud robotics simulation runtime. It defines protocols, enums, identifiers,
 and dataclasses for robot-learning tasks, environments, policies, trainers,
-applications, jobs, assets, checkpoints, and trained models.
+applications, jobs, assets, policies, checkpoints, and policy exports.
 
 ## Install Simulo
 
@@ -69,7 +70,7 @@ python -m pip install simulo-interfaces
 
 - Python 3.11 or newer
 - Standard library only, with zero runtime dependencies
-- Torch-free and independent of NVIDIA Isaac Sim, Isaac Lab, CUDA, and cloud clients
+- Torch-free and independent of simulation engines, CUDA, and cloud clients
 - Typed with a `py.typed` marker for mypy and other static type checkers
 - Runtime-checkable structural protocols that do not require inheritance
 - Stable wire enums and records shared across the Simulo client and runtime
@@ -80,6 +81,5 @@ python -m pip install simulo-interfaces
 - [Simulo documentation](https://docs.simulo.ai/)
 - [Python API reference](https://docs.simulo.ai/api/)
 - [Quickstart](https://docs.simulo.ai/getting-started/quickstart/)
-- Robotics samples (currently `simulo>=0.26.0,<0.27`):
-  [public repository](https://github.com/simulo-org/simulo-samples)
+- [Robotics samples](https://github.com/simulo-org/simulo-samples)
 - [Simulo website](https://simulo.ai)

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/PYPI.md

@@ -4,7 +4,7 @@
 shared by the [Simulo SDK](https://pypi.org/project/simulo/) and its managed
 cloud robotics simulation runtime. It defines protocols, enums, identifiers,
 and dataclasses for robot-learning tasks, environments, policies, trainers,
-applications, jobs, assets, checkpoints, and trained models.
+applications, jobs, assets, policies, checkpoints, and policy exports.
 
 ## Install Simulo
 
@@ -27,7 +27,7 @@ python -m pip install simulo-interfaces
 
 - Python 3.11 or newer
 - Standard library only, with zero runtime dependencies
-- Torch-free and independent of NVIDIA Isaac Sim, Isaac Lab, CUDA, and cloud clients
+- Torch-free and independent of simulation engines, CUDA, and cloud clients
 - Typed with a `py.typed` marker for mypy and other static type checkers
 - Runtime-checkable structural protocols that do not require inheritance
 - Stable wire enums and records shared across the Simulo client and runtime
@@ -38,6 +38,5 @@ python -m pip install simulo-interfaces
 - [Simulo documentation](https://docs.simulo.ai/)
 - [Python API reference](https://docs.simulo.ai/api/)
 - [Quickstart](https://docs.simulo.ai/getting-started/quickstart/)
-- Robotics samples (currently `simulo>=0.26.0,<0.27`):
-  [public repository](https://github.com/simulo-org/simulo-samples)
+- [Robotics samples](https://github.com/simulo-org/simulo-samples)
 - [Simulo website](https://simulo.ai)

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "simulo-interfaces"
-version = "0.20.1"
+version = "0.21.0"
 description = "Typed Python contracts for the Simulo cloud robotics SDK and managed simulation runtime."
 readme = "PYPI.md"
 requires-python = ">=3.11"
@@ -66,6 +66,7 @@ Documentation = "https://docs.simulo.ai"
 Quickstart = "https://docs.simulo.ai/getting-started/quickstart/"
 Examples = "https://github.com/simulo-org/simulo-samples"
 "Simulo SDK" = "https://pypi.org/project/simulo/"
+Console = "https://console.simulo.ai"
 
 # Namespace packaging: no `src/simulo/__init__.py` here — this distribution
 # contributes only `simulo.interfaces.*` beneath the shared top-level `simulo`

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/__init__.py

@@ -5,11 +5,11 @@ torch / numpy / gymnasium / Isaac / AWS / HTTP / DB installed. Two parts:
 
 * **Part A — ``simulo.interfaces.runtime``**: tensor-library-agnostic structural
   Protocols mirroring the ``simulo.core`` runtime surface (Task, Policy,
-  Trainer, Player, LearningEnv, Scenario, and the observation/reward/termination
+  Trainer, Player, LearningEnv, and the observation/reward/termination
   components).
 * **Part B — ``simulo.interfaces.platform``**: platform/workspace domain
   contracts — wire-stable enums, frozen domain dataclasses (Project, Package,
-  Job, Resource, Checkpoint, TrainedModel, Tag), and the cloud-execution
+  Job, Resource, Checkpoint, Tag), and the cloud-execution
   Protocols (App, Runtime, Asset, Volume, callbacks, and
   debug/replay/visualization sessions).
 
@@ -29,29 +29,33 @@ from simulo.interfaces.exceptions import (
 )
 from simulo.interfaces.ids import (
     CheckpointId,
+    CheckpointRefIsJobError,
     Digest,
     JobId,
     JobPublicId,
-    ModelPublicId,
     OrganizationId,
     OutputPublicId,
     PackageId,
+    PolicyPublicId,
     ProjectId,
     RecordingPublicId,
     ResourceId,
     ResourceUri,
     TagId,
-    TrainedModelId,
+    checkpoint_ref_is_job_hint,
+    parse_checkpoint_ref,
     parse_job_public_id,
-    parse_model_public_id,
     parse_output_public_id,
     parse_recording_public_id,
+    policy_id_for_job,
 )
+from simulo.interfaces.platform.enums import JobType
 
 __all__ = [
     # subpackages
     "platform",
     "runtime",
+    "JobType",
     # exception hierarchy
     "SimuloError",
     "ContractViolationError",
@@ -65,16 +69,18 @@ __all__ = [
     "PackageId",
     "JobId",
     "JobPublicId",
-    "ModelPublicId",
+    "PolicyPublicId",
     "RecordingPublicId",
     "OutputPublicId",
     "parse_job_public_id",
-    "parse_model_public_id",
+    "parse_checkpoint_ref",
+    "policy_id_for_job",
+    "checkpoint_ref_is_job_hint",
+    "CheckpointRefIsJobError",
     "parse_recording_public_id",
     "parse_output_public_id",
     "ResourceId",
     "CheckpointId",
-    "TrainedModelId",
     "TagId",
     "ResourceUri",
     "Digest",

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/authoring/asset.py

@@ -40,7 +40,7 @@ class USDAsset(AssetSource):
     """USD file asset.
 
     Attributes:
-        path: Path to USD file (supports file://, nucleus:// schemes). The
+        path: Path to a local or supported remote USD file. The
             legacy simulo:// path alias is REMOVED — 'simulo/...' is a catalog
             ref ([publisher/]kind/name[:vN], 'simulo' = the global-catalog
             publisher), resolved through

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/authoring/primitives.py

@@ -100,8 +100,6 @@ class Transform:
         scene.add(t2, at="/World/Origin2")
         ```
 
-    Backend Mapping:
-        IsaacLab: Maps to Xform prim with translation
     """
 
     def __init__(

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/authoring/scene.py

@@ -5,8 +5,7 @@ the ``Scene`` implementation itself stays in the backend package — it is the
 backend adapter (it writes backend-private state and drives engine-private
 methods when the simulation flushes), so its *implementation* cannot live in a
 zero-dependency package. What CAN live here is its declared public surface:
-these Protocols name exactly what authoring code — a ``build(scene)`` method in
-a task or scenario — may rely on.
+these Protocols name exactly what a task's ``build(scene)`` method may rely on.
 
 The backend's concrete ``Scene`` / ``SceneGroup`` classes explicitly inherit
 these Protocols (nominal conformance, the same pattern the ``runtime``

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/authoring/terrain.py

@@ -87,7 +87,7 @@ class RoughTerrain(TerrainConfig):
 
     This terrain type generates a grid of sub-terrains with various
     difficulty levels, suitable for curriculum learning in locomotion
-    tasks. Equivalent to IsaacLab's TerrainImporterCfg with TerrainGeneratorCfg.
+    tasks.
 
     Attributes:
         num_rows: Number of terrain rows (sub-terrain grid rows)
@@ -104,7 +104,7 @@ class RoughTerrain(TerrainConfig):
         ```python
         import simulo
 
-        # Create rough terrain matching IsaacLab's H1 configuration
+        # Create a rough terrain configuration
         terrain = simulo.Terrain.rough(
             name="terrain",
             num_rows=10,
@@ -254,7 +254,6 @@ class Terrain:
 
         This creates a grid of sub-terrains with varying difficulty,
         suitable for curriculum learning in locomotion tasks.
-        Equivalent to IsaacLab's TerrainGeneratorCfg with TerrainImporterCfg.
 
         Args:
             name: Terrain name

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/authoring/world.py

@@ -28,9 +28,7 @@ class USDWorld:
     Attributes:
         name: World name
         pose: Pose in space (usually identity for USD scenes)
-        path: Path to USD file. Supports:
-            - Local paths: "/path/to/scene.usd"
-            - Nucleus paths: "nucleus://Isaac/Environments/..."
+        path: Path to a local or supported remote USD file.
             A catalog world (USD Asset Catalogs) is referenced via
             simulo.Asset.from_registry("simulo/world/<name>:v1") and mounted
             like any other asset — a "simulo://" path scheme is not
@@ -43,7 +41,7 @@ class USDWorld:
         # Load warehouse for inference
         warehouse = simulo.World.usd(
             name="warehouse",
-            path="nucleus://Isaac/Environments/Simple_Warehouse/warehouse.usd",
+            path="/path/to/warehouse.usd",
         )
         scene.add(warehouse, at="/World", per_environment=False)
         ```
@@ -80,9 +78,7 @@ class World:
 
         Args:
             name: World name
-            path: Path to USD file. Supports:
-                - Local paths: "/path/to/scene.usd"
-                - Nucleus paths: "nucleus://Isaac/Environments/..."
+            path: Path to a local or supported remote USD file.
             pose: Pose in space (usually identity for USD scenes)
             spawn_origin: Position (x, y, z) where robot should spawn
 
@@ -94,7 +90,7 @@ class World:
             # Inference in warehouse
             warehouse = simulo.World.usd(
                 name="warehouse",
-                path="nucleus://Isaac/Environments/Simple_Warehouse/warehouse.usd",
+                path="/path/to/warehouse.usd",
                 spawn_origin=(0, 0, 0),
             )
             scene.add(warehouse, at="/World", per_environment=False)

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/ids.py

@@ -31,7 +31,7 @@ AssetVersionId = NewType("AssetVersionId", str)  # one immutable asset version (
 OutputId = NewType("OutputId", str)  # a job-produced output in the /outputs projection (Plan B)
 
 JobPublicId = NewType("JobPublicId", str)
-ModelPublicId = NewType("ModelPublicId", str)
+PolicyPublicId = NewType("PolicyPublicId", str)
 RecordingPublicId = NewType("RecordingPublicId", str)
 OutputPublicId = NewType("OutputPublicId", str)
 
@@ -43,9 +43,10 @@ _ASCII_LOWERCASE_TRANSLATION = str.maketrans(
 _JOB_STEM_PATTERN = r"[a-z]{3,10}-[a-z]{3,10}-[0-9a-hjkmnp-tv-z]{6}"
 _CANONICAL_CHILD_COUNTER_PATTERN = r"(?:(?!0000)[0-9]{4}|[1-9][0-9]{4,})"
 _JOB_PUBLIC_ID_RE = re.compile(rf"job_{_JOB_STEM_PATTERN}\Z")
-_MODEL_PUBLIC_ID_RE = re.compile(rf"mdl_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
 _RECORDING_PUBLIC_ID_RE = re.compile(rf"rec_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
 _OUTPUT_PUBLIC_ID_RE = re.compile(rf"out_{_JOB_STEM_PATTERN}-{_CANONICAL_CHILD_COUNTER_PATTERN}\Z")
+_POLICY_CHECKPOINT_REF_RE = re.compile(rf"policy_({_JOB_STEM_PATTERN}):(best|latest)\Z")
+_JOB_CHECKPOINT_REF_RE = re.compile(rf"job_({_JOB_STEM_PATTERN}):(best|latest)\Z")
 _MAX_JOB_PUBLIC_ID_LENGTH = 32
 _MAX_CHILD_PUBLIC_ID_LENGTH = 64
 
@@ -81,24 +82,6 @@ def parse_job_public_id(value: str) -> JobPublicId:
     )
 
 
-def parse_model_public_id(value: str) -> ModelPublicId:
-    """Return a canonical Model ID such as ``mdl_quiet-cedar-7k3m4q-0001``.
-
-    Only outer ASCII whitespace is trimmed and only ASCII ``A-Z`` is
-    lowercased. Matching is exact and non-ASCII input is rejected. Counters
-    use exactly four digits through ``9999`` and expand unpadded at ``10000``.
-    """
-
-    return ModelPublicId(
-        _parse_public_id(
-            value,
-            parser="parse_model_public_id",
-            pattern=_MODEL_PUBLIC_ID_RE,
-            max_length=_MAX_CHILD_PUBLIC_ID_LENGTH,
-        )
-    )
-
-
 def parse_recording_public_id(value: str) -> RecordingPublicId:
     """Return a Recording ID such as ``rec_quiet-cedar-7k3m4q-0001``.
 
@@ -133,3 +116,40 @@ def parse_output_public_id(value: str) -> OutputPublicId:
             max_length=_MAX_CHILD_PUBLIC_ID_LENGTH,
         )
     )
+
+
+class CheckpointRefIsJobError(ValueError):
+    """A checkpoint reference used a job ID where a policy ID is required."""
+
+    def __init__(self, stem: str, kind: str) -> None:
+        self.stem = stem
+        self.kind = kind
+        super().__init__(checkpoint_ref_is_job_hint(stem, kind))
+
+
+def checkpoint_ref_is_job_hint(stem: str, kind: str) -> str:
+    """Format Rule 10's actionable job-reference correction."""
+
+    return f"job_{stem} is a job; did you mean policy_{stem}:{kind}?"
+
+
+def policy_id_for_job(value: str) -> PolicyPublicId:
+    """Return the policy ID for one canonical public job ID."""
+
+    job_id = parse_job_public_id(value)
+    return PolicyPublicId(f"policy_{str(job_id).removeprefix('job_')}")
+
+
+def parse_checkpoint_ref(value: str) -> tuple[PolicyPublicId, str]:
+    """Parse a normalized ``policy_<stem>:best|latest`` checkpoint reference."""
+
+    normalized = _normalize_public_id(value, parser="parse_checkpoint_ref")
+    match = _POLICY_CHECKPOINT_REF_RE.fullmatch(normalized)
+    if match is not None:
+        stem, kind = match.groups()
+        return PolicyPublicId(f"policy_{stem}"), kind
+    job_match = _JOB_CHECKPOINT_REF_RE.fullmatch(normalized)
+    if job_match is not None:
+        stem, kind = job_match.groups()
+        raise CheckpointRefIsJobError(stem, kind)
+    raise ValueError("parse_checkpoint_ref() requires policy_<stem>:best or policy_<stem>:latest.")

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/platform/__init__.py

@@ -1,7 +1,7 @@
 """Part B — platform/workspace domain contracts.
 
 Wire-stable enums, frozen domain dataclasses (Project, Package, Job, Resource,
-Checkpoint, TrainedModel, Tag), and the cloud-execution Protocols (App, Runtime,
+Checkpoint, Tag), and the cloud-execution Protocols (App, Runtime,
 Asset, Volume, job callbacks, and debug/replay/visualization sessions). All
 implementation-free — concrete behaviour lives in the future
 ``simulo`` client and the ``simulo-backend`` SDK.
@@ -69,8 +69,14 @@ from simulo.interfaces.platform.asset_catalog import (
 )
 from simulo.interfaces.platform.callbacks import JobCallbackProtocol
 from simulo.interfaces.platform.debug import DebugSessionProtocol, ReplaySessionProtocol, VisualizationSessionProtocol
-from simulo.interfaces.platform.domain import Checkpoint, Job, Package, Project, Resource, Tag, TrainedModel
-from simulo.interfaces.platform.enums import OutputKind, SystemType
+from simulo.interfaces.platform.domain import Checkpoint, Job, Package, Project, Resource, Tag
+from simulo.interfaces.platform.enums import (
+    UNAVAILABLE_JOB_TYPES,
+    USER_SUBMITTABLE_JOB_TYPES,
+    JobType,
+    OutputKind,
+    SystemType,
+)
 from simulo.interfaces.platform.job_events import (
     MAX_PUBLIC_ASSET_FINDING_COUNT,
     MAX_PUBLIC_JOB_EVENT_ATTEMPT,
@@ -133,6 +139,7 @@ from simulo.interfaces.platform.outputs import (
     OutputRecord,
 )
 from simulo.interfaces.platform.policy_bundle import (
+    EXPORT_JOB_TYPE,
     EXPORT_VALIDATION_JOB_TYPE,
     JOB_EXPORTS_ROUTE_TEMPLATE,
     MAX_POLICY_BUNDLE_UNCOMPRESSED_BYTES,
@@ -186,6 +193,19 @@ from simulo.interfaces.platform.policy_bundle import (
     policy_name_token,
     validate_policy_bundle,
 )
+from simulo.interfaces.platform.preview import (
+    PREVIEW_CHECKS,
+    PREVIEW_REPORT_SCHEMA_VERSION,
+    PREVIEW_SELECTABLE_CHECKS,
+    PreviewCheck,
+    PreviewOwner,
+    PreviewReport,
+    PreviewReportRow,
+    PreviewReportStage,
+    PreviewRowStatus,
+    PreviewStageStatus,
+    PreviewVerdict,
+)
 from simulo.interfaces.platform.runs import (
     JOB_CANCEL_ROUTE_TEMPLATE,
     JOB_LIST_SCOPES,
@@ -203,41 +223,61 @@ from simulo.interfaces.platform.runs import (
     LOG_ARCHIVE_UNAVAILABLE_CODES,
     LOG_CHUNK_MAX_BYTES,
     LOG_TAIL_MAX_BYTES,
+    MAX_JOB_TAG_LENGTH,
+    MAX_JOB_TAGS,
     TERMINAL_JOB_STATUSES,
+    normalize_job_tags,
 )
 from simulo.interfaces.platform.runtime import RuntimeProtocol
 from simulo.interfaces.platform.submit import (
-    JOB_MODEL_DOWNLOAD_ROUTE_TEMPLATE,
-    JOB_MODEL_ROUTE_TEMPLATE,
-    JOB_MODELS_ROUTE_TEMPLATE,
+    CHECKPOINT_IS_INPUT_CODE,
+    CHECKPOINT_KINDS,
+    CHECKPOINT_META_INVALID_CODE,
+    CHECKPOINT_NOT_ALLOWED_CODE,
+    CHECKPOINT_REF_IS_JOB_CODE,
+    CHECKPOINT_UNAVAILABLE_CODE,
+    CHECKPOINT_UPLOAD_MISSING_CODE,
+    EXPORTS_ROUTE,
+    INPUT_CHECKPOINT_NOT_ALLOWED_CODE,
     JOB_RECORDING_DOWNLOAD_ROUTE_TEMPLATE,
     JOB_RECORDINGS_ROUTE_TEMPLATE,
+    JOB_TYPE_MISMATCH_CODE,
     MAX_COMPLETE_MESSAGE_CHARS,
     MAX_COMPLETE_REASON_CODE_CHARS,
     MAX_LOG_CHUNK_BYTES,
     MAX_LOG_TOTAL_BYTES,
     MAX_PACKAGE_BYTES,
     MAX_RESULT_BYTES,
-    MAX_SEED_REF_CHARS,
-    MODEL_KINDS,
+    MAX_WORKER_RETIREMENT_DETAIL_CHARS,
+    NO_CHECKPOINT_SAVED_CODE,
+    NO_CHECKPOINT_SAVED_MESSAGE,
     PACKAGE_ARCHIVE_ROUTE_TEMPLATE,
     PACKAGES_ROUTE,
     PLATFORM_PINNED_PACKAGES,
+    POLICIES_ROUTE,
+    POLICY_CHECKPOINT_DOWNLOAD_ROUTE_TEMPLATE,
+    POLICY_EXPORTS_ROUTE_TEMPLATE,
+    POLICY_NOT_FOUND_CODE,
+    POLICY_NOT_SEALED_CODE,
+    POLICY_ROUTE_TEMPLATE,
+    POLICY_SEALED_CODE,
     RESERVED_RUNTIME_ENV_KEYS,
     RESERVED_RUNTIME_ENV_PREFIXES,
-    SEED_JOB_REF_GRAMMAR,
-    SEED_SOURCE_CONFLICT_CODE,
-    SEED_SOURCE_FIELDS,
     WORKER_BOOTSTRAP_ROUTE,
+    WORKER_CLAIM_INPUT_CHECKPOINT_FIELDS,
     WORKER_CLAIM_ROUTE,
+    WORKER_JOB_CHECKPOINTS_PRESIGN_ROUTE_TEMPLATE,
+    WORKER_JOB_CHECKPOINTS_ROUTE_TEMPLATE,
     WORKER_JOB_COMPLETE_ROUTE_TEMPLATE,
     WORKER_JOB_HEARTBEAT_ROUTE_TEMPLATE,
     WORKER_JOB_LOGS_ROUTE_TEMPLATE,
-    WORKER_JOB_MODELS_PRESIGN_ROUTE_TEMPLATE,
-    WORKER_JOB_MODELS_ROUTE_TEMPLATE,
     WORKER_JOB_RECORDINGS_PRESIGN_ROUTE_TEMPLATE,
     WORKER_JOB_RECORDINGS_ROUTE_TEMPLATE,
     WORKER_LEASE_HEADER,
+    WORKER_RETIRE_ROUTE,
+    PolicyCheckpointRecord,
+    PolicyExportRecord,
+    PolicyRecord,
     canonical_pypi_name,
     is_platform_pinned,
 )
@@ -246,6 +286,9 @@ from simulo.interfaces.platform.volume import VolumeProtocol
 
 __all__ = [
     # enums
+    "JobType",
+    "USER_SUBMITTABLE_JOB_TYPES",
+    "UNAVAILABLE_JOB_TYPES",
     "OutputKind",
     "SystemType",
     # systems (GPU system-tier catalog, issue #1362)
@@ -285,7 +328,6 @@ __all__ = [
     "Resource",
     "Job",
     "Checkpoint",
-    "TrainedModel",
     # package manifest + version handshake + preflight contract (Plan A / #515, #533)
     "Manifest",
     "SUPPORTED_MANIFEST_VERSIONS",
@@ -320,6 +362,9 @@ __all__ = [
     "OUTPUTS_UNDELIVERED_CODE",
     "DECLARED_OUTPUT_MISSING_CODE",
     # job-run contract (run record schema + jobs HTTP API shape)
+    "MAX_JOB_TAGS",
+    "MAX_JOB_TAG_LENGTH",
+    "normalize_job_tags",
     "TERMINAL_JOB_STATUSES",
     "JOBS_API_DEFAULT_PORT",
     "JOBS_ROUTE",
@@ -349,18 +394,25 @@ __all__ = [
     "PACKAGE_ARCHIVE_ROUTE_TEMPLATE",
     "JOB_RECORDINGS_ROUTE_TEMPLATE",
     "JOB_RECORDING_DOWNLOAD_ROUTE_TEMPLATE",
-    "JOB_MODELS_ROUTE_TEMPLATE",
-    "JOB_MODEL_ROUTE_TEMPLATE",
-    "JOB_MODEL_DOWNLOAD_ROUTE_TEMPLATE",
+    "POLICIES_ROUTE",
+    "POLICY_ROUTE_TEMPLATE",
+    "POLICY_CHECKPOINT_DOWNLOAD_ROUTE_TEMPLATE",
+    "EXPORTS_ROUTE",
+    "POLICY_EXPORTS_ROUTE_TEMPLATE",
+    "PolicyRecord",
+    "PolicyCheckpointRecord",
+    "PolicyExportRecord",
     "WORKER_BOOTSTRAP_ROUTE",
     "WORKER_CLAIM_ROUTE",
+    "WORKER_RETIRE_ROUTE",
     "WORKER_JOB_LOGS_ROUTE_TEMPLATE",
     "WORKER_JOB_HEARTBEAT_ROUTE_TEMPLATE",
     "WORKER_JOB_COMPLETE_ROUTE_TEMPLATE",
     "WORKER_JOB_RECORDINGS_PRESIGN_ROUTE_TEMPLATE",
     "WORKER_JOB_RECORDINGS_ROUTE_TEMPLATE",
-    "WORKER_JOB_MODELS_PRESIGN_ROUTE_TEMPLATE",
-    "WORKER_JOB_MODELS_ROUTE_TEMPLATE",
+    "WORKER_JOB_CHECKPOINTS_PRESIGN_ROUTE_TEMPLATE",
+    "WORKER_JOB_CHECKPOINTS_ROUTE_TEMPLATE",
+    "WORKER_CLAIM_INPUT_CHECKPOINT_FIELDS",
     "WORKER_LEASE_HEADER",
     "MAX_PACKAGE_BYTES",
     "MAX_LOG_CHUNK_BYTES",
@@ -368,17 +420,26 @@ __all__ = [
     "MAX_RESULT_BYTES",
     "MAX_COMPLETE_MESSAGE_CHARS",
     "MAX_COMPLETE_REASON_CODE_CHARS",
-    "MODEL_KINDS",
+    "MAX_WORKER_RETIREMENT_DETAIL_CHARS",
+    "CHECKPOINT_KINDS",
     "RESERVED_RUNTIME_ENV_KEYS",
     "RESERVED_RUNTIME_ENV_PREFIXES",
     "PLATFORM_PINNED_PACKAGES",
     "is_platform_pinned",
     "canonical_pypi_name",
-    # explicit-run-intent plan: submit-time seed source (additive)
-    "SEED_SOURCE_FIELDS",
-    "SEED_SOURCE_CONFLICT_CODE",
-    "SEED_JOB_REF_GRAMMAR",
-    "MAX_SEED_REF_CHARS",
+    "NO_CHECKPOINT_SAVED_CODE",
+    "NO_CHECKPOINT_SAVED_MESSAGE",
+    "POLICY_NOT_FOUND_CODE",
+    "POLICY_NOT_SEALED_CODE",
+    "CHECKPOINT_UNAVAILABLE_CODE",
+    "CHECKPOINT_REF_IS_JOB_CODE",
+    "INPUT_CHECKPOINT_NOT_ALLOWED_CODE",
+    "CHECKPOINT_IS_INPUT_CODE",
+    "POLICY_SEALED_CODE",
+    "CHECKPOINT_NOT_ALLOWED_CODE",
+    "CHECKPOINT_UPLOAD_MISSING_CODE",
+    "CHECKPOINT_META_INVALID_CODE",
+    "JOB_TYPE_MISMATCH_CODE",
     # USD Asset Catalogs wire contract (PR-1) — ref grammar
     "parse_asset_ref",
     "format_asset_ref",
@@ -475,6 +536,7 @@ __all__ = [
     "policy_bundle_root_dir",
     "policy_bundle_archive_name",
     "JOB_EXPORTS_ROUTE_TEMPLATE",
+    "EXPORT_JOB_TYPE",
     "EXPORT_VALIDATION_JOB_TYPE",
     "POLICY_EQUIVALENCE_ABS_TOLERANCE",
     "POLICY_EQUIVALENCE_REL_TOLERANCE",
@@ -498,6 +560,19 @@ __all__ = [
     "PolicyActionSchema",
     "PolicyNormalization",
     "validate_policy_bundle",
+    # preview report wire contract — schema version, check names, and the
+    # row/stage/report shapes the preview job returns
+    "PREVIEW_REPORT_SCHEMA_VERSION",
+    "PREVIEW_CHECKS",
+    "PREVIEW_SELECTABLE_CHECKS",
+    "PreviewCheck",
+    "PreviewRowStatus",
+    "PreviewStageStatus",
+    "PreviewVerdict",
+    "PreviewOwner",
+    "PreviewReportRow",
+    "PreviewReportStage",
+    "PreviewReport",
     # protocols
     "RuntimeProtocol",
     "AssetProtocol",

{simulo_interfaces-0.20.1 → simulo_interfaces-0.21.0}/src/simulo/interfaces/platform/app.py

@@ -1,11 +1,22 @@
 """User-facing job-container Protocols (Part B) — ``App`` / ``@app.job`` surface."""
 
-from typing import Callable, Mapping, Optional, Protocol, Sequence, TypeVar, Union, overload, runtime_checkable
+from typing import (
+    Any,
+    Callable,
+    Mapping,
+    Optional,
+    Protocol,
+    Sequence,
+    TypeVar,
+    Union,
+    overload,
+    runtime_checkable,
+)
 
 from simulo.interfaces.ids import JobId
 from simulo.interfaces.platform.asset import AssetProtocol
 from simulo.interfaces.platform.callbacks import JobCallbackProtocol
-from simulo.interfaces.platform.enums import ResumePolicy
+from simulo.interfaces.platform.enums import JobType, SystemType
 from simulo.interfaces.platform.runtime import RuntimeProtocol
 from simulo.interfaces.platform.volume import VolumeProtocol
 
@@ -55,22 +66,53 @@ class AppProtocol(Protocol):
         """The assets/volumes mounted into every job of this app, by name."""
         ...
 
-    @overload
-    def job(self, fn: F) -> JobFunctionProtocol: ...
+    @property
+    def job_declarations(self) -> tuple[tuple[str, object], ...]:
+        """Every job declaration, including duplicate function names."""
+        ...
+
+    @property
+    def success_functions(self) -> tuple[Callable[..., object], ...]:
+        """Evaluation success predicates, in declaration order."""
+        ...
+
     @overload
     def job(
-        self, *, callbacks: Sequence[JobCallbackProtocol] = ..., resume: ResumePolicy = ...
+        self,
+        *,
+        type: Union[JobType, str],
+        callbacks: Sequence[JobCallbackProtocol] = ...,
+        system: Optional[SystemType] = ...,
+        timeout: Optional[int] = ...,
+        retries: int = ...,
+        **extra: Any,
     ) -> Callable[[F], JobFunctionProtocol]: ...
+    @overload
+    def job(
+        self,
+        fn: F,
+        *,
+        type: Union[JobType, str],
+        callbacks: Sequence[JobCallbackProtocol] = ...,
+        system: Optional[SystemType] = ...,
+        timeout: Optional[int] = ...,
+        retries: int = ...,
+        **extra: Any,
+    ) -> JobFunctionProtocol: ...
     def job(
         self,
         fn: Optional[F] = None,
         *,
+        type: Optional[Union[JobType, str]] = None,
         callbacks: Sequence[JobCallbackProtocol] = (),
-        resume: ResumePolicy = ResumePolicy.AUTO,
+        system: Optional[SystemType] = None,
+        timeout: Optional[int] = None,
+        retries: int = 0,
+        **extra: Any,
     ) -> Union[JobFunctionProtocol, Callable[[F], JobFunctionProtocol]]:
-        """Register a function as a job of this app (usable bare or with keyword options)."""
+        """Register a typed job with its submission metadata."""
         ...
 
-    def entrypoint(self, fn: F) -> F:
-        """Register the function ``simulo run`` invokes on the user's machine."""
+    def success(self, fn: F) -> F:
+        """Register an evaluation success predicate."""
         ...