Skip to content

Commit

Permalink
Remove RSS documentation from UE4 CARLA (#8418)
Browse files Browse the repository at this point in the history
* removed RSS documentation

* removed RSS example scripts

* added missing append to bboxes tutorial
  • Loading branch information
MattRoweEAIF authored Dec 2, 2024
1 parent baabfae commit 238f84a
Show file tree
Hide file tree
Showing 19 changed files with 1 addition and 3,367 deletions.
5 changes: 0 additions & 5 deletions Docs/3rd_party_integrations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ CARLA has been developed to integrate with several 3rd party applications in ord
- [__Chrono__](tuto_G_chrono.md)
- [__ASAM OpenDRIVE__](adv_opendrive.md)
- [__PTV Vissim__](adv_ptv.md)
- [__RSS__](adv_rss.md)
- [__AWS and RLlib__](tuto_G_rllib_integration.md)

---
Expand Down Expand Up @@ -63,10 +62,6 @@ Learn how to use CARLA alongside CarSIM [here](tuto_G_carsim_integration.md).

[__ASAM OpenDRIVE__](https://www.asam.net/standards/detail/opendrive/) is an open format specification used to describe the logic of a road network intended to standardise the discription of road networks in digital format and allow different applications to exchange data on road networks. Please refer to the full documentation [__here__](adv_opendrive.md)

## RSS - Responsibility Sensitive Safety

CARLA integrates the [C++ Library for Responsibility Sensitive Safety](https://github.com/intel/ad-rss-lib) in the client library. This feature allows users to investigate behaviours of RSS without having to implement anything. CARLA will take care of providing the input, and applying the output to the AD systems on the fly. Refer to the full documentation [__here__](adv_rss.md)

## AWS and RLlib integration

The RLlib integration brings support between the Ray/RLlib library and CARLA, allowing the easy use of the CARLA environment for training and inference purposes. Ray is an open source framework that provides a simple, universal API for building distributed applications. Ray is packaged with RLlib, a scalable reinforcement learning library, and Tune, a scalable hyperparameter tuning library. Read more about operating CARLA on AWS and RLlib [__here__](tuto_G_rllib_integration.md).
Expand Down
130 changes: 0 additions & 130 deletions Docs/adv_rss.md

This file was deleted.

3 changes: 0 additions & 3 deletions Docs/bp_library.md
Original file line number Diff line number Diff line change
Expand Up @@ -255,9 +255,6 @@ Check out the [introduction to blueprints](core_actors.md).
- `role_name` (_String_) <sub>_- Modifiable_</sub>
- `sensor_tick` (_Float_) <sub>_- Modifiable_</sub>
- `vertical_fov` (_Float_) <sub>_- Modifiable_</sub>
- **<font color="#498efc">sensor.other.rss</font>**
- **Attributes:**
- `role_name` (_String_) <sub>_- Modifiable_</sub>

### static
- **<font color="#498efc">static.prop.advertisement</font>**
Expand Down
2 changes: 0 additions & 2 deletions Docs/core_concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,6 @@ A sensor is an actor attached to a parent vehicle. It follows the vehicle around
* Lane invasion detector.
* Obstacle detector.
* Radar.
* RSS.

---
## Advanced steps
Expand All @@ -68,7 +67,6 @@ CARLA offers a wide range of features that go beyond the scope of this introduct
* [__PTV-Vissim co-simulation__](adv_ptv.md). Run a synchronous simulation between CARLA and PTV-Vissim traffic simulator.
* [__Recorder__](adv_recorder.md). Saves snapshots of the simulation state to reenact a simulation with exact precision.
* [__Rendering options__](adv_rendering_options.md). Graphics quality settings, off-screen rendering and a no-rendering mode.
* [__RSS__](adv_rss.md). Integration of the [C++ Library for Responsibility Sensitive Safety](https://github.com/intel/ad-rss-lib) to modify a vehicle's trajectory using safety checks.
* [__Simulation time and synchrony__](adv_synchrony_timestep.md). Everything regarding the simulation time and server-client communication.
* [__SUMO co-simulation__](adv_sumo.md). Run a synchronous simulation between CARLA and SUMO traffic simulator.
* [__Traffic manager__](adv_traffic_manager.md). This module is in charge of every vehicle set to autopilot mode. It simulates traffic in the city for the simulation to look like a real urban environment.
Expand Down
1 change: 0 additions & 1 deletion Docs/core_sensors.md
Original file line number Diff line number Diff line change
Expand Up @@ -152,7 +152,6 @@ Different functionalities such as navigation, measurement of physical properties
| [IMU](ref_sensors.md#imu-sensor) | [carla.IMUMeasurement](<../python_api#carlaimumeasurement>) | Comprises an accelerometer, a gyroscope, and a compass. |
| [LIDAR](ref_sensors.md#lidar-sensor) | [carla.LidarMeasurement](<../python_api#carlalidarmeasurement>) | A rotating LIDAR. Generates a 4D point cloud with coordinates and intensity per point to model the surroundings. |
| [Radar](ref_sensors.md#radar-sensor) | [carla.RadarMeasurement](<../python_api#carlaradarmeasurement>) | 2D point map modelling elements in sight and their movement regarding the sensor. |
| [RSS](ref_sensors.md#rss-sensor) | [carla.RssResponse](<../python_api#carlarssresponse>) | Modifies the controller applied to a vehicle according to safety checks. This sensor works in a different manner than the rest, and there is specific [RSS documentation](<../adv_rss>) for it. |
| [Semantic LIDAR](ref_sensors.md#semantic-lidar-sensor) | [carla.SemanticLidarMeasurement](<../python_api#carlasemanticlidarmeasurement>) | A rotating LIDAR. Generates a 3D point cloud with extra information regarding instance and semantic segmentation. |

<br>
Expand Down
1 change: 0 additions & 1 deletion Docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@ CARLA forum</a>
[__Chrono__](tuto_G_chrono.md) — Details of the Chrono physics simulation integration with CARLA.
[__OpenDrive__](adv_opendrive.md) — Details of the OpenDrive support in CARLA.
[__PTV-Vissim__](adv_ptv.md) — Details of the co-simulation feature with PTV-Vissim.
[__RSS__](adv_rss.md) — Details of the Responsibility Sensitive Safety library integration with CARLA.
[__AWS__](tuto_G_rllib_integration) — Details of using RLlib to run CARLA as a distributed application on Amazon Web Services.
[__ANSYS__](ecosys_ansys.md) — Brief overview of how the Ansys Real Time Radar Model was integrated into CARLA.
[__carlaviz — web visualizer__](plugins_carlaviz.md) — Plugin that listens the simulation and shows the scene and some simulation data in a web browser.
Expand Down
Loading

0 comments on commit 238f84a

Please sign in to comment.