Skip to content

Commit 09e6cbb

Browse files
committed
update README.md
1 parent 6b369cf commit 09e6cbb

File tree

9 files changed

+40
-36
lines changed

9 files changed

+40
-36
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,9 +37,9 @@ Check [this URL](./yolox_ros_cpp/README.md).
3737

3838
<!-- - yolox/image_raw : Resized image (`sensor_msgs/Image`) -->
3939

40-
- bounding_boxes: Output BoundingBoxes like darknet_ros_msgs (`bboxes_ex_msgs/BoundingBoxes`)
41-
42-
※ If you want to use `darknet_ros_msgs` , replace `bboxes_ex_msgs` with `darknet_ros_msgs`.
40+
- bounding_boxes (`bboxes_ex_msgs/BoundingBoxes` or `vision_msgs/Detection2DArray`)
41+
- `bboxes_ex_msgs/BoundingBoxes`: Output BoundingBoxes like darknet_ros_msgs
42+
- ※ If you want to use `darknet_ros_msgs` , replace `bboxes_ex_msgs` with `darknet_ros_msgs`.
4343

4444
<!-- ![yolox_topic](images_for_readme/yolox_topic.png) -->
4545

yolox_ros_cpp/README.md

Lines changed: 31 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
## Requirements
44
- ROS2 Iron
55
- ros-iron-generate-parameter-library
6+
- ros-iron-vision-msgs
7+
- ros-iron-usb-cam
68
- OpenCV 4.x
79
- OpenVINO 2024.*
810
- TensorRT 10.x *
@@ -30,28 +32,26 @@ git clone --recursive https://github.com/Ar-Ray-code/YOLOX-ROS -b iron
3032
cd ~/ros2_ws
3133

3234
./src/YOLOX-ROS/weights/onnx/download.bash yolox_tiny
33-
# Download onnx file and convert to IR format.
34-
# ./src/YOLOX-ROS/weights/openvino/download.bash yolox_tiny
3535
```
3636

3737
### TensorRT
3838
```bash
3939
cd ~/ros2_ws
4040

4141
# Download onnx model and convert to TensorRT engine.
42-
# 1st arg is model name. 2nd is workspace size.
42+
# argument is model name. set yolox_tiny, yolox_nano, yolox_s, yolox_m or yolox_l.
4343
./src/YOLOX-ROS/weights/tensorrt/convert.bash yolox_tiny
4444
```
4545

46-
#### Tensorflow Lite
46+
### Tensorflow Lite
4747
```bash
4848
cd ~/ros2_ws
4949

5050
# Download tflite Person Detection model: https://github.com/Kazuhito00/Person-Detection-using-RaspberryPi-CPU/
5151
./src/YOLOX-ROS/weights/tflite/download_model.bash
5252
```
5353

54-
#### PINTO_model_zoo
54+
### PINTO_model_zoo
5555
- Support PINTO_model_zoo model
5656
- Download model using the following script.
5757
- https://github.com/PINTO0309/PINTO_model_zoo/blob/main/132_YOLOX/download_nano.sh
@@ -77,15 +77,15 @@ cd ~/ros2_ws
7777
# build with openvino
7878
source /opt/ros/humble/setup.bash
7979
source /opt/intel/openvino_2021/bin/setupvars.sh
80-
colcon build --cmake-args -DYOLOX_USE_OPENVINO=ON
80+
colcon build --symlink-install --cmake-args -DYOLOX_USE_OPENVINO=ON
8181
```
8282

8383
### TensorRT
8484

8585
```bash
8686
# build with tensorrt
87-
source /opt/ros/humble/setup.bash
88-
colcon build --cmake-args -DYOLOX_USE_TENSORRT=ON
87+
source /opt/ros/iron/setup.bash
88+
colcon build --symlink-install --cmake-args -DYOLOX_USE_TENSORRT=ON
8989
```
9090

9191
### TFLite
@@ -115,12 +115,13 @@ make -j"$(nproc)"
115115
```
116116

117117
```bash
118-
colcon build --cmake-args \
119-
-DYOLOX_USE_TFLITE=ON \
120-
-DTFLITE_LIB_PATH=${WORKSPACE}/tflite_build \
121-
-DTFLITE_INCLUDE_DIR=${WORKSPACE}/tensorflow_src/ \
122-
-DABSEIL_CPP_ICLUDE_DIR=${WORKSPACE}/tflite_build/abseil-cpp \
123-
-DFLATBUFFERS_INCLUDE_DIR=${WORKSPACE}/tflite_build/flatbuffers/include
118+
colcon build --symlink-install \
119+
--cmake-args \
120+
-DYOLOX_USE_TFLITE=ON \
121+
-DTFLITE_LIB_PATH=${WORKSPACE}/tflite_build \
122+
-DTFLITE_INCLUDE_DIR=${WORKSPACE}/tensorflow_src/ \
123+
-DABSEIL_CPP_ICLUDE_DIR=${WORKSPACE}/tflite_build/abseil-cpp \
124+
-DFLATBUFFERS_INCLUDE_DIR=${WORKSPACE}/tflite_build/flatbuffers/include
124125
```
125126

126127
<br>
@@ -139,10 +140,6 @@ ros2 launch yolox_ros_cpp yolox_openvino.launch.py
139140
# ros2 launch yolox_ros_cpp yolox_openvino.launch.py \
140141
# model_path:=install/yolox_ros_cpp/share/yolox_ros_cpp/weights/onnx/yolox_tiny_480x640.onnx \
141142
# model_version:="0.1.0"
142-
143-
## run YOLOX-tiny with NCS2
144-
# ros2 launch yolox_ros_cpp yolox_openvino_ncs2.launch.py
145-
146143
```
147144

148145
### TensorRT
@@ -156,20 +153,20 @@ ros2 launch yolox_ros_cpp yolox_tensorrt.launch.py
156153

157154
```
158155

159-
### Jetson + TensorRT
156+
<!-- ### Jetson + TensorRT
160157
Jetson docker container cannot display GUI.
161158
If you want to show image with bounding box drawn, subscribe from host jetson or other PC.
162159
163160
```bash
164161
# run yolox_tiny
165162
ros2 launch yolox_ros_cpp yolox_tensorrt_jetson.launch.py
166-
```
163+
``` -->
167164

168-
<!-- ### ONNXRuntime
165+
### ONNXRuntime
169166
```bash
170167
# run yolox_tiny
171168
ros2 launch yolox_ros_cpp yolox_onnxruntime.launch.py
172-
``` -->
169+
```
173170

174171
### Tensorflow Lite
175172
```bash
@@ -188,7 +185,7 @@ ros2 launch yolox_ros_cpp yolox_tflite.launch.py
188185
<details>
189186
<summary>OpenVINO example</summary>
190187

191-
- `model_path`: ./install/yolox_ros_cpp/share/yolox_ros_cpp/weights/openvino/yolox_tiny.xml
188+
- `model_path`: ./src/YOLOX-ROS/weights/onnx/yolox_tiny.onnx
192189
- `p6`: false
193190
- `class_labels_path`: ""
194191
- if not set, use coco_names.
@@ -201,14 +198,16 @@ ros2 launch yolox_ros_cpp yolox_tflite.launch.py
201198
- `src_image_topic_name`: /image_raw
202199
- `publish_image_topic_name`: /yolox/image_raw
203200
- `publish_boundingbox_topic_name`: /yolox/bounding_boxes
201+
- `use_bbox_ex_msgs`: false
202+
- `publish_resized_image`: false
204203

205204
</details>
206205

207206

208207
<details>
209208
<summary>TensorRT example</summary>
210209

211-
- `model_path`: ./install/yolox_ros_cpp/share/yolox_ros_cpp/weights/tensorrt/yolox_tiny.trt
210+
- `model_path`: ../src/YOLOX-ROS/weights/tensorrt/yolox_tiny.trt
212211
- `p6`: false
213212
- `class_labels_path`: ""
214213
- `num_classes`: 80
@@ -220,14 +219,16 @@ ros2 launch yolox_ros_cpp yolox_tflite.launch.py
220219
- `src_image_topic_name`: /image_raw
221220
- `publish_image_topic_name`: /yolox/image_raw
222221
- `publish_boundingbox_topic_name`: /yolox/bounding_boxes
222+
- `use_bbox_ex_msgs`: false
223+
- `publish_resized_image`: false
223224

224225
</details>
225226

226227
<details>
227228
<summary>ONNXRuntime example</summary>
228229

229230

230-
- `model_path`: ./install/yolox_ros_cpp/share/yolox_ros_cpp/weights/onnx/yolox_tiny.onnx
231+
- `model_path`: ./src/YOLOX-ROS/weights/onnx/yolox_tiny.onnx
231232
- `p6`: false
232233
- `class_labels_path`: ""
233234
- `num_classes`: 80
@@ -245,13 +246,15 @@ ros2 launch yolox_ros_cpp yolox_tflite.launch.py
245246
- `src_image_topic_name`: /image_raw
246247
- `publish_image_topic_name`: /yolox/image_raw
247248
- `publish_boundingbox_topic_name`: /yolox/bounding_boxes
249+
- `use_bbox_ex_msgs`: false
250+
- `publish_resized_image`: false
248251

249252
</details>
250253

251254
<details>
252255
<summary>Tensorflow Lite example</summary>
253256

254-
- `model_path`: ./install/yolox_ros_cpp/share/yolox_ros_cpp/weights/tflite/model.tflite
257+
- `model_path`: ./src/YOLOX-ROS/weights/tflite/model.tflite
255258
- `p6`: false
256259
- `is_nchw`: true
257260
- `class_labels_path`: ""
@@ -264,6 +267,8 @@ ros2 launch yolox_ros_cpp yolox_tflite.launch.py
264267
- `src_image_topic_name`: /image_raw
265268
- `publish_image_topic_name`: /yolox/image_raw
266269
- `publish_boundingbox_topic_name`: /yolox/bounding_boxes
270+
- `use_bbox_ex_msgs`: false
271+
- `publish_resized_image`: false
267272

268273
</details>
269274

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
config.h
1+
config.h

yolox_ros_cpp/yolox_cpp/include/yolox_cpp/coco_names.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,4 +96,4 @@ namespace yolox_cpp{
9696
{0.500, 0.500, 0.000}
9797
};
9898
}
99-
#endif
99+
#endif

yolox_ros_cpp/yolox_cpp/include/yolox_cpp/yolox.hpp

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,4 @@
1919
#include "yolox_tflite.hpp"
2020
#endif
2121

22-
2322
#endif

yolox_ros_cpp/yolox_cpp/include/yolox_cpp/yolox_tflite.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,4 +50,4 @@ namespace yolox_cpp{
5050
};
5151
} // namespace yolox_cpp
5252

53-
#endif
53+
#endif

yolox_ros_cpp/yolox_cpp/src/yolox_onnxruntime.cpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -137,7 +137,7 @@ namespace yolox_cpp{
137137

138138
float* net_pred = (float *)this->output_buffer_[0].get();
139139

140-
// post process
140+
// postprocess
141141
const float scale = std::min(
142142
static_cast<float>(this->input_w_) / static_cast<float>(frame.cols),
143143
static_cast<float>(this->input_h_) / static_cast<float>(frame.rows)

yolox_ros_cpp/yolox_param/package.xml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,4 +19,4 @@
1919
<export>
2020
<build_type>ament_cmake</build_type>
2121
</export>
22-
</package>
22+
</package>

yolox_ros_cpp/yolox_param/src/yolox_parameters.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,4 @@ yolox_parameters:
9393
publish_resized_image:
9494
type: bool
9595
description: "Enable or disable resized image."
96-
default_value: false
96+
default_value: false

0 commit comments

Comments
 (0)