Skip to content

Commit bd9a0e3

Browse files
committed
Re-scope the PR to pkg renaming only
1 parent aab4d56 commit bd9a0e3

File tree

12 files changed

+155
-201
lines changed

12 files changed

+155
-201
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ guide and tutorials. 📚
4949
- [x] rai_tts: Text-to-speech models and tools.
5050
- [x] rai_sim: Package for connecting RAI to simulation environments.
5151
- [x] rai_bench: Benchmarking suite for RAI. Test agents, models, tools, simulators, etc.
52-
- [x] rai_openset: Openset detection models and tools.
52+
- [x] rai_perception: Object detection tools based on open-set models and machine learning techniques.
5353
- [x] rai_nomad: Integration with NoMaD for navigation.
5454
- [ ] rai_finetune: Finetune LLMs on your embodied data.
5555

docs/ROS_2/ros_packages.md

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

33
RAI includes multiple configurable ROS 2 packages.
44

5-
| Package | Description | Documentation |
6-
| ------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------ |
7-
| **rai_perception** | Package enabling use of [GroundingDINO](https://github.com/IDEA-Research/GroundingDINO) and [GroundedSAM](https://github.com/IDEA-Research/Grounded-SAM-2) -- an open-set detection model with ROS 2. | [rai_perception](../extensions/openset.md) |
8-
| **rai_nomad** | Package integrating [NoMaD](https://general-navigation-models.github.io/nomad/index.html) -- an exploration model with ROS2. | [rai_nomad](../extensions/nomad.md) |
9-
| **rai_interfaces** | Definition of custom messages and services used in RAI. | |
10-
| **rai_bringup** | Launch files to run RAI. | |
5+
| Package | Description | Documentation |
6+
| ------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------- |
7+
| **rai_perception** | Object detection tools based on open-set models and machine learning techniques. Integrates [GroundingDINO](https://github.com/IDEA-Research/GroundingDINO) and [GroundedSAM](https://github.com/IDEA-Research/Grounded-SAM-2) with ROS 2. | [rai_perception](../extensions/perception.md) |
8+
| **rai_nomad** | Package integrating [NoMaD](https://general-navigation-models.github.io/nomad/index.html) -- an exploration model with ROS2. | [rai_nomad](../extensions/nomad.md) |
9+
| **rai_interfaces** | Definition of custom messages and services used in RAI. | |
10+
| **rai_bringup** | Launch files to run RAI. | |

docs/demos/rosbot_xl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -70,7 +70,7 @@ platform in a nice apartment.
7070
7171
The rosbot demo utilizes several components:
7272
73-
1. Vision processing using Grounded SAM 2 and Grounding DINO for object detection and segmentation. See [RAI perception](../extensions/.md).
73+
1. Vision processing using Grounded SAM 2 and Grounding DINO for object detection and segmentation. See [RAI perception](../extensions/perception.md).
7474
2. RAI agent to process the request and interact with environment via [tool-calling](https://python.langchain.com/docs/concepts/tool_calling/) mechanism.
7575
3. Navigation is enabled via [nav2 toolkit](../API_documentation/langchain_integration/ROS_2_tools.md#nav2), which interacts with [ROS 2 nav2](https://docs.nav2.org/) asynchronously by calling [ros2 actions](https://docs.ros.org/en/jazzy/Tutorials/Beginner-CLI-Tools/Understanding-ROS2-Actions/Understanding-ROS2-Actions.html).
7676
4. Embodiment of the Rosbot is achieved using [RAI Whoami](../tutorials/create_robots_whoami.md) module. This makes RAI agent aware of the hardware platform and its capabilities.
File renamed without changes.

docs/setup/install.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ There are two ways to start using RAI:
4343

4444
!!! important "Package availability"
4545

46-
`rai_openset` and `rai_nomad` are not yet available through pip. If your workflow relies on openset detection or NoMaD integration, please refer to the
46+
`rai_perception` and `rai_nomad` are not yet available through pip. If your workflow relies on openset detection or NoMaD integration, please refer to the
4747
[developer environment instructions](#setting-up-developer-environment) setup.
4848

4949
`rai_interfaces` is available as `apt` package. However, due to package distribution delays, the latest version may not be immediately available. If you encounter missing imports, please build `rai_interfaces` from [source](https://github.com/RobotecAI/rai_interfaces).
@@ -113,14 +113,14 @@ rosdep install --from-paths src --ignore-src -r -y
113113
install additional dependencies:
114114
115115
```bash
116-
poetry install --with openset,nomad,s2s,simbench # or `--all-groups` for full setup
116+
poetry install --with perception,nomad,s2s,simbench # or `--all-groups` for full setup
117117
```
118118
119119
| Group Name | Description | Dependencies |
120120
|------------|-------------|--------------|
121121
| [s2s][s2s] | Speech-to-Speech functionality | rai_asr, rai_tts |
122122
| [simbench][simbench] | Simulation and benchmarking tools | rai_sim, rai_bench |
123-
| [openset][openset] | Open-set detection capabilities | groundingdino, groundedsam |
123+
| [perception][perception] | Open-set detection capabilities | groundingdino, groundedsam |
124124
| [nomad][nomad] | Visual Navigation - NoMaD integration | visualnav_transformer |
125125
| docs | Documentation-related dependencies | mkdocs, mkdocs-material, pymdown-extensions |
126126
@@ -168,5 +168,5 @@ Pick your local solution or service provider and follow one of these guides:
168168
169169
[s2s]: ../tutorials/voice_interface.md
170170
[simbench]: ../simulation_and_benchmarking/overview.md
171-
[openset]: ../extensions/openset.md
171+
[perception]: ../extensions/perception.md
172172
[nomad]: ../extensions/nomad.md

mkdocs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ nav:
128128
- RAI Bench: simulation_and_benchmarking/rai_bench.md
129129
- Simulators: simulation_and_benchmarking/simulators.md
130130
- Extensions:
131-
- OpenSet Vision: extensions/openset.md
131+
- Perception: extensions/perception.md
132132
- NoMaD Visual Navigation: extensions/nomad.md
133133
- FAQ:
134134
- Overview: faq/faq.md

0 commit comments

Comments
 (0)