simulo 0.24.1__tar.gz → 0.26.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- {simulo-0.24.1/src/simulo.egg-info → simulo-0.26.0}/PKG-INFO +6 -2
- {simulo-0.24.1 → simulo-0.26.0}/PYPI.md +4 -0
- {simulo-0.24.1 → simulo-0.26.0}/pyproject.toml +2 -2
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/__init__.py +6 -5
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/app.py +81 -12
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/cli.py +132 -1
- simulo-0.26.0/src/simulo/_client/install_samples.py +267 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/submit_api.py +11 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/inference/app.py.tmpl +4 -3
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/scenario/app.py.tmpl +2 -1
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/training/app.py.tmpl +2 -1
- {simulo-0.24.1 → simulo-0.26.0/src/simulo.egg-info}/PKG-INFO +6 -2
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo.egg-info/SOURCES.txt +1 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo.egg-info/requires.txt +1 -1
- {simulo-0.24.1 → simulo-0.26.0}/MANIFEST.in +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/setup.cfg +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/__init__.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/_entrypoint.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/_mounts.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/_runner.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/_secure_downloads.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/asset.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/asset_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/asset_package.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/asset_pins.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/builtin_aliases.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/bundle.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/cancel_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/config.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/credentials.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/discovery.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/export_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/export_bundle.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/facades.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/http.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/identity_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/jobs_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/learning.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/login.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/mode.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/outputs.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/packaging.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/preflight_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/preflight_render.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/registry.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/runtime.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/runtime_display.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/seed_ref.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/stub.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/__init__.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/inference/simuloignore.tmpl +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/scenario/simuloignore.tmpl +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/templates/training/simuloignore.tmpl +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/view_fragment.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/view_session_api.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/_client/volume.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/callbacks.py +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo/py.typed +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo.egg-info/dependency_links.txt +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo.egg-info/entry_points.txt +0 -0
- {simulo-0.24.1 → simulo-0.26.0}/src/simulo.egg-info/top_level.txt +0 -0
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: simulo
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.26.0
|
|
4
4
|
Summary: Simulo SDK and CLI — define robotics simulation and training apps in Python and run them on the Simulo cloud.
|
|
5
5
|
Author-email: Simulo Team <team@simulo.ai>
|
|
6
6
|
License: BSD-3-Clause
|
|
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
|
|
|
15
15
|
Classifier: Typing :: Typed
|
|
16
16
|
Requires-Python: >=3.11
|
|
17
17
|
Description-Content-Type: text/markdown
|
|
18
|
-
Requires-Dist: simulo-interfaces<0.
|
|
18
|
+
Requires-Dist: simulo-interfaces<0.20,>=0.19.0
|
|
19
19
|
Requires-Dist: mcap<2,>=1.3
|
|
20
20
|
Requires-Dist: defusedxml>=0.7.1
|
|
21
21
|
Requires-Dist: usd-core<27,>=26.5
|
|
@@ -71,6 +71,10 @@ required — `simulo create` only writes files to your local folder. Edit
|
|
|
71
71
|
`app.py` for your own robot and task, then see "Log in and submit" below to
|
|
72
72
|
run it.
|
|
73
73
|
|
|
74
|
+
To download a curated collection of runnable projects, use `simulo install samples`.
|
|
75
|
+
It creates `./simulo-samples` as a normal Git clone, so `cd simulo-samples` and
|
|
76
|
+
`cat README.md` open the sample index.
|
|
77
|
+
|
|
74
78
|
### Or write an app by hand
|
|
75
79
|
|
|
76
80
|
```python
|
|
@@ -31,6 +31,10 @@ required — `simulo create` only writes files to your local folder. Edit
|
|
|
31
31
|
`app.py` for your own robot and task, then see "Log in and submit" below to
|
|
32
32
|
run it.
|
|
33
33
|
|
|
34
|
+
To download a curated collection of runnable projects, use `simulo install samples`.
|
|
35
|
+
It creates `./simulo-samples` as a normal Git clone, so `cd simulo-samples` and
|
|
36
|
+
`cat README.md` open the sample index.
|
|
37
|
+
|
|
34
38
|
### Or write an app by hand
|
|
35
39
|
|
|
36
40
|
```python
|
|
@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
|
|
|
4
4
|
|
|
5
5
|
[project]
|
|
6
6
|
name = "simulo"
|
|
7
|
-
version = "0.
|
|
7
|
+
version = "0.26.0"
|
|
8
8
|
description = "Simulo SDK and CLI — define robotics simulation and training apps in Python and run them on the Simulo cloud."
|
|
9
9
|
readme = "PYPI.md"
|
|
10
10
|
requires-python = ">=3.11"
|
|
@@ -26,7 +26,7 @@ classifiers = [
|
|
|
26
26
|
# mcap: used by `simulo recordings` to read back a downloaded recording and
|
|
27
27
|
# verify it (message count) — MIT-licensed, deps only lz4+zstandard.
|
|
28
28
|
dependencies = [
|
|
29
|
-
"simulo-interfaces>=0.
|
|
29
|
+
"simulo-interfaces>=0.19.0,<0.20",
|
|
30
30
|
"mcap>=1.3,<2",
|
|
31
31
|
# Hardened XML parsing for URDF ingestion (USD Asset Catalogs, PR-12 fix
|
|
32
32
|
# loop 2, security NIT): stdlib xml.etree.ElementTree relies on
|
|
@@ -29,10 +29,10 @@ missed that way before the rule replaced it.
|
|
|
29
29
|
Three kinds of name live on ``simulo``:
|
|
30
30
|
|
|
31
31
|
* **Platform** names — ``App / Runtime / Volume / Asset / Output /
|
|
32
|
-
OutputKind / callbacks`` — are **real, eager** attributes bound
|
|
33
|
-
They are always torch-free (``Output`` is the ``simulo-interfaces``
|
|
34
|
-
contract dataclass, ``OutputKind`` its wire-stable
|
|
35
|
-
re-exported).
|
|
32
|
+
OutputKind / SystemType / callbacks`` — are **real, eager** attributes bound
|
|
33
|
+
below. They are always torch-free (``Output`` is the ``simulo-interfaces``
|
|
34
|
+
contract dataclass, ``OutputKind`` and ``SystemType`` its wire-stable
|
|
35
|
+
``StrEnum``\\ s, all three re-exported).
|
|
36
36
|
* **Contract vocabulary** — the shared error hierarchy (``SimuloError`` and its
|
|
37
37
|
subclasses), the ``NewType`` identifier aliases (``JobId``, ``ProjectId``, …),
|
|
38
38
|
and the authoring value types that are not already carried by the lazy
|
|
@@ -152,7 +152,7 @@ from simulo.interfaces.authoring import (
|
|
|
152
152
|
USDWorld,
|
|
153
153
|
VisualMarkerBase,
|
|
154
154
|
)
|
|
155
|
-
from simulo.interfaces.platform import Output, OutputKind
|
|
155
|
+
from simulo.interfaces.platform import Output, OutputKind, SystemType
|
|
156
156
|
|
|
157
157
|
# Public surface = eager platform exports (real attributes; ``__getattr__`` never
|
|
158
158
|
# fires for these) + the lazily-resolved learning names. Kept a static literal so
|
|
@@ -162,6 +162,7 @@ __all__ = [
|
|
|
162
162
|
"App",
|
|
163
163
|
"Output",
|
|
164
164
|
"OutputKind",
|
|
165
|
+
"SystemType",
|
|
165
166
|
"Runtime",
|
|
166
167
|
"Volume",
|
|
167
168
|
"Asset",
|
|
@@ -41,7 +41,8 @@ from simulo._client.runtime import DEFAULT_RUNTIME
|
|
|
41
41
|
from simulo.interfaces.ids import JobId, parse_job_public_id
|
|
42
42
|
from simulo.interfaces.platform import JobCallbackProtocol
|
|
43
43
|
from simulo.interfaces.platform.app import Mount
|
|
44
|
-
from simulo.interfaces.platform.enums import ResumePolicy
|
|
44
|
+
from simulo.interfaces.platform.enums import ResumePolicy, SystemType
|
|
45
|
+
from simulo.interfaces.platform.systems import SYSTEM_SPECS
|
|
45
46
|
|
|
46
47
|
if TYPE_CHECKING: # typing-only; avoids a module-scope dependency on the HTTP client
|
|
47
48
|
from simulo._client.preflight_api import PreflightOutcome
|
|
@@ -427,6 +428,14 @@ def _spawn_cloud(
|
|
|
427
428
|
content-addressed identity must never change based on whether this
|
|
428
429
|
particular execution asked for a live stream.
|
|
429
430
|
|
|
431
|
+
The requested GPU system tier (system-tier-catalog-1362, M50-persistence)
|
|
432
|
+
is NOT a parameter here — it is read from the already-parsed manifest's
|
|
433
|
+
``jobs[job_name]["resources"]["system"]`` (the wire value
|
|
434
|
+
``@app.job(system=...)`` already validated and recorded at decoration
|
|
435
|
+
time) and forwarded to ``create_job`` below as an optional top-level
|
|
436
|
+
sibling of ``args``, for the identical package-hash-invariance reason as
|
|
437
|
+
``viewstream``.
|
|
438
|
+
|
|
430
439
|
``seed_from`` (``simulo run --from``, explicit-run-intent plan) follows
|
|
431
440
|
the identical rule: the seed reference is a SUBMIT-time job property,
|
|
432
441
|
never a package property — it rides the job-create call only, verbatim
|
|
@@ -496,6 +505,15 @@ def _spawn_cloud(
|
|
|
496
505
|
package_id = str(package_id)
|
|
497
506
|
source_digest = str(manifest.get("source_digest", ""))
|
|
498
507
|
args = dict(manifest.get("args") or {})
|
|
508
|
+
# The requested GPU system tier (system-tier-catalog-1362, M50-persistence)
|
|
509
|
+
# — already validated at `@app.job(system=...)` decoration time and
|
|
510
|
+
# recorded on THIS job's own manifest entry as `resources["system"]`
|
|
511
|
+
# (the tier's wire value, e.g. "tier1"; see `decorate()`'s
|
|
512
|
+
# `resources["system"] = system.value`). Read from the already-parsed
|
|
513
|
+
# manifest rather than threaded in as a new parameter, since the value
|
|
514
|
+
# already lives there, keyed by this same `job_name`.
|
|
515
|
+
job_entry = manifest.get("jobs", {}).get(job_name) or {}
|
|
516
|
+
system = (job_entry.get("resources") or {}).get("system")
|
|
499
517
|
|
|
500
518
|
tar_path = ensure_tar(package_path)
|
|
501
519
|
archive_bytes = tar_path.read_bytes()
|
|
@@ -549,6 +567,7 @@ def _spawn_cloud(
|
|
|
549
567
|
seed_from_job_id=seed_from,
|
|
550
568
|
assets=asset_pins,
|
|
551
569
|
app_name=app_name,
|
|
570
|
+
system=system,
|
|
552
571
|
)
|
|
553
572
|
|
|
554
573
|
raw_public_id = record.get("public_id")
|
|
@@ -970,7 +989,7 @@ class App:
|
|
|
970
989
|
|
|
971
990
|
app = simulo.App("cartpole")
|
|
972
991
|
|
|
973
|
-
@app.job(
|
|
992
|
+
@app.job(system=simulo.SystemType.TIER_1)
|
|
974
993
|
def train(iterations: int = 1000):
|
|
975
994
|
...
|
|
976
995
|
|
|
@@ -1044,7 +1063,7 @@ class App:
|
|
|
1044
1063
|
*,
|
|
1045
1064
|
callbacks: Sequence[JobCallbackProtocol] = ...,
|
|
1046
1065
|
resume: ResumePolicy = ...,
|
|
1047
|
-
|
|
1066
|
+
system: Optional[SystemType] = ...,
|
|
1048
1067
|
timeout: Optional[int] = ...,
|
|
1049
1068
|
retries: int = ...,
|
|
1050
1069
|
**extra: Any,
|
|
@@ -1056,14 +1075,15 @@ class App:
|
|
|
1056
1075
|
*,
|
|
1057
1076
|
callbacks: Sequence[JobCallbackProtocol] = (),
|
|
1058
1077
|
resume: ResumePolicy = ResumePolicy.AUTO,
|
|
1059
|
-
|
|
1078
|
+
system: Optional[SystemType] = None,
|
|
1060
1079
|
timeout: Optional[int] = None,
|
|
1061
1080
|
retries: int = 0,
|
|
1062
1081
|
**extra: Any,
|
|
1063
1082
|
) -> Union[JobFunction, Callable[[F], JobFunction]]:
|
|
1064
1083
|
"""Register a function as a job of this app. Records metadata; never runs the body.
|
|
1065
1084
|
|
|
1066
|
-
Usable bare (``@app.job``) or with options
|
|
1085
|
+
Usable bare (``@app.job``) or with options
|
|
1086
|
+
(``@app.job(system=simulo.SystemType.TIER_1)``).
|
|
1067
1087
|
Returns a :class:`JobFunction` wrapping the original function — calling
|
|
1068
1088
|
it still runs the body in-process; ``.spawn()`` / ``.submit()`` submit it
|
|
1069
1089
|
to the platform instead.
|
|
@@ -1077,8 +1097,17 @@ class App:
|
|
|
1077
1097
|
resume: How the job resumes from a discovered checkpoint
|
|
1078
1098
|
(:class:`~simulo.interfaces.platform.enums.ResumePolicy`,
|
|
1079
1099
|
default ``AUTO``).
|
|
1080
|
-
|
|
1081
|
-
|
|
1100
|
+
system: The GPU system tier to request, as a
|
|
1101
|
+
:class:`simulo.SystemType` member (e.g.
|
|
1102
|
+
``simulo.SystemType.TIER_1``), recorded in the job's resource
|
|
1103
|
+
spec as ``resources["system"]`` (the tier's wire value, e.g.
|
|
1104
|
+
``"tier1"``). Validated HERE, at decoration time, against the
|
|
1105
|
+
published catalog: a value that is not a ``SystemType`` member
|
|
1106
|
+
(a raw string such as ``"tier1"`` included) raises
|
|
1107
|
+
``TypeError``, and a tier the platform cannot provision yet
|
|
1108
|
+
raises ``ValueError``. ``simulo systems`` lists every tier and
|
|
1109
|
+
which are available today. The selection is recorded on the
|
|
1110
|
+
job; it does not yet choose hardware.
|
|
1082
1111
|
timeout: Wall-clock limit for one managed execution, in seconds
|
|
1083
1112
|
(a positive integer; validated HERE, at decoration time — a
|
|
1084
1113
|
zero, negative, or non-integer value raises ``ValueError``
|
|
@@ -1094,13 +1123,15 @@ class App:
|
|
|
1094
1123
|
retries: Automatic re-attempts after a failure (default 0). All
|
|
1095
1124
|
attempts share one ``timeout`` budget.
|
|
1096
1125
|
**extra: Additional resource requests, recorded verbatim in the
|
|
1097
|
-
job's resource spec.
|
|
1098
|
-
``produces`` and ``
|
|
1099
|
-
else passes through to the resource spec unchanged.
|
|
1126
|
+
job's resource spec. Three names are RESERVED and rejected —
|
|
1127
|
+
``produces``, ``consumes`` and ``gpu`` (see Raises below);
|
|
1128
|
+
everything else passes through to the resource spec unchanged.
|
|
1100
1129
|
|
|
1101
1130
|
Raises:
|
|
1102
1131
|
ValueError: ``timeout`` is not ``None`` and is not a positive
|
|
1103
1132
|
integer. ``True`` and ``False`` are not accepted as timeouts.
|
|
1133
|
+
Also raised when ``system`` names a tier the platform cannot
|
|
1134
|
+
provision yet (``SYSTEM_SPECS[system].available`` is false).
|
|
1104
1135
|
TypeError: ``produces=`` or ``consumes=`` was passed. Outputs are
|
|
1105
1136
|
not declared on the decorator. Callbacks such as
|
|
1106
1137
|
``ResumableCheckpoint`` already declare their supported
|
|
@@ -1108,6 +1139,11 @@ class App:
|
|
|
1108
1139
|
volume for files another job needs. ``consumes=`` is reserved;
|
|
1109
1140
|
continue from a checkpoint with
|
|
1110
1141
|
``simulo run --from <job>[:latest|:best]`` instead.
|
|
1142
|
+
Also raised for ``gpu=`` (the free-text GPU request this
|
|
1143
|
+
parameter replaced; it would otherwise fall through
|
|
1144
|
+
``**extra`` into the resource spec unvalidated) and for a
|
|
1145
|
+
``system`` value that is not a :class:`simulo.SystemType`
|
|
1146
|
+
member.
|
|
1111
1147
|
"""
|
|
1112
1148
|
if timeout is not None and (isinstance(timeout, bool) or not isinstance(timeout, int) or timeout < 1):
|
|
1113
1149
|
raise ValueError(
|
|
@@ -1127,11 +1163,44 @@ class App:
|
|
|
1127
1163
|
"today. To chain jobs, run with `simulo run --from <job>[:latest|:best]`. Remove "
|
|
1128
1164
|
"consumes=."
|
|
1129
1165
|
)
|
|
1166
|
+
# ``gpu`` was a real named parameter until the system-tier catalog
|
|
1167
|
+
# replaced it (#1362). Removing it from the signature alone does NOT
|
|
1168
|
+
# reject ``gpu="L4"``: CPython routes the unknown keyword into
|
|
1169
|
+
# ``**extra`` and it would land in the resource spec exactly as before,
|
|
1170
|
+
# unvalidated. This guard is what makes the rename a rejection.
|
|
1171
|
+
if "gpu" in extra:
|
|
1172
|
+
raise TypeError(
|
|
1173
|
+
"@app.job(gpu=...) is no longer supported. Request a GPU system tier instead: "
|
|
1174
|
+
"@app.job(system=simulo.SystemType.TIER_1). Run `simulo systems` to list the "
|
|
1175
|
+
"tiers and which are available today. Remove gpu=."
|
|
1176
|
+
)
|
|
1177
|
+
if system is not None:
|
|
1178
|
+
# Static lookups against the published catalog — no fleet state
|
|
1179
|
+
# is consulted. A raw string is refused even when it spells a
|
|
1180
|
+
# valid wire value, so the one accepted spelling is the enum.
|
|
1181
|
+
if not isinstance(system, SystemType):
|
|
1182
|
+
raise TypeError(
|
|
1183
|
+
"@app.job(system=...) must be a simulo.SystemType member, e.g. "
|
|
1184
|
+
f"system=simulo.SystemType.TIER_1; got {system!r}. Run `simulo systems` to "
|
|
1185
|
+
"list the tiers."
|
|
1186
|
+
)
|
|
1187
|
+
spec = SYSTEM_SPECS[system]
|
|
1188
|
+
if not spec.available:
|
|
1189
|
+
available = ", ".join(
|
|
1190
|
+
f"SystemType.{tier.name} ({entry.gpu_model})"
|
|
1191
|
+
for tier, entry in SYSTEM_SPECS.items()
|
|
1192
|
+
if entry.available
|
|
1193
|
+
)
|
|
1194
|
+
raise ValueError(
|
|
1195
|
+
f"@app.job(system=SystemType.{system.name}) ({spec.gpu_model}) is not available on "
|
|
1196
|
+
f"the platform yet. Available today: {available}. Run `simulo systems` for the "
|
|
1197
|
+
"full catalog."
|
|
1198
|
+
)
|
|
1130
1199
|
|
|
1131
1200
|
def decorate(func: F) -> JobFunction:
|
|
1132
1201
|
resources: dict[str, Any] = {}
|
|
1133
|
-
if
|
|
1134
|
-
resources["
|
|
1202
|
+
if system is not None:
|
|
1203
|
+
resources["system"] = system.value
|
|
1135
1204
|
resources.update(extra)
|
|
1136
1205
|
spec = JobSpec(
|
|
1137
1206
|
name=func.__name__,
|
|
@@ -53,6 +53,18 @@ the packaged ``src/`` layout and never reaches a real ``pip install simulo``
|
|
|
53
53
|
user. No network call, no auth — this only touches the local filesystem and the
|
|
54
54
|
wheel's own bundled resources.
|
|
55
55
|
|
|
56
|
+
``simulo install samples`` clones the public sample collection into
|
|
57
|
+
``./simulo-samples`` with normal Git history. It uses neither client settings nor
|
|
58
|
+
saved sign-in state; a failed clone is removed before it can appear at that path.
|
|
59
|
+
|
|
60
|
+
``simulo systems [--json]`` lists the published GPU system tiers (``SystemType`` /
|
|
61
|
+
``SYSTEM_SPECS`` from ``simulo-interfaces``) that ``@app.job(system=...)`` accepts —
|
|
62
|
+
table or ``--json``. This reads only that static, in-package catalog: no client
|
|
63
|
+
construction, no credential resolution, no network call. Today's fleet is one shared
|
|
64
|
+
machine, so the listing is descriptive rather than a live capability check — the
|
|
65
|
+
tier a job requests is recorded on the job, not scheduled against, and the table's
|
|
66
|
+
own footer says so.
|
|
67
|
+
|
|
56
68
|
**Auth** (``simulo login`` / ``logout`` / ``whoami``) drives the OAuth 2.0 +
|
|
57
69
|
PKCE loopback flow and manages
|
|
58
70
|
``~/.simulo/credentials``.
|
|
@@ -182,6 +194,7 @@ from simulo._client.discovery import discover, import_app_module
|
|
|
182
194
|
from simulo._client.export_api import DEFAULT_EXPORT_FORMAT, ExportApiClient, ExportApiError
|
|
183
195
|
from simulo._client.export_bundle import PolicyBundleError, extract_policy_bundle
|
|
184
196
|
from simulo._client.identity_api import IdentityApiClient, IdentityApiError
|
|
197
|
+
from simulo._client.install_samples import InstallSamplesError, InstallSamplesUsageError, install_samples
|
|
185
198
|
from simulo._client.jobs_api import JobsApiClient, JobsApiError, JobsApiHTTPError, JobsApiUnavailable
|
|
186
199
|
from simulo._client.login import LoginError, perform_login
|
|
187
200
|
from simulo._client.mode import DISCOVERY
|
|
@@ -209,6 +222,7 @@ from simulo.interfaces.ids import (
|
|
|
209
222
|
parse_output_public_id,
|
|
210
223
|
parse_recording_public_id,
|
|
211
224
|
)
|
|
225
|
+
from simulo.interfaces.platform import SYSTEM_SPECS, SystemType
|
|
212
226
|
from simulo.interfaces.platform.asset_catalog import (
|
|
213
227
|
ASSET_ARCHIVE_TOO_LARGE_CODE,
|
|
214
228
|
ASSET_KINDS,
|
|
@@ -6977,6 +6991,77 @@ def _print_table(headers: tuple[str, ...], rows: Sequence[tuple[str, ...]]) -> N
|
|
|
6977
6991
|
print(" ".join(cell.ljust(width) for cell, width in zip(line, widths)).rstrip())
|
|
6978
6992
|
|
|
6979
6993
|
|
|
6994
|
+
#: One line, plain language, no jargon: forecloses the exact misreading issue
|
|
6995
|
+
#: #1512 documents in the wild (the samples repository's "no GPU requested"
|
|
6996
|
+
#: silently being read as "schedules faster" — untrue on a single-fleet
|
|
6997
|
+
#: platform). A numbered tier ladder invites the identical misreading in the
|
|
6998
|
+
#: other direction — "higher tier, faster/better scheduling" — for
|
|
6999
|
+
#: ``system=SystemType.TIER_4``, so this explicitly rules out BOTH readings,
|
|
7000
|
+
#: not just states the record-only fact and hopes the reader draws the right
|
|
7001
|
+
#: conclusion. Printed by the table view only: ``--json`` is a machine
|
|
7002
|
+
#: contract and never carries prose.
|
|
7003
|
+
_SYSTEMS_FOOTER = (
|
|
7004
|
+
"Your `system=` choice is recorded on the job. It does not select your hardware today: "
|
|
7005
|
+
"no tier schedules faster or trains better than another, and neither does leaving "
|
|
7006
|
+
"`system=` out entirely."
|
|
7007
|
+
)
|
|
7008
|
+
|
|
7009
|
+
|
|
7010
|
+
def _system_tier_label(system: SystemType) -> str:
|
|
7011
|
+
"""The human-facing tier label for the table view, e.g. ``SystemType.TIER_1`` ->
|
|
7012
|
+
``"Tier 1 (tier1)"``. The parenthesized wire value is the exact string
|
|
7013
|
+
``system=`` accepts (what ``--json`` prints under the ``"system"`` key);
|
|
7014
|
+
the table would otherwise show a reader nothing they could type."""
|
|
7015
|
+
return f"{system.name.replace('_', ' ').title()} ({system.value})"
|
|
7016
|
+
|
|
7017
|
+
|
|
7018
|
+
def _cmd_systems(args: argparse.Namespace) -> int:
|
|
7019
|
+
"""``simulo systems [--json]`` — list the published GPU system tiers.
|
|
7020
|
+
|
|
7021
|
+
Reads only the static, in-package ``SYSTEM_SPECS`` catalog from
|
|
7022
|
+
``simulo-interfaces``: no client construction, no credential resolution,
|
|
7023
|
+
no network call of any kind. Always lists all four tiers, including the
|
|
7024
|
+
two not yet available — the point is to show what exists and what the
|
|
7025
|
+
fleet can provision TODAY, not to hide the rest.
|
|
7026
|
+
|
|
7027
|
+
The raw AWS SKU behind a tier never appears in either output — the whole
|
|
7028
|
+
reason this catalog names abstract tiers instead of a hardware SKU (see
|
|
7029
|
+
``SystemSpec``'s own docstring for the field that stays off every
|
|
7030
|
+
user-facing surface, including this one).
|
|
7031
|
+
"""
|
|
7032
|
+
if args.json:
|
|
7033
|
+
records = [
|
|
7034
|
+
{
|
|
7035
|
+
"system": system.value,
|
|
7036
|
+
"gpu_model": spec.gpu_model,
|
|
7037
|
+
"vram_gb": spec.vram_gb,
|
|
7038
|
+
"vcpu": spec.vcpu,
|
|
7039
|
+
"memory_gb": spec.memory_gb,
|
|
7040
|
+
"max_parallel_envs": spec.max_parallel_envs,
|
|
7041
|
+
"available": spec.available,
|
|
7042
|
+
}
|
|
7043
|
+
for system, spec in SYSTEM_SPECS.items()
|
|
7044
|
+
]
|
|
7045
|
+
print(json.dumps(records, indent=2))
|
|
7046
|
+
return 0
|
|
7047
|
+
|
|
7048
|
+
rows = [
|
|
7049
|
+
(
|
|
7050
|
+
_system_tier_label(system),
|
|
7051
|
+
spec.gpu_model,
|
|
7052
|
+
f"{spec.vram_gb} GB",
|
|
7053
|
+
str(spec.vcpu),
|
|
7054
|
+
f"{spec.memory_gb} GB",
|
|
7055
|
+
str(spec.max_parallel_envs) if spec.max_parallel_envs is not None else "not yet measured",
|
|
7056
|
+
"available" if spec.available else "not yet available",
|
|
7057
|
+
)
|
|
7058
|
+
for system, spec in SYSTEM_SPECS.items()
|
|
7059
|
+
]
|
|
7060
|
+
_print_table(("TIER", "GPU MODEL", "VRAM", "VCPU", "MEMORY", "MAX PARALLEL ENVS", "STATUS"), rows)
|
|
7061
|
+
print(_SYSTEMS_FOOTER)
|
|
7062
|
+
return 0
|
|
7063
|
+
|
|
7064
|
+
|
|
6980
7065
|
#: The frozen local-development cache root for ``simulo asset get``:
|
|
6981
7066
|
#: ``~/.simulo/assets/<org>/<kind>/<name>/v<N>/`` — colon-free segments,
|
|
6982
7067
|
#: NTFS-safe. Mirrors ``credentials.CREDENTIALS_PATH``'s
|
|
@@ -8008,7 +8093,7 @@ def _build_parser() -> argparse.ArgumentParser:
|
|
|
8008
8093
|
prog="simulo",
|
|
8009
8094
|
description=(
|
|
8010
8095
|
"Simulo thin client — submit an app to the Simulo cloud and observe its runs "
|
|
8011
|
-
"(simulo jobs / logs / result / recordings / models / outputs / export / view / cancel)."
|
|
8096
|
+
"(simulo systems / jobs / logs / result / recordings / models / outputs / export / view / cancel)."
|
|
8012
8097
|
),
|
|
8013
8098
|
)
|
|
8014
8099
|
# ``action="version"`` fires (prints + exits 0) while argparse is still
|
|
@@ -8260,6 +8345,38 @@ def _build_parser() -> argparse.ArgumentParser:
|
|
|
8260
8345
|
|
|
8261
8346
|
create.set_defaults(func=_handle_create)
|
|
8262
8347
|
|
|
8348
|
+
install = sub.add_parser("install", help="Install a curated local collection of Simulo samples.")
|
|
8349
|
+
install_sub = install.add_subparsers(dest="install_command", required=True)
|
|
8350
|
+
samples = install_sub.add_parser(
|
|
8351
|
+
"samples",
|
|
8352
|
+
help="Clone the sample collection into ./simulo-samples with full Git history.",
|
|
8353
|
+
)
|
|
8354
|
+
|
|
8355
|
+
def _handle_install_samples(args: argparse.Namespace, extras: Sequence[str]) -> int:
|
|
8356
|
+
if extras:
|
|
8357
|
+
samples.error(f"unrecognized arguments: {' '.join(extras)}")
|
|
8358
|
+
try:
|
|
8359
|
+
installed = install_samples(Path.cwd())
|
|
8360
|
+
except InstallSamplesUsageError as exc:
|
|
8361
|
+
print(f"error: {exc}", file=sys.stderr)
|
|
8362
|
+
print("Nothing was installed.", file=sys.stderr)
|
|
8363
|
+
return 2
|
|
8364
|
+
except InstallSamplesError as exc:
|
|
8365
|
+
print(f"error: {exc}", file=sys.stderr)
|
|
8366
|
+
print("Nothing was installed.", file=sys.stderr)
|
|
8367
|
+
return 1
|
|
8368
|
+
print(
|
|
8369
|
+
f"Installed the Simulo samples in {installed.path} "
|
|
8370
|
+
"(a normal Git clone: history, branches, and git pull all work)."
|
|
8371
|
+
)
|
|
8372
|
+
print("Next steps:")
|
|
8373
|
+
print(" cd simulo-samples")
|
|
8374
|
+
print(" cat README.md")
|
|
8375
|
+
print("README.md is the sample index; each sample folder has its own app.py to run with simulo run.")
|
|
8376
|
+
return 0
|
|
8377
|
+
|
|
8378
|
+
samples.set_defaults(func=_handle_install_samples)
|
|
8379
|
+
|
|
8263
8380
|
# -- simulo asset (the FIRST nested subcommand group in this CLI) --------
|
|
8264
8381
|
asset = sub.add_parser(
|
|
8265
8382
|
"asset",
|
|
@@ -8720,6 +8837,20 @@ def _build_parser() -> argparse.ArgumentParser:
|
|
|
8720
8837
|
)
|
|
8721
8838
|
models.set_defaults(func=_observe_handler(models, _cmd_models))
|
|
8722
8839
|
|
|
8840
|
+
systems = sub.add_parser(
|
|
8841
|
+
"systems",
|
|
8842
|
+
help=(
|
|
8843
|
+
"List the published GPU system tiers `@app.job(system=...)` accepts — table or "
|
|
8844
|
+
"--json. Reads only the in-package catalog: no network call."
|
|
8845
|
+
),
|
|
8846
|
+
)
|
|
8847
|
+
systems.add_argument(
|
|
8848
|
+
"--json",
|
|
8849
|
+
action="store_true",
|
|
8850
|
+
help="Print the tier catalog as a JSON array instead of a table (automation-friendly).",
|
|
8851
|
+
)
|
|
8852
|
+
systems.set_defaults(func=_observe_handler(systems, _cmd_systems))
|
|
8853
|
+
|
|
8723
8854
|
# `simulo export` — one command, no arguments, on the happy path. Every
|
|
8724
8855
|
# option below overrides a default that was already correct (#654): the
|
|
8725
8856
|
# latest job, its best checkpoint, ONNX, download, unpack. A new REQUIRED
|
|
@@ -0,0 +1,267 @@
|
|
|
1
|
+
"""Install the public Simulo sample collection with a normal Git clone."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
import os
|
|
6
|
+
import shutil
|
|
7
|
+
import subprocess
|
|
8
|
+
import sys
|
|
9
|
+
from dataclasses import dataclass
|
|
10
|
+
from pathlib import Path
|
|
11
|
+
|
|
12
|
+
SAMPLES_REPOSITORY_URL = "https://github.com/simulo-org/simulo-samples.git"
|
|
13
|
+
DEFAULT_SAMPLES_DIRECTORY_NAME = "simulo-samples"
|
|
14
|
+
CLONE_TIMEOUT_S = 300
|
|
15
|
+
_MAX_GIT_STDERR_INPUT_BYTES = 4096
|
|
16
|
+
_MAX_GIT_STDERR_RENDERED_BYTES = 4096
|
|
17
|
+
_GIT_OUTPUT_PREFIX = " | git: "
|
|
18
|
+
_GIT_PROGRESS_PREFIXES = (
|
|
19
|
+
"Cloning into ",
|
|
20
|
+
"Receiving objects:",
|
|
21
|
+
"Resolving deltas:",
|
|
22
|
+
"remote: Enumerating objects:",
|
|
23
|
+
"remote: Counting objects:",
|
|
24
|
+
"remote: Compressing objects:",
|
|
25
|
+
"remote: Total ",
|
|
26
|
+
)
|
|
27
|
+
|
|
28
|
+
|
|
29
|
+
class InstallSamplesError(RuntimeError):
|
|
30
|
+
"""Raised when the samples cannot be installed."""
|
|
31
|
+
|
|
32
|
+
|
|
33
|
+
class InstallSamplesUsageError(ValueError):
|
|
34
|
+
"""Raised when the requested install destination is unsafe to use."""
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
@dataclass(frozen=True)
|
|
38
|
+
class InstalledSamples:
|
|
39
|
+
"""The local sample collection created by :func:`install_samples`."""
|
|
40
|
+
|
|
41
|
+
path: Path
|
|
42
|
+
|
|
43
|
+
|
|
44
|
+
def _git_environment() -> dict[str, str]:
|
|
45
|
+
"""Return a non-interactive environment for a public clone."""
|
|
46
|
+
environment = dict(os.environ)
|
|
47
|
+
for key in tuple(environment):
|
|
48
|
+
if any(fragment in key.upper() for fragment in ("TOKEN", "SECRET", "CREDENTIAL")):
|
|
49
|
+
environment.pop(key)
|
|
50
|
+
environment.pop("GIT_CONFIG_PARAMETERS", None)
|
|
51
|
+
environment.update(
|
|
52
|
+
{
|
|
53
|
+
"GIT_TERMINAL_PROMPT": "0",
|
|
54
|
+
"GIT_ASKPASS": "",
|
|
55
|
+
"GCM_INTERACTIVE": "never",
|
|
56
|
+
"GIT_CONFIG_COUNT": "1",
|
|
57
|
+
"GIT_CONFIG_KEY_0": "credential.helper",
|
|
58
|
+
"GIT_CONFIG_VALUE_0": "",
|
|
59
|
+
}
|
|
60
|
+
)
|
|
61
|
+
return environment
|
|
62
|
+
|
|
63
|
+
|
|
64
|
+
def _run_git(argv: list[str], *, timeout_s: int, env: dict[str, str]) -> subprocess.CompletedProcess[str]:
|
|
65
|
+
"""Run Git through the one seam tests replace."""
|
|
66
|
+
return subprocess.run(argv, capture_output=True, check=False, env=env, text=True, timeout=timeout_s)
|
|
67
|
+
|
|
68
|
+
|
|
69
|
+
def _stderr_tail(stderr: str | bytes | None) -> str:
|
|
70
|
+
if isinstance(stderr, bytes):
|
|
71
|
+
stderr = stderr.decode(errors="replace")
|
|
72
|
+
if not stderr:
|
|
73
|
+
return ""
|
|
74
|
+
encoded = stderr.encode("utf-8", errors="replace")
|
|
75
|
+
bounded_bytes = encoded[-_MAX_GIT_STDERR_INPUT_BYTES:]
|
|
76
|
+
was_truncated = len(bounded_bytes) < len(encoded)
|
|
77
|
+
bounded = bounded_bytes.decode("utf-8", errors="replace")
|
|
78
|
+
lines = bounded.splitlines()
|
|
79
|
+
starts_mid_line = was_truncated and encoded[-_MAX_GIT_STDERR_INPUT_BYTES - 1] not in (ord("\n"), ord("\r"))
|
|
80
|
+
if starts_mid_line and len(lines) > 1:
|
|
81
|
+
lines = lines[1:]
|
|
82
|
+
non_progress_lines = [line for line in lines if not line.startswith(_GIT_PROGRESS_PREFIXES)]
|
|
83
|
+
return _quote_git_output(non_progress_lines[-10:])
|
|
84
|
+
|
|
85
|
+
|
|
86
|
+
def _quote_git_output(lines: list[str]) -> str:
|
|
87
|
+
"""Prefix Git output without exceeding the CLI's rendered stderr bound."""
|
|
88
|
+
output: list[str] = []
|
|
89
|
+
output_bytes = 0
|
|
90
|
+
prefix_bytes = len(_GIT_OUTPUT_PREFIX.encode("utf-8"))
|
|
91
|
+
for line in reversed(lines):
|
|
92
|
+
printable_line = "".join(character for character in line if character.isprintable())
|
|
93
|
+
quoted_line = f"{_GIT_OUTPUT_PREFIX}{printable_line}"
|
|
94
|
+
quoted_line_bytes = len(quoted_line.encode("utf-8", errors="replace"))
|
|
95
|
+
separator_bytes = 1 if output else 0
|
|
96
|
+
if output_bytes + separator_bytes + quoted_line_bytes <= _MAX_GIT_STDERR_RENDERED_BYTES:
|
|
97
|
+
output.insert(0, quoted_line)
|
|
98
|
+
output_bytes += separator_bytes + quoted_line_bytes
|
|
99
|
+
elif not output:
|
|
100
|
+
available_line_bytes = _MAX_GIT_STDERR_RENDERED_BYTES - prefix_bytes
|
|
101
|
+
output.append(
|
|
102
|
+
_GIT_OUTPUT_PREFIX
|
|
103
|
+
+ printable_line.encode("utf-8", errors="replace")[-available_line_bytes:].decode(errors="ignore")
|
|
104
|
+
)
|
|
105
|
+
break
|
|
106
|
+
else:
|
|
107
|
+
break
|
|
108
|
+
return "\n".join(output)
|
|
109
|
+
|
|
110
|
+
|
|
111
|
+
def _remove_read_only_path(function: object, path: str, _exc_info: object) -> None:
|
|
112
|
+
"""Make Windows Git object files writable, then retry rmtree's operation."""
|
|
113
|
+
# Known and owned Windows residual: this misses directory junctions, which Python 3.11 rmtree can follow; staging
|
|
114
|
+
# access follows inherited ACLs.
|
|
115
|
+
if not os.path.islink(path):
|
|
116
|
+
os.chmod(path, 0o700)
|
|
117
|
+
function(path) # type: ignore[operator]
|
|
118
|
+
|
|
119
|
+
|
|
120
|
+
def _directory_identity(path: Path) -> tuple[int, int]:
|
|
121
|
+
status = path.stat()
|
|
122
|
+
return status.st_dev, status.st_ino
|
|
123
|
+
|
|
124
|
+
|
|
125
|
+
def _remove_staging_directory(staging: Path, identity: tuple[int, int]) -> None:
|
|
126
|
+
try:
|
|
127
|
+
current_identity = _directory_identity(staging)
|
|
128
|
+
except FileNotFoundError:
|
|
129
|
+
return
|
|
130
|
+
except OSError:
|
|
131
|
+
print(f"warning: could not inspect partial samples install at {staging}", file=sys.stderr)
|
|
132
|
+
return
|
|
133
|
+
if current_identity != identity:
|
|
134
|
+
print(f"warning: partial samples install path no longer belongs to this invocation: {staging}", file=sys.stderr)
|
|
135
|
+
return
|
|
136
|
+
try:
|
|
137
|
+
shutil.rmtree(staging, onerror=_remove_read_only_path)
|
|
138
|
+
except OSError:
|
|
139
|
+
print(f"warning: could not remove partial samples install at {staging}", file=sys.stderr)
|
|
140
|
+
|
|
141
|
+
|
|
142
|
+
def _clone_failure(
|
|
143
|
+
reason: str, stderr: str | bytes | None, *, explain_public_repository: bool = False
|
|
144
|
+
) -> InstallSamplesError:
|
|
145
|
+
tail = _stderr_tail(stderr)
|
|
146
|
+
explanation = (
|
|
147
|
+
"The samples repository is public and this command does not sign in.\n"
|
|
148
|
+
"An authentication error means Git could not reach the repository or its host, not that there is a problem "
|
|
149
|
+
"with your account."
|
|
150
|
+
)
|
|
151
|
+
message = f"{reason}\n{tail}" if tail else reason
|
|
152
|
+
if explain_public_repository:
|
|
153
|
+
message = f"{message}\n{explanation}"
|
|
154
|
+
return InstallSamplesError(message)
|
|
155
|
+
|
|
156
|
+
|
|
157
|
+
def _target_exists_error(target: Path) -> InstallSamplesUsageError:
|
|
158
|
+
if not target.is_dir():
|
|
159
|
+
return InstallSamplesUsageError(f"{target} exists and is not a directory.")
|
|
160
|
+
return InstallSamplesUsageError(f"{target} already exists.")
|
|
161
|
+
|
|
162
|
+
|
|
163
|
+
def _git_is_reachable_through_working_directory(
|
|
164
|
+
named_git_path: Path, git_executable: Path, working_directory: Path
|
|
165
|
+
) -> bool:
|
|
166
|
+
"""Return whether resolving Git depends on the current working directory."""
|
|
167
|
+
return not named_git_path.is_absolute() or working_directory in {
|
|
168
|
+
named_git_path.parent,
|
|
169
|
+
named_git_path.parent.resolve(),
|
|
170
|
+
git_executable.parent,
|
|
171
|
+
}
|
|
172
|
+
|
|
173
|
+
|
|
174
|
+
def _clone_has_sample_files(staging: Path) -> bool:
|
|
175
|
+
"""Return whether a successful clone produced a user-visible worktree entry.
|
|
176
|
+
|
|
177
|
+
An unreadable staging directory counts as no sample files. This is the only
|
|
178
|
+
filesystem read on the success path, and letting an OSError escape here would
|
|
179
|
+
abandon the staging directory and break the promise that a failed install
|
|
180
|
+
leaves nothing behind.
|
|
181
|
+
"""
|
|
182
|
+
try:
|
|
183
|
+
return any(entry.name != ".git" for entry in staging.iterdir())
|
|
184
|
+
except OSError:
|
|
185
|
+
return False
|
|
186
|
+
|
|
187
|
+
|
|
188
|
+
def install_samples(
|
|
189
|
+
parent_directory: Path,
|
|
190
|
+
*,
|
|
191
|
+
repository_url: str = SAMPLES_REPOSITORY_URL,
|
|
192
|
+
directory_name: str = DEFAULT_SAMPLES_DIRECTORY_NAME,
|
|
193
|
+
timeout_s: int = CLONE_TIMEOUT_S,
|
|
194
|
+
) -> InstalledSamples:
|
|
195
|
+
"""Clone samples into *parent_directory* and reveal them atomically."""
|
|
196
|
+
target = parent_directory / directory_name
|
|
197
|
+
if target.exists():
|
|
198
|
+
raise _target_exists_error(target)
|
|
199
|
+
|
|
200
|
+
git_path = shutil.which("git")
|
|
201
|
+
if git_path is None:
|
|
202
|
+
raise InstallSamplesError(
|
|
203
|
+
"Git is required to install samples. Get it from https://git-scm.com/downloads and try again."
|
|
204
|
+
)
|
|
205
|
+
named_git_path = Path(git_path)
|
|
206
|
+
working_directory = Path.cwd().resolve()
|
|
207
|
+
git_executable = named_git_path.resolve()
|
|
208
|
+
if _git_is_reachable_through_working_directory(named_git_path, git_executable, working_directory):
|
|
209
|
+
raise InstallSamplesError(
|
|
210
|
+
f"Refusing resolved Git executable {git_executable}: its PATH entry is relative to or resolves through "
|
|
211
|
+
"the current working directory. Run this command from a different directory, or use a Git executable "
|
|
212
|
+
"outside the working directory."
|
|
213
|
+
)
|
|
214
|
+
|
|
215
|
+
staging = parent_directory / f".{directory_name}.partial-{os.getpid()}"
|
|
216
|
+
try:
|
|
217
|
+
staging.mkdir()
|
|
218
|
+
except FileExistsError:
|
|
219
|
+
raise InstallSamplesError(f"Partial samples install path already exists: {staging}.") from None
|
|
220
|
+
except OSError as exc:
|
|
221
|
+
reason = exc.strerror or str(exc)
|
|
222
|
+
raise InstallSamplesError(f"Could not prepare samples install at {staging}: {reason}.") from None
|
|
223
|
+
staging_identity = _directory_identity(staging)
|
|
224
|
+
|
|
225
|
+
print("Cloning the samples with full history; this can take a minute.", file=sys.stderr)
|
|
226
|
+
argv = [str(git_executable), "clone", "--", repository_url, str(staging)]
|
|
227
|
+
try:
|
|
228
|
+
completed = _run_git(argv, timeout_s=timeout_s, env=_git_environment())
|
|
229
|
+
except subprocess.TimeoutExpired as exc:
|
|
230
|
+
_remove_staging_directory(staging, staging_identity)
|
|
231
|
+
raise _clone_failure(
|
|
232
|
+
f"Git clone timed out after {timeout_s} seconds. "
|
|
233
|
+
f"If your connection needs longer, clone it by hand with git clone {repository_url}.",
|
|
234
|
+
exc.stderr,
|
|
235
|
+
) from None
|
|
236
|
+
except KeyboardInterrupt:
|
|
237
|
+
_remove_staging_directory(staging, staging_identity)
|
|
238
|
+
raise
|
|
239
|
+
except OSError as exc:
|
|
240
|
+
_remove_staging_directory(staging, staging_identity)
|
|
241
|
+
reason = exc.strerror or str(exc)
|
|
242
|
+
raise InstallSamplesError(f"Could not start Git clone: {reason}.") from None
|
|
243
|
+
|
|
244
|
+
if completed.returncode != 0:
|
|
245
|
+
_remove_staging_directory(staging, staging_identity)
|
|
246
|
+
raise _clone_failure(
|
|
247
|
+
f"Git clone failed with exit code {completed.returncode}.",
|
|
248
|
+
completed.stderr,
|
|
249
|
+
explain_public_repository=True,
|
|
250
|
+
)
|
|
251
|
+
|
|
252
|
+
if not _clone_has_sample_files(staging):
|
|
253
|
+
_remove_staging_directory(staging, staging_identity)
|
|
254
|
+
raise _clone_failure("Git clone produced an empty working tree.", completed.stderr)
|
|
255
|
+
|
|
256
|
+
if target.exists():
|
|
257
|
+
_remove_staging_directory(staging, staging_identity)
|
|
258
|
+
raise _target_exists_error(target)
|
|
259
|
+
|
|
260
|
+
try:
|
|
261
|
+
os.rename(staging, target)
|
|
262
|
+
except OSError as exc:
|
|
263
|
+
_remove_staging_directory(staging, staging_identity)
|
|
264
|
+
reason = exc.strerror or str(exc)
|
|
265
|
+
raise InstallSamplesError(f"Could not finish installing samples: {reason}.") from None
|
|
266
|
+
|
|
267
|
+
return InstalledSamples(path=target.resolve())
|
|
@@ -420,6 +420,7 @@ class SubmitApiClient:
|
|
|
420
420
|
seed_from_job_id: Optional[str] = None,
|
|
421
421
|
assets: Optional[list[dict[str, str]]] = None,
|
|
422
422
|
app_name: Optional[str] = None,
|
|
423
|
+
system: Optional[str] = None,
|
|
423
424
|
) -> dict[str, Any]:
|
|
424
425
|
"""``POST /v1/jobs`` — create the job that executes *package_id*.
|
|
425
426
|
|
|
@@ -441,6 +442,14 @@ class SubmitApiClient:
|
|
|
441
442
|
predates the live-visualization plan's ``JobSubmitRequest`` field
|
|
442
443
|
simply ignores an absent key, same as it ignores any unknown field.
|
|
443
444
|
|
|
445
|
+
``system`` (system-tier-catalog-1362, M50-persistence) is the
|
|
446
|
+
already-validated tier wire value (e.g. ``"tier1"``) from the job's
|
|
447
|
+
own manifest ``resources["system"]`` — an OPTIONAL top-level sibling
|
|
448
|
+
of ``args`` for the same package-hash-invariance reason as
|
|
449
|
+
``viewstream`` above. Sent only when truthy: a control plane that
|
|
450
|
+
predates this field ignores the extra key, and the run proceeds
|
|
451
|
+
exactly as it did before ``system=`` existed.
|
|
452
|
+
|
|
444
453
|
``seed_from_job_id`` (``simulo run --from``, explicit-run-intent
|
|
445
454
|
plan) follows the exact same sibling-of-``args`` rule for the exact
|
|
446
455
|
same package-hash reason — a seed is a property of THIS submission,
|
|
@@ -500,6 +509,8 @@ class SubmitApiClient:
|
|
|
500
509
|
body["app_name"] = app_name
|
|
501
510
|
if viewstream:
|
|
502
511
|
body["viewstream"] = True
|
|
512
|
+
if system:
|
|
513
|
+
body["system"] = system
|
|
503
514
|
if seed_from_job_id is not None:
|
|
504
515
|
body[_SEED_FROM_JOB_ID_FIELD] = seed_from_job_id
|
|
505
516
|
if assets:
|
|
@@ -209,8 +209,9 @@ def _make_env(num_envs: int) -> Any:
|
|
|
209
209
|
)
|
|
210
210
|
|
|
211
211
|
|
|
212
|
+
# system= picks a GPU tier from the published catalog; run `simulo systems` to see them.
|
|
212
213
|
@app.job(
|
|
213
|
-
|
|
214
|
+
system=simulo.SystemType.TIER_1,
|
|
214
215
|
timeout=8 * 60 * 60,
|
|
215
216
|
retries=2,
|
|
216
217
|
callbacks=[simulo.callbacks.ResumableCheckpoint(every=50)],
|
|
@@ -239,7 +240,7 @@ def train(num_envs: int = 512, max_iterations: int = 20) -> dict[str, Any]:
|
|
|
239
240
|
return {"checkpoint": checkpoint, "policy": policy_path, "num_envs": num_envs, **stats}
|
|
240
241
|
|
|
241
242
|
|
|
242
|
-
@app.job(
|
|
243
|
+
@app.job(system=simulo.SystemType.TIER_1, timeout=2 * 60 * 60)
|
|
243
244
|
def evaluate(num_episodes: int = 10, num_rounds: int = 5) -> dict[str, Any]:
|
|
244
245
|
"""Evaluate the saved checkpoint over several rounds; aggregate with numpy."""
|
|
245
246
|
import json
|
|
@@ -283,7 +284,7 @@ def evaluate(num_episodes: int = 10, num_rounds: int = 5) -> dict[str, Any]:
|
|
|
283
284
|
return {"report": report_path, **report}
|
|
284
285
|
|
|
285
286
|
|
|
286
|
-
@app.job(
|
|
287
|
+
@app.job(system=simulo.SystemType.TIER_1, timeout=1 * 60 * 60)
|
|
287
288
|
def rollout(num_steps: int = 200) -> dict[str, Any]:
|
|
288
289
|
"""Inference path: play the exported TorchScript policy and record it to MCAP.
|
|
289
290
|
|
|
@@ -64,7 +64,8 @@ class {{APP_NAME}}Scenario(simulo.Scenario): # -> ScenarioProtocol at submit, r
|
|
|
64
64
|
app = simulo.App("{{APP_NAME}}")
|
|
65
65
|
|
|
66
66
|
|
|
67
|
-
|
|
67
|
+
# system= picks a GPU tier from the published catalog; run `simulo systems` to see them.
|
|
68
|
+
@app.job(system=simulo.SystemType.TIER_1, timeout=30 * 60)
|
|
68
69
|
def simulate(num_steps: int = 1000, num_envs: int = 4) -> dict[str, Any]:
|
|
69
70
|
"""Run the scenario headless on the worker. EDIT: device / step count / env count.
|
|
70
71
|
|
|
@@ -193,8 +193,9 @@ class {{APP_NAME}}Task(simulo.Task):
|
|
|
193
193
|
# Retries are safe: ResumableCheckpoint declares periodic checkpoints (every 50
|
|
194
194
|
# iterations) and resume defaults to "auto", so a retried / preempted run resumes
|
|
195
195
|
# from the latest checkpoint instead of restarting.
|
|
196
|
+
# system= picks a GPU tier from the published catalog; run `simulo systems` to see them.
|
|
196
197
|
@app.job(
|
|
197
|
-
|
|
198
|
+
system=simulo.SystemType.TIER_1,
|
|
198
199
|
timeout=8 * 60 * 60,
|
|
199
200
|
retries=2,
|
|
200
201
|
callbacks=[simulo.callbacks.ResumableCheckpoint(every=50)],
|
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
Metadata-Version: 2.4
|
|
2
2
|
Name: simulo
|
|
3
|
-
Version: 0.
|
|
3
|
+
Version: 0.26.0
|
|
4
4
|
Summary: Simulo SDK and CLI — define robotics simulation and training apps in Python and run them on the Simulo cloud.
|
|
5
5
|
Author-email: Simulo Team <team@simulo.ai>
|
|
6
6
|
License: BSD-3-Clause
|
|
@@ -15,7 +15,7 @@ Classifier: Programming Language :: Python :: 3.12
|
|
|
15
15
|
Classifier: Typing :: Typed
|
|
16
16
|
Requires-Python: >=3.11
|
|
17
17
|
Description-Content-Type: text/markdown
|
|
18
|
-
Requires-Dist: simulo-interfaces<0.
|
|
18
|
+
Requires-Dist: simulo-interfaces<0.20,>=0.19.0
|
|
19
19
|
Requires-Dist: mcap<2,>=1.3
|
|
20
20
|
Requires-Dist: defusedxml>=0.7.1
|
|
21
21
|
Requires-Dist: usd-core<27,>=26.5
|
|
@@ -71,6 +71,10 @@ required — `simulo create` only writes files to your local folder. Edit
|
|
|
71
71
|
`app.py` for your own robot and task, then see "Log in and submit" below to
|
|
72
72
|
run it.
|
|
73
73
|
|
|
74
|
+
To download a curated collection of runnable projects, use `simulo install samples`.
|
|
75
|
+
It creates `./simulo-samples` as a normal Git clone, so `cd simulo-samples` and
|
|
76
|
+
`cat README.md` open the sample index.
|
|
77
|
+
|
|
74
78
|
### Or write an app by hand
|
|
75
79
|
|
|
76
80
|
```python
|
|
@@ -32,6 +32,7 @@ src/simulo/_client/export_bundle.py
|
|
|
32
32
|
src/simulo/_client/facades.py
|
|
33
33
|
src/simulo/_client/http.py
|
|
34
34
|
src/simulo/_client/identity_api.py
|
|
35
|
+
src/simulo/_client/install_samples.py
|
|
35
36
|
src/simulo/_client/jobs_api.py
|
|
36
37
|
src/simulo/_client/learning.py
|
|
37
38
|
src/simulo/_client/login.py
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|