Readme

README.md

@@ -1,3 +1,73 @@
-# blue-onyx
-Object detection service
 
+<div align="center">
+<img src="assets/blue_onyx.gif" alt="blue_onyx"/>
+</div>
+
+# Object Detection Service
+
+## TL;DR
+
+- Windows only (for now)
+- [ONNX Inference](https://github.com/onnx/onnx)
+- [Direct ML Endpoint](https://github.com/microsoft/DirectML)
+- [RT-DETR-V2 Model](https://github.com/lyuwenyu/RT-DETR/tree/main/rtdetrv2_pytorch)
+- [No Coral support](https://github.com/microsoft/onnxruntime/issues/10248)
+
+## Quick start
+
+- Download release
+- Unzip
+- blue_onyx.exe to run service
+- test_blue_onyx.exe to test service
+- blue_onyx_benchmark.exe for benchmark and model testing
+
+## Tips
+
+Help:
+```bash
+blue_onyx.exe --help
+```
+
+Download more models:
+```bash 
+blue_onyx.exe --download-model-path .
+```
+
+Run service with larger model:
+```bash 
+blue_onyx.exe --model rt-detrv2-x.onnx
+Initializing detector with model: "rt-detrv2-x.onnx"
+```
+
+Benchmark GPU
+```bash
+blue_onyx_benchmark.exe --repeat 100 --save-stats-path .
+Device Name,Version,Type,Platform,EndpointProvider,Images,Total [s],Min [ms],Max [ms],Average [ms],FPS
+Intel(R) Iris(R) Xe Graphics,0.1.0,GPU,Windows,DML,100,14.3,116.8,168.3,143.2,7.0
+```
+
+Benchmark CPU
+```bash
+blue_onyx_benchmark.exe --repeat 100 --save-stats-path . --force-cpu
+Device Name,Version,Type,Platform,EndpointProvider,Images,Total [s],Min [ms],Max [ms],Average [ms],FPS
+12th Gen Intel(R) Core(TM) i7-1265U,0.1.0,CPU,Windows,CPU,100,28.2,239.6,398.2,281.5,3.6
+```
+
+Test Service
+```bash
+blue_onyx.exe
+```
+
+Then run in another terminal do 100 requests with 100 ms interval
+```bash
+test_blue_onyx.exe --number-of-requests 100 --interval 100
+```
+
+Test image and save image with boundary box use --image to specify your own image.
+```bash
+blue_onyx_benchmark.exe --save-image-path .
+```
+
+<div align="center">
+<img src="assets/dog_bike_car_od.jpg" alt="dog_bike_car_od"/>
+</div>

src/bin/blue_onyx_benchmark.rs

@@ -307,7 +307,7 @@ impl InferenceStats {
             .chars()
             .filter(|c| c.is_alphanumeric() || *c == '_')
             .collect();
-        let file_name = format!("blue_onnx_{}_inference_stats.txt", sanitized_device_name);
+        let file_name = format!("blue_onyx_{}_inference_stats.txt", sanitized_device_name);
         let path = path.join(file_name);
         let mut file = std::fs::File::create(path.clone())?;
 

src/bin/test_blue_onyx.rs

@@ -22,10 +22,6 @@ struct Args {
     #[clap(short, long)]
     image: Option<String>,
 
-    /// Save image with boundary bbox
-    #[clap(long)]
-    image_ob: Option<String>,
-
     /// Number of requests to make
     #[clap(short, long, default_value_t = 1)]
     number_of_requests: u32,