Skip to content

Commit ac8df07

Browse files
Merge pull request #571 from Abhiram824/docs_update
Docs update
2 parents 18a11eb + a98f0de commit ac8df07

File tree

7 files changed

+11
-143
lines changed

7 files changed

+11
-143
lines changed

docs/acknowledgement.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,5 +9,6 @@
99
- [Andrew Kondrich](http://www.andrewkondrich.com/), [Jonathan Booher](https://web.stanford.edu/~jaustinb/) (domain randomization)
1010
- [Albert Tung](https://www.linkedin.com/in/albert-tung3/) (demonstration collection)
1111
- [Divyansh Jha](https://github.com/divyanshj16), [Fei Xia](http://fxia.me/) (robosuite v1.3 renderers)
12+
- [Zhenyu Jiang](https://zhenyujiang.me/), [Yuqi Xie](https://xieleo5.github.io/), [You Liang Tan](https://youliangtan.github.io/), (robosuite v1.5)
1213

1314
We wholeheartedly welcome the community to contribute to our project through issues and pull requests. New contributors will be added to the list above.

docs/algorithms/demonstrations.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -45,8 +45,6 @@ We have included an example script that illustrates how demonstrations can be lo
4545

4646
We have included some sample demonstrations for each task at `models/assets/demonstrations`.
4747

48-
Our sister project [RoboTurk](http://roboturk.stanford.edu) has also collected several human demonstration datasets across different tasks and humans, including pilot datasets of more than a thousand demonstrations for two tasks in our suite via crowdsourcing. You can find detailed information about the RoboTurk datasets [here](roboturk).
49-
5048

5149
## Structure of collected demonstrations
5250

docs/algorithms/roboturk.md

Lines changed: 0 additions & 36 deletions
This file was deleted.

docs/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,6 @@ Welcome to robosuite's documentation!
6767
algorithms/benchmarking
6868
algorithms/demonstrations
6969
algorithms/sim2real
70-
algorithms/roboturk
7170

7271
.. toctree::
7372
:maxdepth: 1

docs/modules/environments.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -10,17 +10,17 @@ Environments are created by calling `robosuite.make` with the name of the task a
1010

1111
```python
1212
import robosuite
13-
from robosuite.controllers import load_part_controller_config
13+
from robosuite.controllers import load_composite_controller_config
1414

15-
# load default controller parameters for Operational Space Control (OSC)
16-
controller_config = load_part_controller_config(default_controller="OSC_POSE")
15+
# BASIC controller: arms controlled using OSC, mobile base (if present) using JOINT_VELOCITY, other parts controlled using JOINT_POSITION
16+
controller_config = load_composite_controller_config(controller="BASIC")
1717

1818
# create an environment to visualize on-screen
1919
env = robosuite.make(
2020
"TwoArmLift",
2121
robots=["Sawyer", "Panda"], # load a Sawyer robot and a Panda robot
2222
gripper_types="default", # use default grippers per robot arm
23-
controller_configs=controller_config, # each arm is controlled using OSC
23+
controller_configs=controller_config, # arms controlled via OSC, other parts via JOINT_POSITION/JOINT_VELOCITY
2424
env_configuration="opposed", # (two-arm envs only) arms face each other
2525
has_renderer=True, # on-screen rendering
2626
render_camera="frontview", # visualize the "frontview" camera
@@ -36,7 +36,7 @@ env = robosuite.make(
3636
"TwoArmLift",
3737
robots=["Sawyer", "Panda"], # load a Sawyer robot and a Panda robot
3838
gripper_types="default", # use default grippers per robot arm
39-
controller_configs=controller_config, # each arm is controlled using OSC
39+
controller_configs=controller_config, # arms controlled via OSC, other parts via JOINT_POSITION/JOINT_VELOCITY
4040
env_configuration="opposed", # (two-arm envs only) arms face each other
4141
has_renderer=False, # no on-screen rendering
4242
has_offscreen_renderer=False, # no off-screen rendering
@@ -52,7 +52,7 @@ env = robosuite.make(
5252
"TwoArmLift",
5353
robots=["Sawyer", "Panda"], # load a Sawyer robot and a Panda robot
5454
gripper_types="default", # use default grippers per robot arm
55-
controller_configs=controller_config, # each arm is controlled using OSC
55+
controller_configs=controller_config, # arms controlled via OSC, other parts via JOINT_POSITION/JOINT_VELOCITY
5656
env_configuration="opposed", # (two-arm envs only) arms face each other
5757
has_renderer=False, # no on-screen rendering
5858
has_offscreen_renderer=True, # off-screen rendering needed for image obs
@@ -73,7 +73,7 @@ We provide a few additional details on a few keyword arguments below to highligh
7373

7474
- `robots` : this argument can be used to easily instantiate tasks with different robot arms. For example, we could change the task to use two "Jaco" robots by passing `robots=["Jaco", "Jaco"]`. Once the environment is initialized, these robots (as captured by the [Robot](../simulation/robot.html#robot) class) can be accessed via the `robots` array attribute within the environment, i.e.: `env.robots[i]` for the `ith` robot arm in the environment.
7575
- `gripper_types` : this argument can be used to easily swap out different grippers for each robot arm. For example, suppose we want to swap the default grippers for the arms in the example above. We could just pass `gripper_types=["PandaGripper", "RethinkGripper"]` to achieve this. Note that a single type can also be used to automatically broadcast the same gripper type across all arms.
76-
- `controller_configs` : this argument can be used to easily replace the action space for each robot arm. For example, if we would like to control the arm using joint velocities instead of OSC, we could use `load_controller_config(default_controller="JOINT_VELOCITY")` in the example above. Similar to `gripper_types` this value can either be per-arm specific or a single configuration to broadcast to all robot arms.
76+
- `controller_configs` : this argument can be used to easily replace the action space for each robot. For example, if we would like to control the robot using IK instead of OSC, we could use `load_composite_controller_config(controller="WHOLE_BODY_IK")` in the example above.
7777
- `env_configuration` : this argument is mainly used for two-arm tasks to easily configure how the robots are oriented with respect to one another. For example, in the `TwoArmLift` environment, we could pass `env_configuration="parallel"` instead so that the robot arms are located next to each other, instead of opposite each other
7878
- `placement_initializer` : this argument is optional, but can be used to specify a custom `ObjectPositionSampler` to override the default start state distribution for Mujoco objects. Samplers are responsible for sampling a set of valid, non-colliding placements for all of the objects in the scene at the start of each episode (e.g. when `env.reset()` is called).
7979

docs/modules/robots.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
![robot_overview_diagram](../images/robot_module.png)
44

5-
**Robots** are a key component in **robosuite**, and serve as the embodiment of a given agent as well as the central interaction point within an environment and key interface to MuJoCo for the robot-related state and control. **robosuite** captures this level of abstraction with the [Robot](../simulation/robot)-based classes, with support for both single-armed and bimanual variations. In turn, the Robot class is centrally defined by a [RobotModel](../modeling/robot_model), [RobotBaseModel](../modeling/robot_model.html#base-model), and [Controller(s)](../simulation/controller). Subclasses of the `RobotModel` class may also include additional models as well; for example, the [ManipulatorModel](../modeling/robot_model.html#manipulator-model) class also includes [GripperModel(s)](../modeling/robot_model.html#gripper-model) (with no gripper being represented by a dummy class).
5+
**Robots** are a key component in **robosuite**, and serve as the embodiment of a given agent as well as the central interaction point within an environment and key interface to MuJoCo for the robot-related state and control. **robosuite** captures this level of abstraction with the [Robot](../simulation/robot)-based classes, with support for both fixed-base and mobile-base (which includes legged and wheeled robots) variations. In turn, the Robot class is centrally defined by a [RobotModel](../modeling/robot_model), [RobotBaseModel](../modeling/robot_model.html#base-model), and [Controller(s)](../simulation/controller). Subclasses of the `RobotModel` class may also include additional models as well; for example, the [ManipulatorModel](../modeling/robot_model.html#manipulator-model) class also includes [GripperModel(s)](../modeling/robot_model.html#gripper-model) (with no gripper being represented by a dummy class).
66

77
The high-level features of **robosuite**'s robots are described as follows:
88

9-
* **Diverse and Realistic Models**: **robosuite** provides models for 8 commercially-available manipulator robots (including the bimanual Baxter robot), 7 grippers (including the popular Robotiq 140 / 85 models), and 6 controllers, with model properties either taken directly from the company website or raw spec sheets.
9+
* **Diverse and Realistic Models**: **robosuite** provides models for 20 commercially-available robots (including the humanoid GR1 Robot), 15 grippers (including the inspire dexterous hand model), and 6 controllers, with model properties either taken directly from the company website or raw spec sheets.
1010

1111
* **Modularized Support**: Robots are designed to be plug-n-play -- any combinations of robots, models, and controllers can be used, assuming the given environment is intended for the desired robot configuration. Because each robot is assigned a unique ID number, multiple instances of identical robots can be instantiated within the simulation without error.
1212

0 commit comments

Comments
 (0)