Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/KoheiKanagu/ncnn_yolox_flutter
This is a plugin to run YOLOX on ncnn.
https://github.com/KoheiKanagu/ncnn_yolox_flutter
Last synced: 3 months ago
JSON representation
This is a plugin to run YOLOX on ncnn.
- Host: GitHub
- URL: https://github.com/KoheiKanagu/ncnn_yolox_flutter
- Owner: KoheiKanagu
- License: bsd-3-clause
- Archived: true
- Created: 2022-02-22T05:09:31.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2023-08-17T05:00:02.000Z (over 1 year ago)
- Last Synced: 2024-10-31T08:39:33.269Z (4 months ago)
- Language: Dart
- Homepage:
- Size: 19.9 MB
- Stars: 51
- Watchers: 4
- Forks: 10
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
- awesome-yolo-object-detection - KoheiKanagu/ncnn_yolox_flutter
- awesome-yolo-object-detection - KoheiKanagu/ncnn_yolox_flutter
README
# ncnn_yolox_flutter
This is a plugin to run YOLOX on ncnn.
## Demo
### on Android
### on iOS
## How to use
### 1. Add the YOLOX model to assets
For example, you can use [yolox_onnx_to_ncnn.ipynb](notebooks/yolox_onnx_to_ncnn.ipynb)
**Note that you will need to manually modify the model.**
---
If you want to use yolox_tiny, you can find it in [example/assets/yolox](example/assets/yolox).
---
Don't forget to add the model of assets to your `pubspec.yaml`.
```pubspec.yaml
flutter:
assets:
- assets/yolox/
```
### 2. Load the model
```dart
final ncnn = NcnnYolox();
ncnn.initYolox(
modelPath: 'assets/yolox/yolox.bin',
paramPath: 'assets/yolox/yolox.param',
);
```
### 3. Get the result
```dart
/// When using image file
/// **Exif Orientation is ignored**
_results = ncnn.detect(
imagePath: "path",
);
/// When using image pixels
_results = ncnn.detect(
pixels: image.pixels,
pixelFormat: PixelFormat.bgra,
width: image.width,
height: image.height,
);
```
Please check [example/lib/providers/ncnn_yolox_controller.dart](example/lib/providers/ncnn_yolox_controller.dart) for specific usage.
## How to set up for using custom ncnn and custom YOLOX model
### 1. Build ncnn
See [build_ncnn.yaml](.github/workflows/build_ncnn.yaml) for details.
If you want pre-built ncnn, look at the URL of the Releases referenced in these files.
Such as this `https://github.com/KoheiKanagu/ncnn_yolox_flutter/releases/download/x.y.z/ncnn-android.zip`
- [android/CMakeLists.txt](https://github.com/KoheiKanagu/ncnn_yolox_flutter/blob/main/android/CMakeLists.txt)
- [ios/ncnn_yolox_flutter.podspec](https://github.com/KoheiKanagu/ncnn_yolox_flutter/blob/main/ios/ncnn_yolox_flutter.podspec)
### 2. Download ncnn
The library is a binary file, so it is not packaged in the repository.
The ncnn libraries for iOS and Android are CMake and Cocoapods, downloaded from Github Releases.
- [android/CMakeLists.txt](android/CMakeLists.txt)
- [ios/ncnn_yolox_flutter.podspec](ios/ncnn_yolox_flutter.podspec)
The ncnn library zip you are downloading is the artifact of [build_ncnn.yaml](.github/workflows/build_ncnn.yaml). Change the URL if you want.
---
If you do not want to download the ncnn library, remove the process of downloading the zip.
Then install the ncnn library manually.
Please refer to the comments in these files.
- [android/CMakeLists.txt](android/CMakeLists.txt)
- [ios/ncnn_yolox_flutter.podspec](ios/ncnn_yolox_flutter.podspec)
### 3. Change the parameters of YOLOX
Change [ios/Classes/yolox.cpp](ios/Classes/yolox.cpp) if you want.
For example, if you want to change the size of the input image, change `YOLOX_TARGET_SIZE`.
Alternatively, you can change the `ncnn::Net yolox;` in the `void initYolox(char *modelPath, char *paramPath)` method.
---
The original `yolox.cpp` is [ncnn/yolox\.cpp at 20220216 · Tencent/ncnn](https://github.com/Tencent/ncnn/blob/20220216/examples/yolox.cpp).