Skip to content

Commit

Permalink
docs: Update
Browse files Browse the repository at this point in the history
  • Loading branch information
fan-ziqi committed Sep 13, 2024
1 parent be3e55c commit 56e4520
Show file tree
Hide file tree
Showing 67 changed files with 2,896 additions and 2,016 deletions.
2 changes: 2 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,6 +39,7 @@ Guidelines for modifications:
* Brayden Zhang
* Calvin Yu
* Chenyu Yang
* David Yang
* HoJin Jeon
* Jean Tampon
* Jia Lin Yuan
Expand All @@ -61,6 +62,7 @@ Guidelines for modifications:
* Yang Jin
* Zhengyu Zhang
* Ziqi Fan
* Qian Wan

## Acknowledgements

Expand Down
1 change: 1 addition & 0 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@ Table of Contents
source/features/tiled_rendering
source/features/environments
source/features/actuators
source/features/reproducibility
.. source/features/motion_generators

.. toctree::
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Isaac Lab 1.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-08-07 08:08+0000\n"
"POT-Creation-Date: 2024-09-13 10:42+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Ziqi Fan <[email protected]>\n"
"Language: zh_CN\n"
Expand Down Expand Up @@ -484,27 +484,35 @@ msgstr ""
#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:3
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:3
msgid ""
"This function calls the :meth:`_reset_idx` function to reset all the "
"environments. However, certain operations, such as procedural terrain "
"generation, that happened during initialization are not repeated."
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:7
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:7
msgid ""
"The seed to use for randomization. Defaults to None, in which case the "
"seed is not set."
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:4
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:4
#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:8
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:8
msgid ""
"Additional information to specify how the environment is reset. Defaults "
"to None. .. note:: This argument is used for compatibility with "
"Gymnasium environment definition."
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:4
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:4
#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:8
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:8
msgid ""
"Additional information to specify how the environment is reset. Defaults "
"to None."
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:6
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:6
#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:10
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:10
msgid ""
"This argument is used for compatibility with Gymnasium environment "
"definition."
Expand All @@ -527,8 +535,8 @@ msgstr ""
msgid "Returns"
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:8
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:8
#: of omni.isaac.lab.envs.direct_rl_env.DirectRLEnv.reset:12
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.reset:12
#: omni.isaac.lab.envs.manager_based_env.ManagerBasedEnv.step:11
msgid "A tuple containing the observations and extras."
msgstr ""
Expand Down Expand Up @@ -581,6 +589,16 @@ msgstr ""
msgid "Physics simulation configuration."
msgstr ""

#: of
#: omni.isaac.lab.envs.manager_based_env_cfg.ManagerBasedEnvCfg:1:<autosummary>:1
msgid ":py:obj:`seed <omni.isaac.lab.envs.ManagerBasedEnvCfg.seed>`\\"
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env_cfg.DirectRLEnvCfg:1:<autosummary>:1
#: omni.isaac.lab.envs.manager_based_env_cfg.ManagerBasedEnvCfg:1:<autosummary>:1
msgid "The seed for the random number generator."
msgstr ""

#: of
#: omni.isaac.lab.envs.manager_based_env_cfg.ManagerBasedEnvCfg:1:<autosummary>:1
msgid ":py:obj:`decimation <omni.isaac.lab.envs.ManagerBasedEnvCfg.decimation>`\\"
Expand Down Expand Up @@ -670,6 +688,23 @@ msgstr ""
msgid "Physics simulation configuration. Default is SimulationCfg()."
msgstr ""

#: ../../docstring of omni.isaac.lab.envs.DirectRLEnvCfg.seed:1
#: omni.isaac.lab.envs.ManagerBasedEnvCfg.seed:1
#: omni.isaac.lab.envs.ManagerBasedRLEnvCfg.seed:1
msgid ""
"The seed for the random number generator. Defaults to None, in which case"
" the seed is not set."
msgstr ""

#: ../../docstring of omni.isaac.lab.envs.DirectRLEnvCfg.seed:5
#: omni.isaac.lab.envs.ManagerBasedEnvCfg.seed:5
#: omni.isaac.lab.envs.ManagerBasedRLEnvCfg.seed:5
msgid ""
"The seed is set at the beginning of the environment initialization. This "
"ensures that the environment creation is deterministic and behaves "
"similarly across different runs."
msgstr ""

#: ../../docstring of omni.isaac.lab.envs.DirectRLEnvCfg.decimation:3
#: omni.isaac.lab.envs.ManagerBasedEnvCfg.decimation:3
#: omni.isaac.lab.envs.ManagerBasedRLEnvCfg.decimation:3
Expand Down Expand Up @@ -1417,6 +1452,10 @@ msgstr ""
msgid ":py:obj:`sim <omni.isaac.lab.envs.DirectRLEnvCfg.sim>`\\"
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env_cfg.DirectRLEnvCfg:1:<autosummary>:1
msgid ":py:obj:`seed <omni.isaac.lab.envs.DirectRLEnvCfg.seed>`\\"
msgstr ""

#: of omni.isaac.lab.envs.direct_rl_env_cfg.DirectRLEnvCfg:1:<autosummary>:1
msgid ":py:obj:`decimation <omni.isaac.lab.envs.DirectRLEnvCfg.decimation>`\\"
msgstr ""
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Isaac Lab 1.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-09-03 12:23+0800\n"
"POT-Creation-Date: 2024-09-13 10:42+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Ziqi Fan <[email protected]>\n"
"Language: zh_CN\n"
Expand Down Expand Up @@ -308,6 +308,16 @@ msgid ""
"tensors are (N, H * W, 3) and (N, H * W, 3) respectively."
msgstr ""

#: of
#: omni.isaac.lab.sensors.ray_caster.patterns.patterns_cfg.PinholeCameraPatternCfg:4
msgid ""
"Focal length as well as the aperture sizes and offsets are set as a tenth"
" of the world unit. In our case, the world unit is meters, so all of "
"these values are in cm. For more information, please check: "
"https://docs.omniverse.nvidia.com/materials-and-"
"rendering/latest/cameras.html"
msgstr ""

#: of
#: omni.isaac.lab.sensors.ray_caster.patterns.patterns_cfg.PinholeCameraPatternCfg:1:<autosummary>:1
msgid ""
Expand All @@ -329,7 +339,7 @@ msgstr ""

#: of
#: omni.isaac.lab.sensors.ray_caster.patterns.patterns_cfg.PinholeCameraPatternCfg:1:<autosummary>:1
msgid "Horizontal aperture (in mm)."
msgid "Horizontal aperture (in cm)."
msgstr ""

#: of
Expand All @@ -341,7 +351,7 @@ msgstr ""

#: of
#: omni.isaac.lab.sensors.ray_caster.patterns.patterns_cfg.PinholeCameraPatternCfg:1:<autosummary>:1
msgid "Vertical aperture (in mm)."
msgid "Vertical aperture (in cm)."
msgstr ""

#: of
Expand Down Expand Up @@ -429,7 +439,7 @@ msgstr ""

#: ../../docstring of
#: omni.isaac.lab.sensors.patterns.PinholeCameraPatternCfg.horizontal_aperture:1
msgid "Horizontal aperture (in mm). Defaults to 20.955mm."
msgid "Horizontal aperture (in cm). Defaults to 20.955 cm."
msgstr ""

#: ../../docstring of
Expand All @@ -446,7 +456,7 @@ msgstr ""

#: ../../docstring of
#: omni.isaac.lab.sensors.patterns.PinholeCameraPatternCfg.vertical_aperture:1
msgid "Vertical aperture (in mm). Defaults to None."
msgid "Vertical aperture (in cm). Defaults to None."
msgstr ""

#: ../../docstring of
Expand All @@ -461,15 +471,11 @@ msgstr ""
#: ../../docstring of
#: omni.isaac.lab.sensors.patterns.PinholeCameraPatternCfg.vertical_aperture:7
msgid ""
"ext{vertical aperture} = ext{horizontal aperture} imes\n"
"\\text{vertical aperture} = \\text{horizontal aperture} \\times "
"\\frac{\\text{height}}{\\text{width}}\n"
"\n"
msgstr ""

#: ../../docstring of
#: omni.isaac.lab.sensors.patterns.PinholeCameraPatternCfg.vertical_aperture:9
msgid "rac{ ext{height}}{ ext{width}}"
msgstr ""

#: ../../docstring of
#: omni.isaac.lab.sensors.patterns.PinholeCameraPatternCfg.horizontal_aperture_offset:1
msgid "Offsets Resolution/Film gate horizontally. Defaults to 0.0."
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ msgid ""
msgstr ""
"Project-Id-Version: Isaac Lab 1.0.0\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2024-08-07 07:55+0000\n"
"POT-Creation-Date: 2024-09-13 10:42+0800\n"
"PO-Revision-Date: YEAR-MO-DA HO:MI+ZONE\n"
"Last-Translator: Ziqi Fan <[email protected]>\n"
"Language: zh_CN\n"
Expand Down Expand Up @@ -744,6 +744,7 @@ msgid "``\"rgb\"``: A rendered color image."
msgstr ""

#: of omni.isaac.lab.sensors.camera.camera.Camera:9
#: omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:11
#: omni.isaac.lab.sensors.ray_caster.ray_caster_camera.RayCasterCamera:12
msgid ""
"``\"distance_to_camera\"``: An image containing the distance to camera "
Expand Down Expand Up @@ -1067,7 +1068,9 @@ msgstr ""

#: of omni.isaac.lab.sensors.camera.camera.Camera.set_intrinsic_matrices:18
#: omni.isaac.lab.sensors.ray_caster.ray_caster_camera.RayCasterCamera.set_intrinsic_matrices:4
msgid "Focal length to use when computing aperture values. Defaults to 1.0."
msgid ""
"Focal length to use when computing aperture values (in cm). Defaults to "
"1.0."
msgstr ""

#: of omni.isaac.lab.sensors.camera.camera.Camera.set_intrinsic_matrices:19
Expand Down Expand Up @@ -1648,11 +1651,11 @@ msgstr ""
msgid "The following sensor types are supported:"
msgstr ""

#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:11
msgid "``\"depth\"``: An image containing the distance to camera optical center."
#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:12
msgid "``\"depth\"``: An alias for ``\"distance_to_camera\"``."
msgstr ""

#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:14
#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:15
msgid ""
"Please note that the fidelity of RGB images may be lower than the "
"standard camera sensor due to the tiled rendering process. Various ray "
Expand All @@ -1661,7 +1664,7 @@ msgid ""
"improving the fidelity of the RGB images."
msgstr ""

#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:20
#: of omni.isaac.lab.sensors.camera.tiled_camera.TiledCamera:21
msgid ""
"This feature is available starting from Isaac Sim 4.0. Before this "
"version, the tiled rendering APIs were not available."
Expand Down Expand Up @@ -1772,6 +1775,10 @@ msgid ""
"\\(eyes\\, targets\\[\\, ...\\]\\)"
msgstr ""

#: ../../docstring of omni.isaac.lab.sensors.TiledCamera.SUPPORTED_TYPES:4
msgid "The ``\"depth\"`` type is an alias for ``\"distance_to_camera\"``."
msgstr ""

#: of
#: omni.isaac.lab.sensors.camera.tiled_camera_cfg.TiledCameraCfg:1:<autosummary>:1
msgid ":py:obj:`OffsetCfg <omni.isaac.lab.sensors.TiledCameraCfg.OffsetCfg>`\\"
Expand Down Expand Up @@ -3017,8 +3024,7 @@ msgstr ""
msgid ":py:obj:`pattern_cfg <omni.isaac.lab.sensors.RayCasterCfg.pattern_cfg>`\\"
msgstr ""

#: ../../docstring of omni.isaac.lab.sensors.RayCasterCameraCfg.pattern_cfg:1
#: omni.isaac.lab.sensors.RayCasterCfg.pattern_cfg:1
#: ../../docstring of omni.isaac.lab.sensors.RayCasterCfg.pattern_cfg:1
#: omni.isaac.lab.sensors.ray_caster.ray_caster_cfg.RayCasterCfg.OffsetCfg:1:<autosummary>:1
msgid "The pattern that defines the local ray starting positions and directions."
msgstr ""
Expand Down Expand Up @@ -3281,6 +3287,20 @@ msgid ""
"<omni.isaac.lab.sensors.RayCasterCameraCfg.data_types>`\\"
msgstr ""

#: of
#: omni.isaac.lab.sensors.ray_caster.ray_caster_camera_cfg.RayCasterCameraCfg.OffsetCfg:1:<autosummary>:1
msgid ""
":py:obj:`pattern_cfg "
"<omni.isaac.lab.sensors.RayCasterCameraCfg.pattern_cfg>`\\"
msgstr ""

#: ../../docstring of omni.isaac.lab.sensors.RayCasterCameraCfg.pattern_cfg:1
#: omni.isaac.lab.sensors.ray_caster.ray_caster_camera_cfg.RayCasterCameraCfg.OffsetCfg:1:<autosummary>:1
msgid ""
"The pattern that defines the local ray starting positions and directions "
"in a pinhole camera pattern."
msgstr ""

#: of omni.isaac.lab.sensors.RayCasterCameraCfg.OffsetCfg.pos:1:<autosummary>:1
msgid ":py:obj:`pos <omni.isaac.lab.sensors.RayCasterCameraCfg.OffsetCfg.pos>`\\"
msgstr ""
Expand Down
Loading

0 comments on commit 56e4520

Please sign in to comment.