Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation: Update screenshots and docs about hybrid app. #116

Merged
merged 1 commit into from
Oct 7, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 31 additions & 4 deletions documentation/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -243,6 +243,32 @@ WARNING: Default profile is used for sign. This signed package is valid for emul
Package File Location: nnstreamer-example/Tizen.web/ImageClassificationOffloading/.buildResult/ImageClassificationOffloading.wgt
```

Tizen supports [hybrid application](https://docs.tizen.org/application/web/#hybrid-application-package), which combines a web application and 1 or more native servics.
We need a hybrid app to get the port value automatically from the offloading service.
gichan-jang marked this conversation as resolved.
Show resolved Hide resolved

```bash
$ cd nnstreamer-example/Tizen.web/ImageClassificationOffloadingService
$ tizen build-native -a arm -c llvm -C Debug -- .
[PLATFORM] Tizen-8.0
...omitted...
Total time: 00:00:00.314

$ tizen package -t tpk -- Debug
Initialize... OK
...omitted...
Package File Location: nnstreamer-example/Tizen.web/ImageClassificationOffloadingService/Debug/EQmf4iSfpX-1.0.0-arm.tpk

$ cd nnstreamer-example/Tizen.web/ImageClassificationOffloading
$ tizen package -t wgt -r ../ImageClassificationOffloadingService/Debug/EQmf4iSfpX-1.0.0-arm.tpk -- .buildResult/ImageClassificationOffloading.wgt
The active profile is used for signing. If you want to sign with other profile, please use '--sign' option.
...omitted...
Package( nnstreamer-example/Tizen.web/ImageClassificationOffloading/.buildResult/ImageClassificationOffloading.wgt ) is created successfully.
```
Tizen Web App build process is done automatically through [github actions](https://github.com/nnstreamer/nnstreamer-example/actions/workflows/tizen-build.yml).
So if you don't need to build it yourself, you can download `tizen_web_ImageClassificationOffloading` created from `main` branch.

![Github action artifacts](img/Github_artifacts.png)

### Running the Tizen Web App on the Tizen Emulator

As mentioned above, the Tizen CLI supports installing and running the Tizen Web App on the Tizen
Expand Down Expand Up @@ -645,13 +671,14 @@ successfully installed and launched on the device.
### Run Tizen-to-Android Offloading

To run Tizen-to-Android Offloading you need to connect both devices to the same Wi-Fi network or
ethernet. Press the start button on the Android device to run the server. Then, the port number the
server is listening will display on the screen like the following screenshot.
ethernet. Press the load models button on the Android device to run the offloading service
based on the conf files. Then, the port number to which the service is listening will display
on the screen like the following screenshot.

![Android Device (Start the server): A-34-arm64](img/A-34-arm64_port.jpg)

Use android's port number in Tizen application and create pipelines by pressing buttons. When the
image classification task runs successfully, the detected label and inference time are displayed on
Tizen devices automatically find offloading services using the model ID. When the image
classification task runs successfully, the detected label and inference time are displayed on
the screen as shown below.

![Tizen Device (Start the client): T-8.0-armv7l](img/T-8.0-armv7l_run.png)
gichan-jang marked this conversation as resolved.
Show resolved Hide resolved
Expand Down
Binary file modified documentation/img/A-34-arm64_port.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/img/A-34-arm64_run.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/img/Github_action_workflow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added documentation/img/Github_artifacts.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified documentation/img/T-8.0-armv7l_run.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.