dora-openarm-evaluation-ui 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.
- dora_openarm_evaluation_ui-0.1.0/LICENSE +202 -0
- dora_openarm_evaluation_ui-0.1.0/PKG-INFO +124 -0
- dora_openarm_evaluation_ui-0.1.0/README.md +106 -0
- dora_openarm_evaluation_ui-0.1.0/pyproject.toml +60 -0
- dora_openarm_evaluation_ui-0.1.0/setup.cfg +4 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui/__init__.py +15 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui/eval_metadata.py +136 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui/main.py +590 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui/templates/root.html +716 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/PKG-INFO +124 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/SOURCES.txt +13 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/dependency_links.txt +1 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/entry_points.txt +2 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/requires.txt +4 -0
- dora_openarm_evaluation_ui-0.1.0/src/dora_openarm_evaluation_ui.egg-info/top_level.txt +1 -0
|
@@ -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.
|
|
@@ -0,0 +1,124 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: dora-openarm-evaluation-ui
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: dora-rs node that provides UI to run inference evaluation with OpenArm
|
|
5
|
+
Author: Enactic, Inc.
|
|
6
|
+
License: Apache-2.0
|
|
7
|
+
Project-URL: Changelog, https://github.com/enactic/dora-openarm-evaluation-ui/releases
|
|
8
|
+
Project-URL: Issues, https://github.com/enactic/dora-openarm-evaluation-ui/issues
|
|
9
|
+
Project-URL: Repository, https://github.com/enactic/dora-openarm-evaluation-ui
|
|
10
|
+
Requires-Python: >=3.10
|
|
11
|
+
Description-Content-Type: text/markdown
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Requires-Dist: dora-rs>=0.5.0
|
|
14
|
+
Requires-Dist: fastapi[standard]
|
|
15
|
+
Requires-Dist: pyyaml
|
|
16
|
+
Requires-Dist: uvicorn
|
|
17
|
+
Dynamic: license-file
|
|
18
|
+
|
|
19
|
+
# dora-openarm-evaluation-ui
|
|
20
|
+
|
|
21
|
+
A [dora-rs](https://dora-rs.ai) node providing a web UI to run policy
|
|
22
|
+
(inference) evaluation sessions on the
|
|
23
|
+
[OpenArm](https://github.com/enactic/openarm) bimanual robot.
|
|
24
|
+
|
|
25
|
+
An operator drives each evaluation episode from the browser; the node
|
|
26
|
+
orchestrates the rest of the dataflow by emitting:
|
|
27
|
+
|
|
28
|
+
- **`arm_command`** — `start` / `stop` / `quit` for the arms and other quittable nodes
|
|
29
|
+
- **`task_prompt`** — the current task's language instruction, used to condition the policy
|
|
30
|
+
|
|
31
|
+
Per-episode results (success/fail and notes) are logged to `eval_metadata.yaml`.
|
|
32
|
+
|
|
33
|
+
## Features
|
|
34
|
+
|
|
35
|
+
- Single-operator episode loop: **start → success / fail / cancel → reset → repeat**
|
|
36
|
+
- Task switcher with per-task and session success-rate stats
|
|
37
|
+
- Live camera FPS / jitter monitor for all five streams
|
|
38
|
+
- Resume: a restart continues from the next episode number found in existing metadata
|
|
39
|
+
- Checkpoint panel: path, description, capture timestamp
|
|
40
|
+
- Keyboard shortcuts and an emergency stop
|
|
41
|
+
|
|
42
|
+
## Install
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
pip install -e . # or: uv sync
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
dora can also build the node from the dataflow (`build: pip install -e .`).
|
|
49
|
+
|
|
50
|
+
## Run
|
|
51
|
+
|
|
52
|
+
The node runs inside a dora
|
|
53
|
+
dataflow. [`example/dataflow.yaml`](example/dataflow.yaml) is a
|
|
54
|
+
reference wiring of the UI with the arms, cameras, observer, policy
|
|
55
|
+
server, and action executor:
|
|
56
|
+
|
|
57
|
+
```bash
|
|
58
|
+
dora run dataflow.yaml --uv
|
|
59
|
+
```
|
|
60
|
+
|
|
61
|
+
The UI is served at <http://127.0.0.1:8000> (opens automatically when `AUTO_OPEN=yes`).
|
|
62
|
+
|
|
63
|
+
### Configuration
|
|
64
|
+
|
|
65
|
+
Set through the dataflow `env:` block or via CLI flags:
|
|
66
|
+
|
|
67
|
+
| Env | Flag | Default | Description |
|
|
68
|
+
|-----|------|---------|-------------|
|
|
69
|
+
| `DATASET_DIR` | — | `.` | Directory holding `metadata.yaml` and `eval_metadata.yaml`. |
|
|
70
|
+
| `METADATA_FILE` | `--metadata-file` | — | Source `metadata.yaml` with the task list. Required for a new dataset; not needed on resume (tasks are cached in `eval_metadata.yaml`). |
|
|
71
|
+
| `CHECKPOINT_PATH` | `--checkpoint-path` | — | Model checkpoint path, recorded once into `eval_metadata.yaml`. |
|
|
72
|
+
| `AUTO_OPEN` | `--auto-open` | `no` | Open a browser automatically (`yes` / `no`). |
|
|
73
|
+
| `PORT` | `--port` | `8000` | Web server port. |
|
|
74
|
+
|
|
75
|
+
### Task list
|
|
76
|
+
|
|
77
|
+
Tasks are read from a `metadata.yaml` (see the included example):
|
|
78
|
+
|
|
79
|
+
```yaml
|
|
80
|
+
tasks:
|
|
81
|
+
- prompt: Snug the pillow into the case.
|
|
82
|
+
description: SMALL PILLOW
|
|
83
|
+
```
|
|
84
|
+
|
|
85
|
+
Resolution order: tasks cached in `eval_metadata.yaml` (resume) →
|
|
86
|
+
`DATASET_DIR/metadata.yaml` → `--metadata-file`.
|
|
87
|
+
|
|
88
|
+
## Operating the UI
|
|
89
|
+
|
|
90
|
+
Each episode follows **Idle → Start** (the arms initialize and the UI waits for both to
|
|
91
|
+
report `started`) **→ Collecting → Success / Fail / Cancel → Reset Robot** (the operator
|
|
92
|
+
resets the scene, then presses **Ready**) **→ Idle**. *Emergency Stop* cancels the current
|
|
93
|
+
episode and disables the arm motors immediately.
|
|
94
|
+
|
|
95
|
+
| Key | Action |
|
|
96
|
+
|-----|--------|
|
|
97
|
+
| `Space` / `s` | Start (idle) or mark Success (collecting) |
|
|
98
|
+
| `f` | Fail |
|
|
99
|
+
| `x` | Cancel (no result recorded) |
|
|
100
|
+
| `r` | Ready — reset complete |
|
|
101
|
+
| `←` / `→` | Stage previous / next task |
|
|
102
|
+
| `Enter` | Commit the staged task change |
|
|
103
|
+
| `q` | Quit the session |
|
|
104
|
+
|
|
105
|
+
## Dataflow interface
|
|
106
|
+
|
|
107
|
+
**Inputs:** `tick`, `arm_status_right`, `arm_status_left`, and five camera streams
|
|
108
|
+
(`camera_wrist_right`, `camera_wrist_left`, `camera_head_left`, `camera_head_right`,
|
|
109
|
+
`camera_ceiling`).
|
|
110
|
+
|
|
111
|
+
**Outputs:** `arm_command`, `task_prompt`.
|
|
112
|
+
|
|
113
|
+
`eval_metadata.yaml` records the checkpoint info, the task list, and one entry per
|
|
114
|
+
episode (`id`, `task_index`, `success`, `note`, `timestamp`).
|
|
115
|
+
|
|
116
|
+
## License
|
|
117
|
+
|
|
118
|
+
Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
|
|
119
|
+
|
|
120
|
+
Copyright 2026 Enactic, Inc.
|
|
121
|
+
|
|
122
|
+
## Code of Conduct
|
|
123
|
+
|
|
124
|
+
All participation in the OpenArm project is governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
@@ -0,0 +1,106 @@
|
|
|
1
|
+
# dora-openarm-evaluation-ui
|
|
2
|
+
|
|
3
|
+
A [dora-rs](https://dora-rs.ai) node providing a web UI to run policy
|
|
4
|
+
(inference) evaluation sessions on the
|
|
5
|
+
[OpenArm](https://github.com/enactic/openarm) bimanual robot.
|
|
6
|
+
|
|
7
|
+
An operator drives each evaluation episode from the browser; the node
|
|
8
|
+
orchestrates the rest of the dataflow by emitting:
|
|
9
|
+
|
|
10
|
+
- **`arm_command`** — `start` / `stop` / `quit` for the arms and other quittable nodes
|
|
11
|
+
- **`task_prompt`** — the current task's language instruction, used to condition the policy
|
|
12
|
+
|
|
13
|
+
Per-episode results (success/fail and notes) are logged to `eval_metadata.yaml`.
|
|
14
|
+
|
|
15
|
+
## Features
|
|
16
|
+
|
|
17
|
+
- Single-operator episode loop: **start → success / fail / cancel → reset → repeat**
|
|
18
|
+
- Task switcher with per-task and session success-rate stats
|
|
19
|
+
- Live camera FPS / jitter monitor for all five streams
|
|
20
|
+
- Resume: a restart continues from the next episode number found in existing metadata
|
|
21
|
+
- Checkpoint panel: path, description, capture timestamp
|
|
22
|
+
- Keyboard shortcuts and an emergency stop
|
|
23
|
+
|
|
24
|
+
## Install
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e . # or: uv sync
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
dora can also build the node from the dataflow (`build: pip install -e .`).
|
|
31
|
+
|
|
32
|
+
## Run
|
|
33
|
+
|
|
34
|
+
The node runs inside a dora
|
|
35
|
+
dataflow. [`example/dataflow.yaml`](example/dataflow.yaml) is a
|
|
36
|
+
reference wiring of the UI with the arms, cameras, observer, policy
|
|
37
|
+
server, and action executor:
|
|
38
|
+
|
|
39
|
+
```bash
|
|
40
|
+
dora run dataflow.yaml --uv
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
The UI is served at <http://127.0.0.1:8000> (opens automatically when `AUTO_OPEN=yes`).
|
|
44
|
+
|
|
45
|
+
### Configuration
|
|
46
|
+
|
|
47
|
+
Set through the dataflow `env:` block or via CLI flags:
|
|
48
|
+
|
|
49
|
+
| Env | Flag | Default | Description |
|
|
50
|
+
|-----|------|---------|-------------|
|
|
51
|
+
| `DATASET_DIR` | — | `.` | Directory holding `metadata.yaml` and `eval_metadata.yaml`. |
|
|
52
|
+
| `METADATA_FILE` | `--metadata-file` | — | Source `metadata.yaml` with the task list. Required for a new dataset; not needed on resume (tasks are cached in `eval_metadata.yaml`). |
|
|
53
|
+
| `CHECKPOINT_PATH` | `--checkpoint-path` | — | Model checkpoint path, recorded once into `eval_metadata.yaml`. |
|
|
54
|
+
| `AUTO_OPEN` | `--auto-open` | `no` | Open a browser automatically (`yes` / `no`). |
|
|
55
|
+
| `PORT` | `--port` | `8000` | Web server port. |
|
|
56
|
+
|
|
57
|
+
### Task list
|
|
58
|
+
|
|
59
|
+
Tasks are read from a `metadata.yaml` (see the included example):
|
|
60
|
+
|
|
61
|
+
```yaml
|
|
62
|
+
tasks:
|
|
63
|
+
- prompt: Snug the pillow into the case.
|
|
64
|
+
description: SMALL PILLOW
|
|
65
|
+
```
|
|
66
|
+
|
|
67
|
+
Resolution order: tasks cached in `eval_metadata.yaml` (resume) →
|
|
68
|
+
`DATASET_DIR/metadata.yaml` → `--metadata-file`.
|
|
69
|
+
|
|
70
|
+
## Operating the UI
|
|
71
|
+
|
|
72
|
+
Each episode follows **Idle → Start** (the arms initialize and the UI waits for both to
|
|
73
|
+
report `started`) **→ Collecting → Success / Fail / Cancel → Reset Robot** (the operator
|
|
74
|
+
resets the scene, then presses **Ready**) **→ Idle**. *Emergency Stop* cancels the current
|
|
75
|
+
episode and disables the arm motors immediately.
|
|
76
|
+
|
|
77
|
+
| Key | Action |
|
|
78
|
+
|-----|--------|
|
|
79
|
+
| `Space` / `s` | Start (idle) or mark Success (collecting) |
|
|
80
|
+
| `f` | Fail |
|
|
81
|
+
| `x` | Cancel (no result recorded) |
|
|
82
|
+
| `r` | Ready — reset complete |
|
|
83
|
+
| `←` / `→` | Stage previous / next task |
|
|
84
|
+
| `Enter` | Commit the staged task change |
|
|
85
|
+
| `q` | Quit the session |
|
|
86
|
+
|
|
87
|
+
## Dataflow interface
|
|
88
|
+
|
|
89
|
+
**Inputs:** `tick`, `arm_status_right`, `arm_status_left`, and five camera streams
|
|
90
|
+
(`camera_wrist_right`, `camera_wrist_left`, `camera_head_left`, `camera_head_right`,
|
|
91
|
+
`camera_ceiling`).
|
|
92
|
+
|
|
93
|
+
**Outputs:** `arm_command`, `task_prompt`.
|
|
94
|
+
|
|
95
|
+
`eval_metadata.yaml` records the checkpoint info, the task list, and one entry per
|
|
96
|
+
episode (`id`, `task_index`, `success`, `note`, `timestamp`).
|
|
97
|
+
|
|
98
|
+
## License
|
|
99
|
+
|
|
100
|
+
Licensed under the Apache License 2.0. See [LICENSE](LICENSE) for details.
|
|
101
|
+
|
|
102
|
+
Copyright 2026 Enactic, Inc.
|
|
103
|
+
|
|
104
|
+
## Code of Conduct
|
|
105
|
+
|
|
106
|
+
All participation in the OpenArm project is governed by our [Code of Conduct](CODE_OF_CONDUCT.md).
|
|
@@ -0,0 +1,60 @@
|
|
|
1
|
+
# Copyright 2026 Enactic, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
[project]
|
|
16
|
+
name = "dora-openarm-evaluation-ui"
|
|
17
|
+
version = "0.1.0"
|
|
18
|
+
authors = [{ name = "Enactic, Inc." }]
|
|
19
|
+
description = "dora-rs node that provides UI to run inference evaluation with OpenArm"
|
|
20
|
+
license = { text = "Apache-2.0" }
|
|
21
|
+
readme = "README.md"
|
|
22
|
+
requires-python = ">=3.10"
|
|
23
|
+
|
|
24
|
+
dependencies = [
|
|
25
|
+
"dora-rs >= 0.5.0",
|
|
26
|
+
"fastapi[standard]",
|
|
27
|
+
"pyyaml",
|
|
28
|
+
"uvicorn",
|
|
29
|
+
]
|
|
30
|
+
|
|
31
|
+
[dependency-groups]
|
|
32
|
+
dev = [
|
|
33
|
+
"ruff == 0.14.11", # sync with .pre-commit-config.yaml
|
|
34
|
+
]
|
|
35
|
+
|
|
36
|
+
[project.urls]
|
|
37
|
+
Changelog = "https://github.com/enactic/dora-openarm-evaluation-ui/releases"
|
|
38
|
+
Issues = "https://github.com/enactic/dora-openarm-evaluation-ui/issues"
|
|
39
|
+
Repository = "https://github.com/enactic/dora-openarm-evaluation-ui"
|
|
40
|
+
|
|
41
|
+
[project.scripts]
|
|
42
|
+
dora-openarm-evaluation-ui = "dora_openarm_evaluation_ui.main:main"
|
|
43
|
+
|
|
44
|
+
[build-system]
|
|
45
|
+
requires = ["setuptools"]
|
|
46
|
+
build-backend = "setuptools.build_meta"
|
|
47
|
+
|
|
48
|
+
[tool.setuptools.packages.find]
|
|
49
|
+
where = ["src"]
|
|
50
|
+
|
|
51
|
+
[tool.setuptools.package-data]
|
|
52
|
+
"dora_openarm_evaluation_ui.templates" = [
|
|
53
|
+
"*.html",
|
|
54
|
+
]
|
|
55
|
+
|
|
56
|
+
[tool.ruff.lint]
|
|
57
|
+
extend-select = [
|
|
58
|
+
"D", # pydocstyle
|
|
59
|
+
"UP"
|
|
60
|
+
]
|
|
@@ -0,0 +1,15 @@
|
|
|
1
|
+
# Copyright 2026 Enactic, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""dora-rs node providing a web UI to run OpenArm inference evaluation sessions."""
|
|
@@ -0,0 +1,136 @@
|
|
|
1
|
+
# Copyright 2026 Enactic, Inc.
|
|
2
|
+
#
|
|
3
|
+
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
4
|
+
# you may not use this file except in compliance with the License.
|
|
5
|
+
# You may obtain a copy of the License at
|
|
6
|
+
#
|
|
7
|
+
# http://www.apache.org/licenses/LICENSE-2.0
|
|
8
|
+
#
|
|
9
|
+
# Unless required by applicable law or agreed to in writing, software
|
|
10
|
+
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
11
|
+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
12
|
+
# See the License for the specific language governing permissions and
|
|
13
|
+
# limitations under the License.
|
|
14
|
+
|
|
15
|
+
"""Evaluation session metadata: checkpoint info, task list, per-episode results."""
|
|
16
|
+
|
|
17
|
+
from __future__ import annotations
|
|
18
|
+
|
|
19
|
+
import datetime
|
|
20
|
+
import pathlib
|
|
21
|
+
|
|
22
|
+
import yaml
|
|
23
|
+
|
|
24
|
+
|
|
25
|
+
class EvalMetadata:
|
|
26
|
+
"""Tracks one evaluation session: checkpoint, tasks, and per-episode results.
|
|
27
|
+
|
|
28
|
+
Saved as ``eval_metadata.yaml`` alongside the dataset directory. Separate from
|
|
29
|
+
the dataset's own ``metadata.yaml`` so it can carry eval-specific fields (notes,
|
|
30
|
+
capture timestamp) without polluting the dataset schema.
|
|
31
|
+
"""
|
|
32
|
+
|
|
33
|
+
VERSION = "0.1.0"
|
|
34
|
+
|
|
35
|
+
def __init__(self) -> None:
|
|
36
|
+
"""Initialize with empty data."""
|
|
37
|
+
self.data: dict = {"version": self.VERSION}
|
|
38
|
+
|
|
39
|
+
# ------------------------------------------------------------------
|
|
40
|
+
# Persistence
|
|
41
|
+
# ------------------------------------------------------------------
|
|
42
|
+
|
|
43
|
+
@classmethod
|
|
44
|
+
def load(cls, path: pathlib.Path) -> EvalMetadata:
|
|
45
|
+
"""Load from YAML file."""
|
|
46
|
+
instance = cls()
|
|
47
|
+
with open(path) as f:
|
|
48
|
+
instance.data = yaml.safe_load(f) or {}
|
|
49
|
+
return instance
|
|
50
|
+
|
|
51
|
+
def save(self, path: pathlib.Path) -> None:
|
|
52
|
+
"""Atomically save to YAML file."""
|
|
53
|
+
path.parent.mkdir(parents=True, exist_ok=True)
|
|
54
|
+
tmp = path.with_suffix(".yaml.tmp")
|
|
55
|
+
with open(tmp, "w", encoding="utf-8") as f:
|
|
56
|
+
yaml.dump(self.data, f, default_flow_style=False, allow_unicode=True)
|
|
57
|
+
tmp.replace(path)
|
|
58
|
+
|
|
59
|
+
# ------------------------------------------------------------------
|
|
60
|
+
# Checkpoint auto-info
|
|
61
|
+
# ------------------------------------------------------------------
|
|
62
|
+
|
|
63
|
+
def auto_populate(self, checkpoint_path: str | None) -> None:
|
|
64
|
+
"""Populate checkpoint info with its path and a capture timestamp.
|
|
65
|
+
|
|
66
|
+
Only fills fields that are not already present so that repeated calls
|
|
67
|
+
on resume do not overwrite the original captured values.
|
|
68
|
+
"""
|
|
69
|
+
checkpoint = self.data.setdefault("checkpoint", {})
|
|
70
|
+
if checkpoint_path and "path" not in checkpoint:
|
|
71
|
+
checkpoint["path"] = checkpoint_path
|
|
72
|
+
auto_info = checkpoint.setdefault("auto_info", {})
|
|
73
|
+
if "captured_at" not in auto_info:
|
|
74
|
+
auto_info["captured_at"] = datetime.datetime.now().isoformat(
|
|
75
|
+
timespec="seconds"
|
|
76
|
+
)
|
|
77
|
+
|
|
78
|
+
# ------------------------------------------------------------------
|
|
79
|
+
# Episode recording
|
|
80
|
+
# ------------------------------------------------------------------
|
|
81
|
+
|
|
82
|
+
def add_episode(
|
|
83
|
+
self,
|
|
84
|
+
*,
|
|
85
|
+
id: str,
|
|
86
|
+
task_index: int,
|
|
87
|
+
success: bool,
|
|
88
|
+
note: str,
|
|
89
|
+
) -> None:
|
|
90
|
+
"""Append a completed episode record."""
|
|
91
|
+
self.data.setdefault("episodes", []).append(
|
|
92
|
+
{
|
|
93
|
+
"id": id,
|
|
94
|
+
"task_index": task_index,
|
|
95
|
+
"success": success,
|
|
96
|
+
"note": note,
|
|
97
|
+
"timestamp": datetime.datetime.now().isoformat(timespec="seconds"),
|
|
98
|
+
}
|
|
99
|
+
)
|
|
100
|
+
|
|
101
|
+
# ------------------------------------------------------------------
|
|
102
|
+
# Properties
|
|
103
|
+
# ------------------------------------------------------------------
|
|
104
|
+
|
|
105
|
+
@property
|
|
106
|
+
def episodes(self) -> list[dict]:
|
|
107
|
+
"""All recorded episodes."""
|
|
108
|
+
return self.data.get("episodes", [])
|
|
109
|
+
|
|
110
|
+
@property
|
|
111
|
+
def tasks(self) -> list[dict]:
|
|
112
|
+
"""Task list (prompt, description, ...)."""
|
|
113
|
+
return self.data.get("tasks", [])
|
|
114
|
+
|
|
115
|
+
@tasks.setter
|
|
116
|
+
def tasks(self, value: list[dict]) -> None:
|
|
117
|
+
self.data["tasks"] = value
|
|
118
|
+
|
|
119
|
+
@property
|
|
120
|
+
def checkpoint_path(self) -> str:
|
|
121
|
+
"""Filesystem path to the model checkpoint."""
|
|
122
|
+
return self.data.get("checkpoint", {}).get("path", "")
|
|
123
|
+
|
|
124
|
+
@property
|
|
125
|
+
def checkpoint_description(self) -> str:
|
|
126
|
+
"""Human-readable description of the checkpoint."""
|
|
127
|
+
return self.data.get("checkpoint", {}).get("description", "")
|
|
128
|
+
|
|
129
|
+
@checkpoint_description.setter
|
|
130
|
+
def checkpoint_description(self, value: str) -> None:
|
|
131
|
+
self.data.setdefault("checkpoint", {})["description"] = value
|
|
132
|
+
|
|
133
|
+
@property
|
|
134
|
+
def auto_info(self) -> dict:
|
|
135
|
+
"""Auto-captured checkpoint info (capture timestamp)."""
|
|
136
|
+
return self.data.get("checkpoint", {}).get("auto_info", {})
|