Skip to content
This repository was archived by the owner on Sep 12, 2025. It is now read-only.

Commit f845d5e

Browse files
authored
Update README.md (#51)
1 parent d39ea25 commit f845d5e

File tree

5 files changed

+10381
-2
lines changed

5 files changed

+10381
-2
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,20 +94,28 @@ nn-meter --list-predictors
9494

9595
## Predict latency of saved CNN model
9696

97-
After installation, a command named `nn-meter` is enabled. To predict the latency for a CNN model with a predefined predictor in command line, users can run the following commands
97+
After installation, a command named `nn-meter` is enabled. To predict the latency for a CNN model with a predefined predictor in command line, users can run the following commands (sample models can be downloaded [here](./material/testmodels))
9898

9999
```bash
100100
# for Tensorflow (*.pb) file
101101
nn-meter predict --predictor <hardware> [--predictor-version <version>] --tensorflow <pb-file_or_folder>
102+
# Example Usage
103+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.pb
102104

103105
# for ONNX (*.onnx) file
104106
nn-meter predict --predictor <hardware> [--predictor-version <version>] --onnx <onnx-file_or_folder>
107+
#Example Usage
108+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.onnx
105109

106110
# for torch model from torchvision model zoo (str)
107111
nn-meter predict --predictor <hardware> [--predictor-version <version>] --torchvision <model-name> <model-name>...
112+
#Example Usage
113+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --torchvision mobilenet_v2 mobilenet_v2
108114

109115
# for nn-Meter IR (*.json) file
110116
nn-meter predict --predictor <hardware> [--predictor-version <version>] --nn-meter-ir <json-file_or_folder>
117+
#Example Usage
118+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.json
111119
```
112120

113121
`--predictor-version <version>` arguments is optional. When the predictor version is not specified by users, nn-meter will use the latest version of the predictor.

docs/predictor/usage.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,20 +32,28 @@ nn-meter --list-predictors
3232

3333
## Predict latency of saved CNN model
3434

35-
After installation, a command named `nn-meter` is enabled. To predict the latency for a CNN model with a predefined predictor in command line, users can run the following commands
35+
After installation, a command named `nn-meter` is enabled. To predict the latency for a CNN model with a predefined predictor in command line, users can run the following commands (sample models can be downloaded [here](../../material/testmodels))
3636

3737
```bash
3838
# for Tensorflow (*.pb) file
3939
nn-meter predict --predictor <hardware> [--predictor-version <version>] --tensorflow <pb-file_or_folder>
40+
# Example Usage
41+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.pb
4042

4143
# for ONNX (*.onnx) file
4244
nn-meter predict --predictor <hardware> [--predictor-version <version>] --onnx <onnx-file_or_folder>
45+
#Example Usage
46+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.onnx
4347

4448
# for torch model from torchvision model zoo (str)
4549
nn-meter predict --predictor <hardware> [--predictor-version <version>] --torchvision <model-name> <model-name>...
50+
#Example Usage
51+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --torchvision mobilenet_v2 mobilenet_v2
4652

4753
# for nn-Meter IR (*.json) file
4854
nn-meter predict --predictor <hardware> [--predictor-version <version>] --nn-meter-ir <json-file_or_folder>
55+
#Example Usage
56+
nn-meter predict --predictor cortexA76cpu_tflite21 --predictor-version 1.0 --tensorflow mobilenetv3small_0.json
4957
```
5058

5159
`--predictor-version <version>` arguments is optional. When the predictor version is not specified by users, nn-meter will use the latest version of the predictor.

0 commit comments

Comments
 (0)