Skip to content

Commit

Permalink
fix broken links (#570)
Browse files Browse the repository at this point in the history
  • Loading branch information
QuanyiLi committed Dec 2, 2023
1 parent f9f1a79 commit e001457
Show file tree
Hide file tree
Showing 3 changed files with 4 additions and 4 deletions.
2 changes: 1 addition & 1 deletion documentation/source/action.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
"$u_b = -B_{max} \\min(0, a_2)$ \n",
"\n",
"wherein $S_{max}$ (degree) is the maximal steering angle, $F_{max}$ (hp) is the maximal engine force, and $B_{max}$ (hp) is the maximal brake force. \n",
"To increase diversity, the accurate values of these parameters vary across different vehicles but are limited to certain ranges defined by [VehicleParameterSpace](https://github.com/metadriverse/metadrive/blob/main/metadrive/utils/space.py).\n",
"To increase diversity, the accurate values of these parameters vary across different vehicles but are limited to certain ranges defined by [VehicleParameterSpace](https://github.com/metadriverse/metadrive/blob/main/metadrive/component/pg_space.py).\n",
"\n",
"The steering $u_s$ is applied to two front wheels. In addition, the engine force $u_a$ and the brake force $u_b$ are applied to four wheels, as the car in MetaDrive is four-wheel drive (4WD). The concrete implementation is as follows:"
]
Expand Down
4 changes: 2 additions & 2 deletions documentation/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ To check whether MetaDrive is successfully installed, please run the following c
python -m metadrive.examples.profile_metadrive

This script can also verify the efficiency of MetaDrive through the printed messages.
The default observation contains information on ego vehicle's states, Lidar-like cloud points showing neighboring vehicles, and information about navigation and tasks. Besides, you can also try the Pygame-based Top-down rendering (See `TopDownObservation <obs_action.html#topdownobservation>`_), which is also runnable in most headless machine without any special treatment.
The default observation contains information on ego vehicle's states, Lidar-like cloud points showing neighboring vehicles, and information about navigation and tasks. Besides, you can also try the Pygame-based Top-down rendering (See `TopDownObservation <obs.html#topdownobservation>`_), which is also runnable in most headless machine without any special treatment.
If the above observation is not enough for your RL algorithms and you wish to use the Panda3D camera to provide realistic RGB images as the observation, please continue reading this section.


Expand All @@ -64,7 +64,7 @@ The script will generate two **same** images to `/path/to/metadrive repo/metadri
Please fetch and check those images from cluster to ensure MetaDrive can draw the scene and capture images correctly.
By default, it only generates images from the main camera. Set ```--camera [rgb/depth]``` to check other cameras.
Also, ```--cuda``` flag can be added to test image_on_cuda pipeline for your headless machine.
If the captured main camera images are completed as following, then the installation on headless machine is successful and please move on to `ImageStateObservation <obs_action.html#imagestateobservation>`_.
If the captured main camera images are completed as following, then the installation on headless machine is successful and please move on to `ImageStateObservation <obs.html#imagestateobservation>`_.

.. image:: figs/main_camera_from_observation.png
:width: 400
Expand Down
2 changes: 1 addition & 1 deletion documentation/source/rl_environments.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -985,7 +985,7 @@
"id": "2497bb10",
"metadata": {},
"source": [
"This is the done function of `MetaDriveEnv`. There are several config can turn off/turn on specific done conditions like `crash_vehicle_done` and `crash_object_done`. When they are set to `False`, the crash won't throw a termination signal out. More termination config is available at <a href=\"reward_cost_done.html#termination-function\">Reward, Cost and Termination</a>."
"This is the done function of `MetaDriveEnv`. There are several config can turn off/turn on specific done conditions like `crash_vehicle_done` and `crash_object_done`. When they are set to `False`, the crash won't throw a termination signal out. More termination config is available at <a href=\"reward_cost_done.html#termination-and-truncation\">Reward, Cost and Termination</a>."
]
},
{
Expand Down

0 comments on commit e001457

Please sign in to comment.