Merge pull request #95 from Satgoy152:adding-doc

Improved help messages for demo programs (#95)
- Added Demo Documentation
- Updated help messages
- Changed exception link

README.md

@@ -6,18 +6,22 @@ This model is ported from [PaddleHub](https://github.com/PaddlePaddle/PaddleHub)
 
 Results of accuracy evaluation with [tools/eval](../../tools/eval).
 
-| Models | Top-1 Accuracy | Top-5 Accuracy |
-| ------ | -------------- | -------------- |
-| PP-ResNet | 82.28 | 96.15 |
-| PP-ResNet quant | 0.22 | 0.96 |
+| Models          | Top-1 Accuracy | Top-5 Accuracy |
+| --------------- | -------------- | -------------- |
+| PP-ResNet       | 82.28          | 96.15          |
+| PP-ResNet quant | 0.22           | 0.96           |
 
 \*: 'quant' stands for 'quantized'.
 
 ## Demo
 
 Run the following command to try the demo:
+
 ```shell
 python demo.py --input /path/to/image
+
+# get help regarding various parameters
+python demo.py --help
 ```
 
 ## License
@@ -29,4 +33,3 @@ All files in this directory are licensed under [Apache 2.0 License](./LICENSE).
 - https://arxiv.org/abs/1512.03385
 - https://github.com/opencv/opencv/tree/master/samples/dnn/dnn_model_runner/dnn_conversion/paddlepaddle
 - https://github.com/PaddlePaddle/PaddleHub
-

demo.py

@@ -29,14 +29,14 @@ try:
     help_msg_backends += "; {:d}: TIMVX"
     help_msg_targets += "; {:d}: NPU"
 except:
-    print('This version of OpenCV does not support TIM-VX and NPU. Visit https://gist.github.com/fengyuentau/5a7a5ba36328f2b763aea026c43fa45f for more information.')
+    print('This version of OpenCV does not support TIM-VX and NPU. Visit https://github.com/opencv/opencv/wiki/TIM-VX-Backend-For-Running-OpenCV-On-NPU for more information.')
 
 parser = argparse.ArgumentParser(description='Deep Residual Learning for Image Recognition (https://arxiv.org/abs/1512.03385, https://github.com/PaddlePaddle/PaddleHub)')
-parser.add_argument('--input', '-i', type=str, help='Path to the input image.')
-parser.add_argument('--model', '-m', type=str, default='image_classification_ppresnet50_2022jan.onnx', help='Path to the model.')
+parser.add_argument('--input', '-i', type=str, help='Usage: Set input path to a certain image, omit if using camera.')
+parser.add_argument('--model', '-m', type=str, default='image_classification_ppresnet50_2022jan.onnx', help='Usage: Set model path, defaults to image_classification_ppresnet50_2022jan.onnx.')
 parser.add_argument('--backend', '-b', type=int, default=backends[0], help=help_msg_backends.format(*backends))
 parser.add_argument('--target', '-t', type=int, default=targets[0], help=help_msg_targets.format(*targets))
-parser.add_argument('--label', '-l', type=str, default='./imagenet_labels.txt', help='Path to the dataset labels.')
+parser.add_argument('--label', '-l', type=str, default='./imagenet_labels.txt', help='Usage: Set path to the different labels that will be used during the detection. Default list found in imagenet_labels.txt')
 args = parser.parse_args()
 
 if __name__ == '__main__':