Skip to content

Commit ca25bb6

Browse files
authored
initial readme (#2)
1 parent e0207f4 commit ca25bb6

File tree

2 files changed

+18
-14
lines changed

2 files changed

+18
-14
lines changed

README.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,18 @@
1-
# Project
1+
# ONNX Runtime Inference Examples
22

3-
> This repo has been populated by an initial template to help get you started. Please
4-
> make sure to update the content to build a great experience for community-building.
3+
<div align="center">
4+
<img src="https://www.onnxruntime.ai/images/ONNX-Runtime-logo.png" /><br /><br />
5+
</div>
56

6-
As the maintainer of this project, please make a few updates:
7+
This repo has examples for using [ONNX Runtime](https://github.com/microsoft/onnxruntime) (ORT) for inference.
78

8-
- Improving this README.MD file to provide a great experience
9-
- Updating SUPPORT.MD with content about this project's support experience
10-
- Understanding the security reporting process in SECURITY.MD
11-
- Remove this section from the README
9+
## Examples
10+
11+
Outline the examples in the repository.
12+
13+
| Example | Description |
14+
|-------------------|--------------------------------------------|
15+
|[Android Image Classifier](mobile/examples/image_classifications/android)| An example application for ONNX Runtime on Android. The example app uses image classification which is able to continuously classify the objects it sees from the device's camera in real-time and displays the most probable inference result on the screen. |
1216

1317
## Contributing
1418

@@ -26,8 +30,8 @@ contact [[email protected]](mailto:[email protected]) with any additio
2630

2731
## Trademarks
2832

29-
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
30-
trademarks or logos is subject to and must follow
33+
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft
34+
trademarks or logos is subject to and must follow
3135
[Microsoft's Trademark & Brand Guidelines](https://www.microsoft.com/en-us/legal/intellectualproperty/trademarks/usage/general).
3236
Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship.
3337
Any use of third-party trademarks or logos are subject to those third-party's policies.

mobile/examples/image_classifications/android/README.md

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# ONNX Runtime Mobile image classification Android sample application
22

33
## Overview
4-
This is an example application for [ONNX Runtime](https://github.com/microsoft/onnxruntime) on Android. The demo app uses image classfication which is able to continuously classify the objects it sees from the device's camera in real-time and displays the most probable inference result on the screen.
4+
This is an example application for [ONNX Runtime](https://github.com/microsoft/onnxruntime) on Android. The demo app uses image classification which is able to continuously classify the objects it sees from the device's camera in real-time and displays the most probable inference result on the screen.
55

66
This example is loosely based on [Google CodeLabs - Getting Started with CameraX](https://codelabs.developers.google.com/codelabs/camerax-getting-started)
77

@@ -22,7 +22,7 @@ We use classic MobileNetV2(float) model and MobileNetV2 (uint8) in this sample a
2222

2323
The above three files are provided and can be downloaded [here](https://1drv.ms/u/s!Auaxv_56eyubgQX-S_kTP0AP66Km?e=e8YMX1).
2424

25-
[Optional] You can also build your own ONNX Runtime arm64 AAR files for Android. (See [build instructions here](https://www.onnxruntime.ai/docs/how-to/build.html#android) and [Build Android Archive(AAR)](https://www.onnxruntime.ai/docs/how-to/build.html#build-android-archive-aar)).
25+
[Optional] You can also build your own ONNX Runtime arm64 AAR files for Android. (See [build instructions here](https://www.onnxruntime.ai/docs/how-to/build.html#android) and [Build Android Archive(AAR)](https://www.onnxruntime.ai/docs/how-to/build.html#build-android-archive-aar)).
2626

2727

2828
### Step 1. Clone the ONNX Runtime Mobile examples source code and download required model files
@@ -54,13 +54,13 @@ Connect your Android Device to the computer and select your device in the top-do
5454

5555
<img width=60% src="images/screenshot_6.png" alt="App Screenshot"/>
5656

57-
Then Select `Run-Run app` and this will prompt the app to be installed on your device.
57+
Then Select `Run-Run app` and this will prompt the app to be installed on your device.
5858

5959
Now you can test and try by opening the app `ort_image_classifier` on your device. The app may request your permission for using the camera.
6060

6161

6262
#
63-
Here's an example screenshot of the app.
63+
Here's an example screenshot of the app.
6464

6565
<img width=20% src="images/screenshot_2.jpg" alt="App Screenshot" />
6666

0 commit comments

Comments
 (0)