gym-aloha 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 (32) hide show
  1. gym_aloha-0.1.0/LICENSE +228 -0
  2. gym_aloha-0.1.0/PKG-INFO +162 -0
  3. gym_aloha-0.1.0/README.md +132 -0
  4. gym_aloha-0.1.0/gym_aloha/__init__.py +21 -0
  5. gym_aloha-0.1.0/gym_aloha/assets/bimanual_viperx_end_effector_insertion.xml +59 -0
  6. gym_aloha-0.1.0/gym_aloha/assets/bimanual_viperx_end_effector_transfer_cube.xml +48 -0
  7. gym_aloha-0.1.0/gym_aloha/assets/bimanual_viperx_insertion.xml +53 -0
  8. gym_aloha-0.1.0/gym_aloha/assets/bimanual_viperx_transfer_cube.xml +42 -0
  9. gym_aloha-0.1.0/gym_aloha/assets/scene.xml +38 -0
  10. gym_aloha-0.1.0/gym_aloha/assets/tabletop.stl +0 -0
  11. gym_aloha-0.1.0/gym_aloha/assets/vx300s_10_custom_finger_left.stl +0 -0
  12. gym_aloha-0.1.0/gym_aloha/assets/vx300s_10_custom_finger_right.stl +0 -0
  13. gym_aloha-0.1.0/gym_aloha/assets/vx300s_10_gripper_finger.stl +0 -0
  14. gym_aloha-0.1.0/gym_aloha/assets/vx300s_11_ar_tag.stl +0 -0
  15. gym_aloha-0.1.0/gym_aloha/assets/vx300s_1_base.stl +0 -0
  16. gym_aloha-0.1.0/gym_aloha/assets/vx300s_2_shoulder.stl +0 -0
  17. gym_aloha-0.1.0/gym_aloha/assets/vx300s_3_upper_arm.stl +0 -0
  18. gym_aloha-0.1.0/gym_aloha/assets/vx300s_4_upper_forearm.stl +0 -0
  19. gym_aloha-0.1.0/gym_aloha/assets/vx300s_5_lower_forearm.stl +0 -0
  20. gym_aloha-0.1.0/gym_aloha/assets/vx300s_6_wrist.stl +0 -0
  21. gym_aloha-0.1.0/gym_aloha/assets/vx300s_7_gripper.stl +0 -0
  22. gym_aloha-0.1.0/gym_aloha/assets/vx300s_8_gripper_prop.stl +0 -0
  23. gym_aloha-0.1.0/gym_aloha/assets/vx300s_9_gripper_bar.stl +0 -0
  24. gym_aloha-0.1.0/gym_aloha/assets/vx300s_dependencies.xml +17 -0
  25. gym_aloha-0.1.0/gym_aloha/assets/vx300s_left.xml +59 -0
  26. gym_aloha-0.1.0/gym_aloha/assets/vx300s_right.xml +59 -0
  27. gym_aloha-0.1.0/gym_aloha/constants.py +163 -0
  28. gym_aloha-0.1.0/gym_aloha/env.py +190 -0
  29. gym_aloha-0.1.0/gym_aloha/tasks/sim.py +219 -0
  30. gym_aloha-0.1.0/gym_aloha/tasks/sim_end_effector.py +263 -0
  31. gym_aloha-0.1.0/gym_aloha/utils.py +43 -0
  32. gym_aloha-0.1.0/pyproject.toml +77 -0
@@ -0,0 +1,228 @@
1
+ Copyright 2024 The Hugging Face team. All rights reserved.
2
+
3
+ Apache License
4
+ Version 2.0, January 2004
5
+ http://www.apache.org/licenses/
6
+
7
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
8
+
9
+ 1. Definitions.
10
+
11
+ "License" shall mean the terms and conditions for use, reproduction,
12
+ and distribution as defined by Sections 1 through 9 of this document.
13
+
14
+ "Licensor" shall mean the copyright owner or entity authorized by
15
+ the copyright owner that is granting the License.
16
+
17
+ "Legal Entity" shall mean the union of the acting entity and all
18
+ other entities that control, are controlled by, or are under common
19
+ control with that entity. For the purposes of this definition,
20
+ "control" means (i) the power, direct or indirect, to cause the
21
+ direction or management of such entity, whether by contract or
22
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
23
+ outstanding shares, or (iii) beneficial ownership of such entity.
24
+
25
+ "You" (or "Your") shall mean an individual or Legal Entity
26
+ exercising permissions granted by this License.
27
+
28
+ "Source" form shall mean the preferred form for making modifications,
29
+ including but not limited to software source code, documentation
30
+ source, and configuration files.
31
+
32
+ "Object" form shall mean any form resulting from mechanical
33
+ transformation or translation of a Source form, including but
34
+ not limited to compiled object code, generated documentation,
35
+ and conversions to other media types.
36
+
37
+ "Work" shall mean the work of authorship, whether in Source or
38
+ Object form, made available under the License, as indicated by a
39
+ copyright notice that is included in or attached to the work
40
+ (an example is provided in the Appendix below).
41
+
42
+ "Derivative Works" shall mean any work, whether in Source or Object
43
+ form, that is based on (or derived from) the Work and for which the
44
+ editorial revisions, annotations, elaborations, or other modifications
45
+ represent, as a whole, an original work of authorship. For the purposes
46
+ of this License, Derivative Works shall not include works that remain
47
+ separable from, or merely link (or bind by name) to the interfaces of,
48
+ the Work and Derivative Works thereof.
49
+
50
+ "Contribution" shall mean any work of authorship, including
51
+ the original version of the Work and any modifications or additions
52
+ to that Work or Derivative Works thereof, that is intentionally
53
+ submitted to Licensor for inclusion in the Work by the copyright owner
54
+ or by an individual or Legal Entity authorized to submit on behalf of
55
+ the copyright owner. For the purposes of this definition, "submitted"
56
+ means any form of electronic, verbal, or written communication sent
57
+ to the Licensor or its representatives, including but not limited to
58
+ communication on electronic mailing lists, source code control systems,
59
+ and issue tracking systems that are managed by, or on behalf of, the
60
+ Licensor for the purpose of discussing and improving the Work, but
61
+ excluding communication that is conspicuously marked or otherwise
62
+ designated in writing by the copyright owner as "Not a Contribution."
63
+
64
+ "Contributor" shall mean Licensor and any individual or Legal Entity
65
+ on behalf of whom a Contribution has been received by Licensor and
66
+ subsequently incorporated within the Work.
67
+
68
+ 2. Grant of Copyright License. Subject to the terms and conditions of
69
+ this License, each Contributor hereby grants to You a perpetual,
70
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
71
+ copyright license to reproduce, prepare Derivative Works of,
72
+ publicly display, publicly perform, sublicense, and distribute the
73
+ Work and such Derivative Works in Source or Object form.
74
+
75
+ 3. Grant of Patent License. Subject to the terms and conditions of
76
+ this License, each Contributor hereby grants to You a perpetual,
77
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
78
+ (except as stated in this section) patent license to make, have made,
79
+ use, offer to sell, sell, import, and otherwise transfer the Work,
80
+ where such license applies only to those patent claims licensable
81
+ by such Contributor that are necessarily infringed by their
82
+ Contribution(s) alone or by combination of their Contribution(s)
83
+ with the Work to which such Contribution(s) was submitted. If You
84
+ institute patent litigation against any entity (including a
85
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
86
+ or a Contribution incorporated within the Work constitutes direct
87
+ or contributory patent infringement, then any patent licenses
88
+ granted to You under this License for that Work shall terminate
89
+ as of the date such litigation is filed.
90
+
91
+ 4. Redistribution. You may reproduce and distribute copies of the
92
+ Work or Derivative Works thereof in any medium, with or without
93
+ modifications, and in Source or Object form, provided that You
94
+ meet the following conditions:
95
+
96
+ (a) You must give any other recipients of the Work or
97
+ Derivative Works a copy of this License; and
98
+
99
+ (b) You must cause any modified files to carry prominent notices
100
+ stating that You changed the files; and
101
+
102
+ (c) You must retain, in the Source form of any Derivative Works
103
+ that You distribute, all copyright, patent, trademark, and
104
+ attribution notices from the Source form of the Work,
105
+ excluding those notices that do not pertain to any part of
106
+ the Derivative Works; and
107
+
108
+ (d) If the Work includes a "NOTICE" text file as part of its
109
+ distribution, then any Derivative Works that You distribute must
110
+ include a readable copy of the attribution notices contained
111
+ within such NOTICE file, excluding those notices that do not
112
+ pertain to any part of the Derivative Works, in at least one
113
+ of the following places: within a NOTICE text file distributed
114
+ as part of the Derivative Works; within the Source form or
115
+ documentation, if provided along with the Derivative Works; or,
116
+ within a display generated by the Derivative Works, if and
117
+ wherever such third-party notices normally appear. The contents
118
+ of the NOTICE file are for informational purposes only and
119
+ do not modify the License. You may add Your own attribution
120
+ notices within Derivative Works that You distribute, alongside
121
+ or as an addendum to the NOTICE text from the Work, provided
122
+ that such additional attribution notices cannot be construed
123
+ as modifying the License.
124
+
125
+ You may add Your own copyright statement to Your modifications and
126
+ may provide additional or different license terms and conditions
127
+ for use, reproduction, or distribution of Your modifications, or
128
+ for any such Derivative Works as a whole, provided Your use,
129
+ reproduction, and distribution of the Work otherwise complies with
130
+ the conditions stated in this License.
131
+
132
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
133
+ any Contribution intentionally submitted for inclusion in the Work
134
+ by You to the Licensor shall be under the terms and conditions of
135
+ this License, without any additional terms or conditions.
136
+ Notwithstanding the above, nothing herein shall supersede or modify
137
+ the terms of any separate license agreement you may have executed
138
+ with Licensor regarding such Contributions.
139
+
140
+ 6. Trademarks. This License does not grant permission to use the trade
141
+ names, trademarks, service marks, or product names of the Licensor,
142
+ except as required for reasonable and customary use in describing the
143
+ origin of the Work and reproducing the content of the NOTICE file.
144
+
145
+ 7. Disclaimer of Warranty. Unless required by applicable law or
146
+ agreed to in writing, Licensor provides the Work (and each
147
+ Contributor provides its Contributions) on an "AS IS" BASIS,
148
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
149
+ implied, including, without limitation, any warranties or conditions
150
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
151
+ PARTICULAR PURPOSE. You are solely responsible for determining the
152
+ appropriateness of using or redistributing the Work and assume any
153
+ risks associated with Your exercise of permissions under this License.
154
+
155
+ 8. Limitation of Liability. In no event and under no legal theory,
156
+ whether in tort (including negligence), contract, or otherwise,
157
+ unless required by applicable law (such as deliberate and grossly
158
+ negligent acts) or agreed to in writing, shall any Contributor be
159
+ liable to You for damages, including any direct, indirect, special,
160
+ incidental, or consequential damages of any character arising as a
161
+ result of this License or out of the use or inability to use the
162
+ Work (including but not limited to damages for loss of goodwill,
163
+ work stoppage, computer failure or malfunction, or any and all
164
+ other commercial damages or losses), even if such Contributor
165
+ has been advised of the possibility of such damages.
166
+
167
+ 9. Accepting Warranty or Additional Liability. While redistributing
168
+ the Work or Derivative Works thereof, You may choose to offer,
169
+ and charge a fee for, acceptance of support, warranty, indemnity,
170
+ or other liability obligations and/or rights consistent with this
171
+ License. However, in accepting such obligations, You may act only
172
+ on Your own behalf and on Your sole responsibility, not on behalf
173
+ of any other Contributor, and only if You agree to indemnify,
174
+ defend, and hold each Contributor harmless for any liability
175
+ incurred by, or claims asserted against, such Contributor by reason
176
+ of your accepting any such warranty or additional liability.
177
+
178
+ END OF TERMS AND CONDITIONS
179
+
180
+ APPENDIX: How to apply the Apache License to your work.
181
+
182
+ To apply the Apache License to your work, attach the following
183
+ boilerplate notice, with the fields enclosed by brackets "[]"
184
+ replaced with your own identifying information. (Don't include
185
+ the brackets!) The text should be enclosed in the appropriate
186
+ comment syntax for the file format. We also recommend that a
187
+ file or class name and description of purpose be included on the
188
+ same "printed page" as the copyright notice for easier
189
+ identification within third-party archives.
190
+
191
+ Copyright [yyyy] [name of copyright owner]
192
+
193
+ Licensed under the Apache License, Version 2.0 (the "License");
194
+ you may not use this file except in compliance with the License.
195
+ You may obtain a copy of the License at
196
+
197
+ http://www.apache.org/licenses/LICENSE-2.0
198
+
199
+ Unless required by applicable law or agreed to in writing, software
200
+ distributed under the License is distributed on an "AS IS" BASIS,
201
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
202
+ See the License for the specific language governing permissions and
203
+ limitations under the License.
204
+
205
+
206
+ ## gym-aloha code is derived from ALOHA, which is subject to the following copyright notice:
207
+
208
+ MIT License
209
+
210
+ Copyright (c) 2023 Tony Z. Zhao
211
+
212
+ Permission is hereby granted, free of charge, to any person obtaining a copy
213
+ of this software and associated documentation files (the "Software"), to deal
214
+ in the Software without restriction, including without limitation the rights
215
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
216
+ copies of the Software, and to permit persons to whom the Software is
217
+ furnished to do so, subject to the following conditions:
218
+
219
+ The above copyright notice and this permission notice shall be included in all
220
+ copies or substantial portions of the Software.
221
+
222
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
223
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
224
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
225
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
226
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
227
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
228
+ SOFTWARE.
@@ -0,0 +1,162 @@
1
+ Metadata-Version: 2.1
2
+ Name: gym-aloha
3
+ Version: 0.1.0
4
+ Summary: A gym environment for ALOHA
5
+ License: Apache-2.0
6
+ Keywords: robotics,deep,reinforcement,learning,aloha,environment,gym,gymnasium,dm-control,mujoco
7
+ Author: Rémi Cadène
8
+ Author-email: re.cadene@gmail.com
9
+ Requires-Python: >=3.10,<4.0
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: License :: OSI Approved :: Apache Software License
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.10
15
+ Classifier: Programming Language :: Python :: 3.11
16
+ Classifier: Programming Language :: Python :: 3.12
17
+ Classifier: Topic :: Software Development :: Build Tools
18
+ Provides-Extra: dev
19
+ Provides-Extra: test
20
+ Requires-Dist: debugpy (>=1.8.1,<2.0.0) ; extra == "dev"
21
+ Requires-Dist: dm-control (==1.0.14)
22
+ Requires-Dist: gymnasium (>=0.29.1,<0.30.0)
23
+ Requires-Dist: imageio[ffmpeg] (>=2.34.0,<3.0.0)
24
+ Requires-Dist: mujoco (>=2.3.7,<3.0.0)
25
+ Requires-Dist: pre-commit (>=3.7.0,<4.0.0) ; extra == "dev"
26
+ Requires-Dist: pytest (>=8.1.0,<9.0.0) ; extra == "test"
27
+ Requires-Dist: pytest-cov (>=5.0.0,<6.0.0) ; extra == "test"
28
+ Description-Content-Type: text/markdown
29
+
30
+ # gym-aloha
31
+
32
+ A gym environment for ALOHA
33
+
34
+ <img src="http://remicadene.com/assets/gif/aloha_act.gif" width="50%" alt="ACT policy on ALOHA env"/>
35
+
36
+
37
+ ## Installation
38
+
39
+ Create a virtual environment with Python 3.10 and activate it, e.g. with [`miniconda`](https://docs.anaconda.com/free/miniconda/index.html):
40
+ ```bash
41
+ conda create -y -n aloha python=3.10 && conda activate aloha
42
+ ```
43
+
44
+ Install gym-aloha:
45
+ ```bash
46
+ pip install gym-aloha
47
+ ```
48
+
49
+
50
+ ## Quickstart
51
+
52
+ ```python
53
+ # example.py
54
+ import imageio
55
+ import gymnasium as gym
56
+ import numpy as np
57
+ import gym_aloha
58
+
59
+ env = gym.make("gym_aloha/AlohaInsertion-v0")
60
+ observation, info = env.reset()
61
+ frames = []
62
+
63
+ for _ in range(1000):
64
+ action = env.action_space.sample()
65
+ observation, reward, terminated, truncated, info = env.step(action)
66
+ image = env.render()
67
+ frames.append(image)
68
+
69
+ if terminated or truncated:
70
+ observation, info = env.reset()
71
+
72
+ env.close()
73
+ imageio.mimsave("example.mp4", np.stack(frames), fps=25)
74
+ ```
75
+
76
+
77
+ ## Description
78
+ Aloha environment.
79
+
80
+ Two tasks are available:
81
+ - TransferCubeTask: The right arm needs to first pick up the red cube lying on the table, then place it inside the gripper of the other arm.
82
+ - InsertionTask: The left and right arms need to pick up the socket and peg respectively, and then insert in mid-air so the peg touches the “pins” inside the socket.
83
+
84
+ ### Action Space
85
+ The action space consists of continuous values for each arm and gripper, resulting in a 14-dimensional vector:
86
+ - Six values for each arm's joint positions (absolute values).
87
+ - One value for each gripper's position, normalized between 0 (closed) and 1 (open).
88
+
89
+ ### Observation Space
90
+ Observations are provided as a dictionary with the following keys:
91
+
92
+ - `qpos` and `qvel`: Position and velocity data for the arms and grippers.
93
+ - `images`: Camera feeds from different angles.
94
+ - `env_state`: Additional environment state information, such as positions of the peg and sockets.
95
+
96
+ ### Rewards
97
+ - TransferCubeTask:
98
+ - 1 point for holding the box with the right gripper.
99
+ - 2 points if the box is lifted with the right gripper.
100
+ - 3 points for transferring the box to the left gripper.
101
+ - 4 points for a successful transfer without touching the table.
102
+ - InsertionTask:
103
+ - 1 point for touching both the peg and a socket with the grippers.
104
+ - 2 points for grasping both without dropping them.
105
+ - 3 points if the peg is aligned with and touching the socket.
106
+ - 4 points for successful insertion of the peg into the socket.
107
+
108
+ ### Success Criteria
109
+ Achieving the maximum reward of 4 points.
110
+
111
+ ### Starting State
112
+ The arms and the items (block, peg, socket) start at a random position and angle.
113
+
114
+ ### Arguments
115
+
116
+ ```python
117
+ >>> import gymnasium as gym
118
+ >>> import gym_aloha
119
+ >>> env = gym.make("gym_aloha/AlohaInsertion-v0", obs_type="pixels", render_mode="rgb_array")
120
+ >>> env
121
+ <TimeLimit<OrderEnforcing<PassiveEnvChecker<AlohaEnv<gym_aloha/AlohaInsertion-v0>>>>>
122
+ ```
123
+
124
+ * `obs_type`: (str) The observation type. Can be either `pixels` or `pixels_agent_pos`. Default is `pixels`.
125
+
126
+ * `render_mode`: (str) The rendering mode. Only `rgb_array` is supported for now.
127
+
128
+ * `observation_width`: (int) The width of the observed image. Default is `640`.
129
+
130
+ * `observation_height`: (int) The height of the observed image. Default is `480`.
131
+
132
+ * `visualization_width`: (int) The width of the visualized image. Default is `640`.
133
+
134
+ * `visualization_height`: (int) The height of the visualized image. Default is `480`.
135
+
136
+
137
+ ## Contribute
138
+
139
+ Instead of using `pip` directly, we use `poetry` for development purposes to easily track our dependencies.
140
+ If you don't have it already, follow the [instructions](https://python-poetry.org/docs/#installation) to install it.
141
+
142
+ Install the project with dev dependencies:
143
+ ```bash
144
+ poetry install --all-extras
145
+ ```
146
+
147
+
148
+ ### Follow our style
149
+
150
+ ```bash
151
+ # install pre-commit hooks
152
+ pre-commit install
153
+
154
+ # apply style and linter checks on staged files
155
+ pre-commit
156
+ ```
157
+
158
+
159
+ ## Acknowledgment
160
+
161
+ gym-aloha is adapted from [ALOHA](https://tonyzhaozh.github.io/aloha/)
162
+
@@ -0,0 +1,132 @@
1
+ # gym-aloha
2
+
3
+ A gym environment for ALOHA
4
+
5
+ <img src="http://remicadene.com/assets/gif/aloha_act.gif" width="50%" alt="ACT policy on ALOHA env"/>
6
+
7
+
8
+ ## Installation
9
+
10
+ Create a virtual environment with Python 3.10 and activate it, e.g. with [`miniconda`](https://docs.anaconda.com/free/miniconda/index.html):
11
+ ```bash
12
+ conda create -y -n aloha python=3.10 && conda activate aloha
13
+ ```
14
+
15
+ Install gym-aloha:
16
+ ```bash
17
+ pip install gym-aloha
18
+ ```
19
+
20
+
21
+ ## Quickstart
22
+
23
+ ```python
24
+ # example.py
25
+ import imageio
26
+ import gymnasium as gym
27
+ import numpy as np
28
+ import gym_aloha
29
+
30
+ env = gym.make("gym_aloha/AlohaInsertion-v0")
31
+ observation, info = env.reset()
32
+ frames = []
33
+
34
+ for _ in range(1000):
35
+ action = env.action_space.sample()
36
+ observation, reward, terminated, truncated, info = env.step(action)
37
+ image = env.render()
38
+ frames.append(image)
39
+
40
+ if terminated or truncated:
41
+ observation, info = env.reset()
42
+
43
+ env.close()
44
+ imageio.mimsave("example.mp4", np.stack(frames), fps=25)
45
+ ```
46
+
47
+
48
+ ## Description
49
+ Aloha environment.
50
+
51
+ Two tasks are available:
52
+ - TransferCubeTask: The right arm needs to first pick up the red cube lying on the table, then place it inside the gripper of the other arm.
53
+ - InsertionTask: The left and right arms need to pick up the socket and peg respectively, and then insert in mid-air so the peg touches the “pins” inside the socket.
54
+
55
+ ### Action Space
56
+ The action space consists of continuous values for each arm and gripper, resulting in a 14-dimensional vector:
57
+ - Six values for each arm's joint positions (absolute values).
58
+ - One value for each gripper's position, normalized between 0 (closed) and 1 (open).
59
+
60
+ ### Observation Space
61
+ Observations are provided as a dictionary with the following keys:
62
+
63
+ - `qpos` and `qvel`: Position and velocity data for the arms and grippers.
64
+ - `images`: Camera feeds from different angles.
65
+ - `env_state`: Additional environment state information, such as positions of the peg and sockets.
66
+
67
+ ### Rewards
68
+ - TransferCubeTask:
69
+ - 1 point for holding the box with the right gripper.
70
+ - 2 points if the box is lifted with the right gripper.
71
+ - 3 points for transferring the box to the left gripper.
72
+ - 4 points for a successful transfer without touching the table.
73
+ - InsertionTask:
74
+ - 1 point for touching both the peg and a socket with the grippers.
75
+ - 2 points for grasping both without dropping them.
76
+ - 3 points if the peg is aligned with and touching the socket.
77
+ - 4 points for successful insertion of the peg into the socket.
78
+
79
+ ### Success Criteria
80
+ Achieving the maximum reward of 4 points.
81
+
82
+ ### Starting State
83
+ The arms and the items (block, peg, socket) start at a random position and angle.
84
+
85
+ ### Arguments
86
+
87
+ ```python
88
+ >>> import gymnasium as gym
89
+ >>> import gym_aloha
90
+ >>> env = gym.make("gym_aloha/AlohaInsertion-v0", obs_type="pixels", render_mode="rgb_array")
91
+ >>> env
92
+ <TimeLimit<OrderEnforcing<PassiveEnvChecker<AlohaEnv<gym_aloha/AlohaInsertion-v0>>>>>
93
+ ```
94
+
95
+ * `obs_type`: (str) The observation type. Can be either `pixels` or `pixels_agent_pos`. Default is `pixels`.
96
+
97
+ * `render_mode`: (str) The rendering mode. Only `rgb_array` is supported for now.
98
+
99
+ * `observation_width`: (int) The width of the observed image. Default is `640`.
100
+
101
+ * `observation_height`: (int) The height of the observed image. Default is `480`.
102
+
103
+ * `visualization_width`: (int) The width of the visualized image. Default is `640`.
104
+
105
+ * `visualization_height`: (int) The height of the visualized image. Default is `480`.
106
+
107
+
108
+ ## Contribute
109
+
110
+ Instead of using `pip` directly, we use `poetry` for development purposes to easily track our dependencies.
111
+ If you don't have it already, follow the [instructions](https://python-poetry.org/docs/#installation) to install it.
112
+
113
+ Install the project with dev dependencies:
114
+ ```bash
115
+ poetry install --all-extras
116
+ ```
117
+
118
+
119
+ ### Follow our style
120
+
121
+ ```bash
122
+ # install pre-commit hooks
123
+ pre-commit install
124
+
125
+ # apply style and linter checks on staged files
126
+ pre-commit
127
+ ```
128
+
129
+
130
+ ## Acknowledgment
131
+
132
+ gym-aloha is adapted from [ALOHA](https://tonyzhaozh.github.io/aloha/)
@@ -0,0 +1,21 @@
1
+ from gymnasium.envs.registration import register
2
+
3
+ register(
4
+ id="gym_aloha/AlohaInsertion-v0",
5
+ entry_point="gym_aloha.env:AlohaEnv",
6
+ max_episode_steps=300,
7
+ # Even after seeding, the rendered observations are slightly different,
8
+ # so we set `nondeterministic=True` to pass `check_env` tests
9
+ nondeterministic=True,
10
+ kwargs={"obs_type": "pixels", "task": "insertion"},
11
+ )
12
+
13
+ register(
14
+ id="gym_aloha/AlohaTransferCube-v0",
15
+ entry_point="gym_aloha.env:AlohaEnv",
16
+ max_episode_steps=300,
17
+ # Even after seeding, the rendered observations are slightly different,
18
+ # so we set `nondeterministic=True` to pass `check_env` tests
19
+ nondeterministic=True,
20
+ kwargs={"obs_type": "pixels", "task": "transfer_cube"},
21
+ )
@@ -0,0 +1,59 @@
1
+ <mujoco>
2
+ <include file="scene.xml"/>
3
+ <include file="vx300s_dependencies.xml"/>
4
+
5
+ <equality>
6
+ <weld body1="mocap_left" body2="vx300s_left/gripper_link" solref="0.01 1" solimp=".25 .25 0.001" />
7
+ <weld body1="mocap_right" body2="vx300s_right/gripper_link" solref="0.01 1" solimp=".25 .25 0.001" />
8
+ </equality>
9
+
10
+
11
+ <worldbody>
12
+ <include file="vx300s_left.xml" />
13
+ <include file="vx300s_right.xml" />
14
+
15
+ <body mocap="true" name="mocap_left" pos="0.095 0.50 0.425">
16
+ <site pos="0 0 0" size="0.003 0.003 0.03" type="box" name="mocap_left_site1" rgba="1 0 0 1"/>
17
+ <site pos="0 0 0" size="0.003 0.03 0.003" type="box" name="mocap_left_site2" rgba="1 0 0 1"/>
18
+ <site pos="0 0 0" size="0.03 0.003 0.003" type="box" name="mocap_left_site3" rgba="1 0 0 1"/>
19
+ </body>
20
+ <body mocap="true" name="mocap_right" pos="-0.095 0.50 0.425">
21
+ <site pos="0 0 0" size="0.003 0.003 0.03" type="box" name="mocap_right_site1" rgba="1 0 0 1"/>
22
+ <site pos="0 0 0" size="0.003 0.03 0.003" type="box" name="mocap_right_site2" rgba="1 0 0 1"/>
23
+ <site pos="0 0 0" size="0.03 0.003 0.003" type="box" name="mocap_right_site3" rgba="1 0 0 1"/>
24
+ </body>
25
+
26
+ <body name="peg" pos="0.2 0.5 0.05">
27
+ <joint name="red_peg_joint" type="free" frictionloss="0.01" />
28
+ <inertial pos="0 0 0" mass="0.05" diaginertia="0.002 0.002 0.002" />
29
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.005 0.0001" pos="0 0 0" size="0.06 0.01 0.01" type="box" name="red_peg" rgba="1 0 0 1" />
30
+ </body>
31
+
32
+ <body name="socket" pos="-0.2 0.5 0.05">
33
+ <joint name="blue_socket_joint" type="free" frictionloss="0.01" />
34
+ <inertial pos="0 0 0" mass="0.05" diaginertia="0.002 0.002 0.002" />
35
+ <!-- <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.005 0.0001" pos="0 0 0" size="0.06 0.01 0.01" type="box" name="red_peg_ref" rgba="1 0 0 1" />-->
36
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.05 0.001" pos="0 0 -0.02" size="0.06 0.018 0.002" type="box" name="socket-1" rgba="0 0 1 1" />
37
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.05 0.001" pos="0 0 0.02" size="0.06 0.018 0.002" type="box" name="socket-2" rgba="0 0 1 1" />
38
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.05 0.001" pos="0 0.02 0" size="0.06 0.002 0.018" type="box" name="socket-3" rgba="0 0 1 1" />
39
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.05 0.001" pos="0 -0.02 0" size="0.06 0.002 0.018" type="box" name="socket-4" rgba="0 0 1 1" />
40
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.005 0.0001" pos="0 0 0" size="0.04 0.01 0.01" type="box" name="pin" rgba="1 0 0 1" />
41
+ </body>
42
+
43
+ </worldbody>
44
+
45
+ <actuator>
46
+ <position ctrllimited="true" ctrlrange="0.021 0.057" joint="vx300s_left/left_finger" kp="200" user="1"/>
47
+ <position ctrllimited="true" ctrlrange="-0.057 -0.021" joint="vx300s_left/right_finger" kp="200" user="1"/>
48
+
49
+ <position ctrllimited="true" ctrlrange="0.021 0.057" joint="vx300s_right/left_finger" kp="200" user="1"/>
50
+ <position ctrllimited="true" ctrlrange="-0.057 -0.021" joint="vx300s_right/right_finger" kp="200" user="1"/>
51
+
52
+ </actuator>
53
+
54
+ <keyframe>
55
+ <key qpos="0 -0.96 1.16 0 -0.3 0 0.024 -0.024 0 -0.96 1.16 0 -0.3 0 0.024 -0.024 0.2 0.5 0.05 1 0 0 0 -0.2 0.5 0.05 1 0 0 0"/>
56
+ </keyframe>
57
+
58
+
59
+ </mujoco>
@@ -0,0 +1,48 @@
1
+ <mujoco>
2
+ <include file="scene.xml"/>
3
+ <include file="vx300s_dependencies.xml"/>
4
+
5
+ <equality>
6
+ <weld body1="mocap_left" body2="vx300s_left/gripper_link" solref="0.01 1" solimp=".25 .25 0.001" />
7
+ <weld body1="mocap_right" body2="vx300s_right/gripper_link" solref="0.01 1" solimp=".25 .25 0.001" />
8
+ </equality>
9
+
10
+
11
+ <worldbody>
12
+ <include file="vx300s_left.xml" />
13
+ <include file="vx300s_right.xml" />
14
+
15
+ <body mocap="true" name="mocap_left" pos="0.095 0.50 0.425">
16
+ <site pos="0 0 0" size="0.003 0.003 0.03" type="box" name="mocap_left_site1" rgba="1 0 0 1"/>
17
+ <site pos="0 0 0" size="0.003 0.03 0.003" type="box" name="mocap_left_site2" rgba="1 0 0 1"/>
18
+ <site pos="0 0 0" size="0.03 0.003 0.003" type="box" name="mocap_left_site3" rgba="1 0 0 1"/>
19
+ </body>
20
+ <body mocap="true" name="mocap_right" pos="-0.095 0.50 0.425">
21
+ <site pos="0 0 0" size="0.003 0.003 0.03" type="box" name="mocap_right_site1" rgba="1 0 0 1"/>
22
+ <site pos="0 0 0" size="0.003 0.03 0.003" type="box" name="mocap_right_site2" rgba="1 0 0 1"/>
23
+ <site pos="0 0 0" size="0.03 0.003 0.003" type="box" name="mocap_right_site3" rgba="1 0 0 1"/>
24
+ </body>
25
+
26
+ <body name="box" pos="0.2 0.5 0.05">
27
+ <joint name="red_box_joint" type="free" frictionloss="0.01" />
28
+ <inertial pos="0 0 0" mass="0.05" diaginertia="0.002 0.002 0.002" />
29
+ <geom condim="4" solimp="2 1 0.01" solref="0.01 1" friction="1 0.005 0.0001" pos="0 0 0" size="0.02 0.02 0.02" type="box" name="red_box" rgba="1 0 0 1" />
30
+ </body>
31
+
32
+ </worldbody>
33
+
34
+ <actuator>
35
+ <position ctrllimited="true" ctrlrange="0.021 0.057" joint="vx300s_left/left_finger" kp="200" user="1"/>
36
+ <position ctrllimited="true" ctrlrange="-0.057 -0.021" joint="vx300s_left/right_finger" kp="200" user="1"/>
37
+
38
+ <position ctrllimited="true" ctrlrange="0.021 0.057" joint="vx300s_right/left_finger" kp="200" user="1"/>
39
+ <position ctrllimited="true" ctrlrange="-0.057 -0.021" joint="vx300s_right/right_finger" kp="200" user="1"/>
40
+
41
+ </actuator>
42
+
43
+ <keyframe>
44
+ <key qpos="0 -0.96 1.16 0 -0.3 0 0.024 -0.024 0 -0.96 1.16 0 -0.3 0 0.024 -0.024 0.2 0.5 0.05 1 0 0 0"/>
45
+ </keyframe>
46
+
47
+
48
+ </mujoco>