archeone 0.1.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.
Files changed (92) hide show
  1. archeone-0.1.0/LICENSE +202 -0
  2. archeone-0.1.0/NOTICE +13 -0
  3. archeone-0.1.0/PKG-INFO +181 -0
  4. archeone-0.1.0/README.md +135 -0
  5. archeone-0.1.0/archeone/__init__.py +44 -0
  6. archeone-0.1.0/archeone/_vendor/__init__.py +12 -0
  7. archeone-0.1.0/archeone/_vendor/jaxls/LICENSE +21 -0
  8. archeone-0.1.0/archeone/_vendor/jaxls/__init__.py +103 -0
  9. archeone-0.1.0/archeone/_vendor/jaxls/_analyzed_cost.py +420 -0
  10. archeone-0.1.0/archeone/_vendor/jaxls/_augmented_lagrangian.py +368 -0
  11. archeone-0.1.0/archeone/_vendor/jaxls/_cost.py +374 -0
  12. archeone-0.1.0/archeone/_vendor/jaxls/_covariance.py +179 -0
  13. archeone-0.1.0/archeone/_vendor/jaxls/_lie_group_variables.py +35 -0
  14. archeone-0.1.0/archeone/_vendor/jaxls/_preconditioning.py +131 -0
  15. archeone-0.1.0/archeone/_vendor/jaxls/_problem.py +1053 -0
  16. archeone-0.1.0/archeone/_vendor/jaxls/_py310/__init__.py +0 -0
  17. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_analyzed_cost.py +297 -0
  18. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_augmented_lagrangian.py +268 -0
  19. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_cost.py +185 -0
  20. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_covariance.py +96 -0
  21. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_lie_group_variables.py +56 -0
  22. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_preconditioning.py +114 -0
  23. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_problem.py +722 -0
  24. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_schur.py +914 -0
  25. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_solvers.py +849 -0
  26. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_sparse_matrices.py +198 -0
  27. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_variables.py +292 -0
  28. archeone-0.1.0/archeone/_vendor/jaxls/_py310/_visualization.py +533 -0
  29. archeone-0.1.0/archeone/_vendor/jaxls/_py310/utils.py +113 -0
  30. archeone-0.1.0/archeone/_vendor/jaxls/_schur.py +1210 -0
  31. archeone-0.1.0/archeone/_vendor/jaxls/_solvers.py +1210 -0
  32. archeone-0.1.0/archeone/_vendor/jaxls/_sparse_matrices.py +257 -0
  33. archeone-0.1.0/archeone/_vendor/jaxls/_variables.py +408 -0
  34. archeone-0.1.0/archeone/_vendor/jaxls/_visualization.py +596 -0
  35. archeone-0.1.0/archeone/_vendor/jaxls/utils.py +155 -0
  36. archeone-0.1.0/archeone/_vendor/pyroki/LICENSE +21 -0
  37. archeone-0.1.0/archeone/_vendor/pyroki/__init__.py +4 -0
  38. archeone-0.1.0/archeone/_vendor/pyroki/_residuals/__init__.py +32 -0
  39. archeone-0.1.0/archeone/_vendor/pyroki/_residuals/_pose_residual_analytic_jac.py +258 -0
  40. archeone-0.1.0/archeone/_vendor/pyroki/_residuals/_pose_residual_numerical_jac.py +94 -0
  41. archeone-0.1.0/archeone/_vendor/pyroki/_residuals/_residuals.py +350 -0
  42. archeone-0.1.0/archeone/_vendor/pyroki/_robot.py +178 -0
  43. archeone-0.1.0/archeone/_vendor/pyroki/_robot_urdf_parser.py +462 -0
  44. archeone-0.1.0/archeone/_vendor/pyroki/collision/__init__.py +11 -0
  45. archeone-0.1.0/archeone/_vendor/pyroki/collision/_collision.py +160 -0
  46. archeone-0.1.0/archeone/_vendor/pyroki/collision/_geometry.py +740 -0
  47. archeone-0.1.0/archeone/_vendor/pyroki/collision/_geometry_pairs.py +337 -0
  48. archeone-0.1.0/archeone/_vendor/pyroki/collision/_robot_collision.py +554 -0
  49. archeone-0.1.0/archeone/_vendor/pyroki/collision/_utils.py +113 -0
  50. archeone-0.1.0/archeone/_vendor/pyroki/costs.py +66 -0
  51. archeone-0.1.0/archeone/_vendor/pyroki/utils.py +28 -0
  52. archeone-0.1.0/archeone/_vendor/pyroki/viewer/__init__.py +3 -0
  53. archeone-0.1.0/archeone/_vendor/pyroki/viewer/_batched_urdf.py +175 -0
  54. archeone-0.1.0/archeone/_vendor/pyroki/viewer/_manipulability_ellipse.py +197 -0
  55. archeone-0.1.0/archeone/_vendor/pyroki/viewer/_weight_tuner.py +112 -0
  56. archeone-0.1.0/archeone/client.py +354 -0
  57. archeone-0.1.0/archeone/credentials.py +74 -0
  58. archeone-0.1.0/archeone/errors.py +150 -0
  59. archeone-0.1.0/archeone/ik/__init__.py +6 -0
  60. archeone-0.1.0/archeone/ik/dream_ik/__init__.py +19 -0
  61. archeone-0.1.0/archeone/ik/dream_ik/assets/piper_dual_left.urdf +179 -0
  62. archeone-0.1.0/archeone/ik/dream_ik/assets/piper_dual_right.urdf +179 -0
  63. archeone-0.1.0/archeone/ik/dream_ik/assets/piper_right.urdf +179 -0
  64. archeone-0.1.0/archeone/ik/dream_ik/assets/yam.urdf +221 -0
  65. archeone-0.1.0/archeone/ik/dream_ik/decode.py +194 -0
  66. archeone-0.1.0/archeone/ik/dream_ik/solver.py +923 -0
  67. archeone-0.1.0/archeone/ik/dream_ik/specs.py +655 -0
  68. archeone-0.1.0/archeone/ik/solver.py +528 -0
  69. archeone-0.1.0/archeone/observation.py +124 -0
  70. archeone-0.1.0/archeone/pacing.py +42 -0
  71. archeone-0.1.0/archeone/py.typed +1 -0
  72. archeone-0.1.0/archeone/seam_join.py +182 -0
  73. archeone-0.1.0/archeone/smoothing.py +226 -0
  74. archeone-0.1.0/archeone/transport.py +227 -0
  75. archeone-0.1.0/archeone/window.py +140 -0
  76. archeone-0.1.0/archeone.egg-info/PKG-INFO +181 -0
  77. archeone-0.1.0/archeone.egg-info/SOURCES.txt +90 -0
  78. archeone-0.1.0/archeone.egg-info/dependency_links.txt +1 -0
  79. archeone-0.1.0/archeone.egg-info/requires.txt +21 -0
  80. archeone-0.1.0/archeone.egg-info/top_level.txt +1 -0
  81. archeone-0.1.0/docs/quickstart.md +412 -0
  82. archeone-0.1.0/licenses/dreamlabs-LICENSE +202 -0
  83. archeone-0.1.0/licenses/dreamlabs-NOTICE +60 -0
  84. archeone-0.1.0/licenses/jaxls-LICENSE +21 -0
  85. archeone-0.1.0/licenses/pyroki-LICENSE +21 -0
  86. archeone-0.1.0/pyproject.toml +72 -0
  87. archeone-0.1.0/setup.cfg +4 -0
  88. archeone-0.1.0/tests/test_client.py +101 -0
  89. archeone-0.1.0/tests/test_errors_transport.py +67 -0
  90. archeone-0.1.0/tests/test_observation.py +46 -0
  91. archeone-0.1.0/tests/test_smoothing.py +34 -0
  92. archeone-0.1.0/tests/test_window.py +50 -0
archeone-0.1.0/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
archeone-0.1.0/NOTICE ADDED
@@ -0,0 +1,13 @@
1
+ archeone
2
+ Copyright 2026 DylanUnicorn
3
+
4
+ The synchronous request lifecycle, observation-window algorithm, action pacing,
5
+ seam smoothing, and parts of the transport/error semantics are derived from the
6
+ Dream Labs client (Apache License 2.0, Copyright 2026 Dream Labs).
7
+
8
+ The optional IK implementation vendors Dream's dream_ik solver and assets.
9
+ The jaxls and pyroki packages are MIT-licensed work by Brent Yi and Chung Min
10
+ Kim respectively. Their license texts are in licenses/.
11
+
12
+ See licenses/dreamlabs-NOTICE for the upstream third-party attribution list.
13
+
@@ -0,0 +1,181 @@
1
+ Metadata-Version: 2.4
2
+ Name: archeone
3
+ Version: 0.1.0
4
+ Summary: Synchronous client for ArcheOneBrain embodied inference, with observation windows and optional PiPER IK
5
+ Author: DylanUnicorn
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/DylanUnicorn/archeone
8
+ Project-URL: Repository, https://github.com/DylanUnicorn/archeone
9
+ Project-URL: Issues, https://github.com/DylanUnicorn/archeone/issues
10
+ Keywords: robotics,embodied-ai,vla,policy,piper,archeone
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Programming Language :: Python :: 3
15
+ Classifier: Programming Language :: Python :: 3.10
16
+ Classifier: Programming Language :: Python :: 3.11
17
+ Classifier: Programming Language :: Python :: 3.12
18
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
19
+ Requires-Python: >=3.10
20
+ Description-Content-Type: text/markdown
21
+ License-File: LICENSE
22
+ License-File: licenses/dreamlabs-LICENSE
23
+ License-File: licenses/dreamlabs-NOTICE
24
+ License-File: licenses/jaxls-LICENSE
25
+ License-File: licenses/pyroki-LICENSE
26
+ Requires-Dist: numpy>=1.24
27
+ Requires-Dist: Pillow>=10
28
+ Provides-Extra: dev
29
+ Requires-Dist: pytest>=8; extra == "dev"
30
+ Requires-Dist: build>=1.2; extra == "dev"
31
+ Requires-Dist: twine>=5; extra == "dev"
32
+ Provides-Extra: ik
33
+ Requires-Dist: einops>=0.7; extra == "ik"
34
+ Requires-Dist: jax==0.7.1; extra == "ik"
35
+ Requires-Dist: jax-dataclasses==1.6.3; extra == "ik"
36
+ Requires-Dist: jaxlib==0.7.1; extra == "ik"
37
+ Requires-Dist: jaxlie==1.5.0; extra == "ik"
38
+ Requires-Dist: jaxtyping; extra == "ik"
39
+ Requires-Dist: loguru; extra == "ik"
40
+ Requires-Dist: pydantic>=2; extra == "ik"
41
+ Requires-Dist: scipy>=1.11; extra == "ik"
42
+ Requires-Dist: termcolor; extra == "ik"
43
+ Requires-Dist: typing-extensions>=4.5.0; extra == "ik"
44
+ Requires-Dist: yourdfpy==0.0.60; extra == "ik"
45
+ Dynamic: license-file
46
+
47
+ # archeone
48
+
49
+ `archeone` is a synchronous Python client for **ArcheOneBrain**, an embodied
50
+ inference service reached over the `/v1/get_action` protocol. It keeps the
51
+ observation-window, session, error-envelope, action-pacing, seam-smoothing and
52
+ optional IK behavior that protocol defines, and raises its errors under `AR-*`
53
+ names.
54
+
55
+ Two models are served:
56
+
57
+ | Model | Use |
58
+ | --- | --- |
59
+ | `archeone/archeone-brain-1.0` | the full model |
60
+ | `archeone/archeone-brain-1.0-flash` | the lower-latency model |
61
+
62
+ Request them by these names. The service maps them onto its own checkpoints
63
+ internally; the upstream checkpoint ids are not part of the public surface.
64
+
65
+ The SDK core is hardware-free. Hardware integrations live under `examples/`.
66
+
67
+ **New here? Read [docs/quickstart.md](docs/quickstart.md).** It walks from
68
+ creating your first token through installing the SDK to a real PiPER grasp,
69
+ with a verification step after each stage.
70
+
71
+ ## Install
72
+
73
+ ```bash
74
+ pip install archeone
75
+ ```
76
+
77
+ That installs the client only, with `numpy` and `Pillow`. For the optional
78
+ PiPER inverse kinematics, which pulls JAX and the vendored solver:
79
+
80
+ ```bash
81
+ pip install "archeone[ik]"
82
+ ```
83
+
84
+ For development:
85
+
86
+ ```bash
87
+ python -m pip install -e ".[ik,dev]"
88
+ ```
89
+
90
+ ## Synchronous inference
91
+
92
+ `ArcheoneClient` accepts one latest state plus one JPEG frame per camera on
93
+ every camera tick. It keeps an internal 9-frame, 5 fps window per camera and
94
+ sends frames oldest-to-newest.
95
+
96
+ ```python
97
+ import time
98
+ from archeone import ArcheoneClient
99
+
100
+ client = ArcheoneClient(
101
+ api_key="sk-...",
102
+ base_url="https://gateway.example",
103
+ checkpoint="archeone/archeone-brain-1.0",
104
+ )
105
+
106
+ client.set_observation(
107
+ frames={
108
+ "video.overhead": overhead_jpeg,
109
+ "video.wrist_l": left_jpeg,
110
+ "video.wrist_r": right_jpeg,
111
+ },
112
+ observation={
113
+ "state.right_arm": right_joints,
114
+ "state.right_gripper": [right_gripper],
115
+ "state.left_arm": left_joints,
116
+ "state.left_gripper": [left_gripper],
117
+ "state.right_eef_xyz": right_xyz,
118
+ "state.right_eef_rot6": right_rot6,
119
+ "state.right_grip": [right_grip],
120
+ "state.left_eef_xyz": left_xyz,
121
+ "state.left_eef_rot6": left_rot6,
122
+ "state.left_grip": [left_grip],
123
+ "prompt": "Grab the bottle",
124
+ },
125
+ timestamp=time.monotonic(),
126
+ )
127
+
128
+ chunk = client.get_action()
129
+ ```
130
+
131
+ The gateway's `status.code` decides success. HTTP 200 alone is not success.
132
+ `AR-2000 POOL_WARMING` is surfaced as `CapacityError`; keep the same
133
+ `episode_key` and retry per `retry_after_s`. A cold pool can take tens of
134
+ minutes to come up; do not open new sessions while it warms.
135
+
136
+ ## Hardware validation
137
+
138
+ `examples/piper_two_arm_demo.py` is the operator-facing PiPER integration. It
139
+ refuses to run without `--execute`, uses the existing station control driver's
140
+ fresh-feedback, motor-ready, and joint-limit gates, and never enables, homes,
141
+ zeros, or disables the motors. It validates every returned chunk against the
142
+ URDF limits before sending it, and streams the chunk at 250 Hz from the measured
143
+ pose.
144
+
145
+ The SDK itself has been exercised against the real gateway with three RealSense
146
+ streams and both hands' FK-derived EEF fields; a real arm execution requires the
147
+ arm to be inside the station's URDF joint envelope and an operator present.
148
+
149
+ ### Station notes
150
+
151
+ These came out of bringing the left arm up on the real station; each one
152
+ silently ruins a run if it is wrong.
153
+
154
+ **Tool frame.** The checkpoint was trained with the station's calibrated PiPER
155
+ tool, `approach = +z` and `jaw = +y` in the flange frame, which is a frame
156
+ rotated 90 degrees about the flange z from the flange's own axes. Sending EEFs
157
+ in the flange frame instead makes the model's wrist pose off by a right angle,
158
+ and the arm answers by twisting its last wrist joint rather than approaching.
159
+ `archeone/ik/dream_ik/specs.py` carries that rotation; it reproduces the
160
+ station's own recorded replies to within 3.4 degrees.
161
+
162
+ **Start where the arm actually is.** The reply is anchored on the pose the
163
+ request carried. If the arm is parked somewhere with no line of sight to the
164
+ object, the model answers with targets around that pose and nothing moves
165
+ toward the goal. The demo therefore does not drive to a nominal rest unless
166
+ `--ready` is passed. An operator can teleoperate the arm into a sensible
167
+ pre-grasp pose, and the first inference starts from there.
168
+
169
+ **Elbow margin matters more than distance.** PiPER's `J3` sits close to its
170
+ upper bound at the nominal rest (`-0.101` of `[-2.932, -0.035]`). From there the
171
+ arm cannot extend down to a tabletop object, and the solve reports a large
172
+ residual no distance clipping can fix. A pre-grasp pose with `J2` around 1.7 and
173
+ `J3` around -0.78 leaves room on every axis and reaches the table.
174
+
175
+ **Slow links.** A synchronous round trip of several seconds is worth dozens of
176
+ 20 Hz rows. The client drops the rows the round trip already spent but keeps at
177
+ least a second of live plan, and clips each target to a reachable step from the
178
+ commanded pose, so a distant model target becomes a sequence of waypoints
179
+ instead of a rejected chunk.
180
+
181
+
@@ -0,0 +1,135 @@
1
+ # archeone
2
+
3
+ `archeone` is a synchronous Python client for **ArcheOneBrain**, an embodied
4
+ inference service reached over the `/v1/get_action` protocol. It keeps the
5
+ observation-window, session, error-envelope, action-pacing, seam-smoothing and
6
+ optional IK behavior that protocol defines, and raises its errors under `AR-*`
7
+ names.
8
+
9
+ Two models are served:
10
+
11
+ | Model | Use |
12
+ | --- | --- |
13
+ | `archeone/archeone-brain-1.0` | the full model |
14
+ | `archeone/archeone-brain-1.0-flash` | the lower-latency model |
15
+
16
+ Request them by these names. The service maps them onto its own checkpoints
17
+ internally; the upstream checkpoint ids are not part of the public surface.
18
+
19
+ The SDK core is hardware-free. Hardware integrations live under `examples/`.
20
+
21
+ **New here? Read [docs/quickstart.md](docs/quickstart.md).** It walks from
22
+ creating your first token through installing the SDK to a real PiPER grasp,
23
+ with a verification step after each stage.
24
+
25
+ ## Install
26
+
27
+ ```bash
28
+ pip install archeone
29
+ ```
30
+
31
+ That installs the client only, with `numpy` and `Pillow`. For the optional
32
+ PiPER inverse kinematics, which pulls JAX and the vendored solver:
33
+
34
+ ```bash
35
+ pip install "archeone[ik]"
36
+ ```
37
+
38
+ For development:
39
+
40
+ ```bash
41
+ python -m pip install -e ".[ik,dev]"
42
+ ```
43
+
44
+ ## Synchronous inference
45
+
46
+ `ArcheoneClient` accepts one latest state plus one JPEG frame per camera on
47
+ every camera tick. It keeps an internal 9-frame, 5 fps window per camera and
48
+ sends frames oldest-to-newest.
49
+
50
+ ```python
51
+ import time
52
+ from archeone import ArcheoneClient
53
+
54
+ client = ArcheoneClient(
55
+ api_key="sk-...",
56
+ base_url="https://gateway.example",
57
+ checkpoint="archeone/archeone-brain-1.0",
58
+ )
59
+
60
+ client.set_observation(
61
+ frames={
62
+ "video.overhead": overhead_jpeg,
63
+ "video.wrist_l": left_jpeg,
64
+ "video.wrist_r": right_jpeg,
65
+ },
66
+ observation={
67
+ "state.right_arm": right_joints,
68
+ "state.right_gripper": [right_gripper],
69
+ "state.left_arm": left_joints,
70
+ "state.left_gripper": [left_gripper],
71
+ "state.right_eef_xyz": right_xyz,
72
+ "state.right_eef_rot6": right_rot6,
73
+ "state.right_grip": [right_grip],
74
+ "state.left_eef_xyz": left_xyz,
75
+ "state.left_eef_rot6": left_rot6,
76
+ "state.left_grip": [left_grip],
77
+ "prompt": "Grab the bottle",
78
+ },
79
+ timestamp=time.monotonic(),
80
+ )
81
+
82
+ chunk = client.get_action()
83
+ ```
84
+
85
+ The gateway's `status.code` decides success. HTTP 200 alone is not success.
86
+ `AR-2000 POOL_WARMING` is surfaced as `CapacityError`; keep the same
87
+ `episode_key` and retry per `retry_after_s`. A cold pool can take tens of
88
+ minutes to come up; do not open new sessions while it warms.
89
+
90
+ ## Hardware validation
91
+
92
+ `examples/piper_two_arm_demo.py` is the operator-facing PiPER integration. It
93
+ refuses to run without `--execute`, uses the existing station control driver's
94
+ fresh-feedback, motor-ready, and joint-limit gates, and never enables, homes,
95
+ zeros, or disables the motors. It validates every returned chunk against the
96
+ URDF limits before sending it, and streams the chunk at 250 Hz from the measured
97
+ pose.
98
+
99
+ The SDK itself has been exercised against the real gateway with three RealSense
100
+ streams and both hands' FK-derived EEF fields; a real arm execution requires the
101
+ arm to be inside the station's URDF joint envelope and an operator present.
102
+
103
+ ### Station notes
104
+
105
+ These came out of bringing the left arm up on the real station; each one
106
+ silently ruins a run if it is wrong.
107
+
108
+ **Tool frame.** The checkpoint was trained with the station's calibrated PiPER
109
+ tool, `approach = +z` and `jaw = +y` in the flange frame, which is a frame
110
+ rotated 90 degrees about the flange z from the flange's own axes. Sending EEFs
111
+ in the flange frame instead makes the model's wrist pose off by a right angle,
112
+ and the arm answers by twisting its last wrist joint rather than approaching.
113
+ `archeone/ik/dream_ik/specs.py` carries that rotation; it reproduces the
114
+ station's own recorded replies to within 3.4 degrees.
115
+
116
+ **Start where the arm actually is.** The reply is anchored on the pose the
117
+ request carried. If the arm is parked somewhere with no line of sight to the
118
+ object, the model answers with targets around that pose and nothing moves
119
+ toward the goal. The demo therefore does not drive to a nominal rest unless
120
+ `--ready` is passed. An operator can teleoperate the arm into a sensible
121
+ pre-grasp pose, and the first inference starts from there.
122
+
123
+ **Elbow margin matters more than distance.** PiPER's `J3` sits close to its
124
+ upper bound at the nominal rest (`-0.101` of `[-2.932, -0.035]`). From there the
125
+ arm cannot extend down to a tabletop object, and the solve reports a large
126
+ residual no distance clipping can fix. A pre-grasp pose with `J2` around 1.7 and
127
+ `J3` around -0.78 leaves room on every axis and reaches the table.
128
+
129
+ **Slow links.** A synchronous round trip of several seconds is worth dozens of
130
+ 20 Hz rows. The client drops the rows the round trip already spent but keeps at
131
+ least a second of live plan, and clips each target to a reachable step from the
132
+ commanded pose, so a distant model target becomes a sequence of waypoints
133
+ instead of a rejected chunk.
134
+
135
+
@@ -0,0 +1,44 @@
1
+ """Public API for archeone."""
2
+
3
+ from .client import ArcheoneClient
4
+ from .errors import (
5
+ ActionError,
6
+ ArcheoneError,
7
+ AuthError,
8
+ BadRequest,
9
+ CapacityError,
10
+ ConfigError,
11
+ ModelError,
12
+ ObservationError,
13
+ ProtocolError,
14
+ ServerError,
15
+ SessionReplaced,
16
+ Timeout,
17
+ TransportError,
18
+ )
19
+ from .pacing import SYNC, Pacer
20
+ from .window import Window
21
+
22
+ __version__ = "0.1.0"
23
+
24
+ __all__ = [
25
+ "ActionError",
26
+ "ArcheoneClient",
27
+ "ArcheoneError",
28
+ "AuthError",
29
+ "BadRequest",
30
+ "CapacityError",
31
+ "ConfigError",
32
+ "ModelError",
33
+ "ObservationError",
34
+ "Pacer",
35
+ "ProtocolError",
36
+ "SYNC",
37
+ "ServerError",
38
+ "SessionReplaced",
39
+ "Timeout",
40
+ "TransportError",
41
+ "Window",
42
+ "__version__",
43
+ ]
44
+
@@ -0,0 +1,12 @@
1
+ """Vendored IK dependencies (jaxls, pyroki), kept under their original licenses."""
2
+
3
+ import sys
4
+
5
+ # pyroki and dream-style solvers import these by their upstream names. Bind the
6
+ # vendored copies before any installed top-level package can shadow them.
7
+ from . import jaxls, pyroki
8
+
9
+ sys.modules.setdefault("jaxls", jaxls)
10
+ sys.modules.setdefault("pyroki", pyroki)
11
+
12
+ __all__ = ["jaxls", "pyroki"]
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Brent Yi
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.