https://github.com/luoxuhai/react-native-classify-image
🏞 react-native library to classify images using Vision | 对图像进行分类的 react-native 库
https://github.com/luoxuhai/react-native-classify-image
classify-images ios react-native vision
Last synced: 5 months ago
JSON representation
🏞 react-native library to classify images using Vision | 对图像进行分类的 react-native 库
- Host: GitHub
- URL: https://github.com/luoxuhai/react-native-classify-image
- Owner: luoxuhai
- License: mit
- Created: 2022-01-14T00:31:11.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-10-21T00:49:08.000Z (over 2 years ago)
- Last Synced: 2025-12-25T16:26:15.073Z (6 months ago)
- Topics: classify-images, ios, react-native, vision
- Language: Swift
- Homepage: https://www.npmjs.com/package/react-native-classify-image
- Size: 1.65 MB
- Stars: 29
- Watchers: 1
- Forks: 3
- Open Issues: 3
-
Metadata Files:
- Readme: README-zh_CN.md
- License: LICENSE
Awesome Lists containing this project
README
🏞 React Native Classify Image
使用 Vision 对图像进行分类的 react-native 库
[English](./README.md) | 简体中文
识别结果，`confidence`（置信度，[0 - 1]区间内的小数）的值越大可信度越高。
```js
[
{
identifier: {
en: "animal",
zh_cn: "动物"
},
confidence: 0.848;
},
{
identifier: {
en: "cat",
zh_cn: "猫"
},
confidence: 0.848;
},
{
identifier: {
en: "clothing",
zh_cn: "衣服"
},
confidence: 0.676;
},
{
identifier: {
en: "hat",
zh_cn: "帽子"
},
confidence: 0.631;
},
...
]
```
## ❗️ :warning:
目前仅支持 iOS 13.0+
## Installation
`$ npm install react-native-classify-image --save`
or
`$ yarn add react-native-classify-image`
### React Native
```sh
# RN >= 0.60
cd ios && pod install
# RN < 0.60
react-native link react-native-classify-image
```
### Expo
```sh
expo prebuild
```
## Usage
### 简单使用
```js
import * as ClassifyImage from 'react-native-classify-image';
// 本地路径
const path =
'/var/mobile/Containers/Data/Library/Caches/E5FA7C16-9E74-4C38-A7BA-FC2180D20DE9.jpg';
ClassifyImage.request(path)
.then((result) => {
// success
})
.catch((error) => {
// error
});
```
### 高级使用
```js
import * as ClassifyImage from 'react-native-classify-image';
import RNFS from 'react-native-fs';
const path = `${RNFS.TemporaryDirectoryPath}/IMG_1234.jpg`;
// https://github.com/itinance/react-native-fs
RNFS.downloadFile({
fromUrl: 'https://s4.ax1x.com/2022/01/15/7JJaDI.png',
toFile: path,
}).promise.then((res) => {
ClassifyImage.request(path, {
minConfidence: 0.6,
orientation: ClassifyImage.Orientation.Up,
})
.then((result) => {
// success
})
.catch((error) => {
// error
});
});
```
## API
### `request(path: string, options?: Object): Promise`
| 参数 | 类型 | 描述 |
| ------------------ | ------ | ---------------------------------------------------------------------------------------------------------------------- |
| **path** | string | 图像文件的本地绝对路径. 可使用 [react-native-fs constants](https://github.com/itinance/react-native-fs#constants) 获取 |
| **options** (可选) | object | 可选项，见下 `Options` |
### `supportedIdentifiers(): Promise`
### Options
| 参数 | 类型 | 描述 | 默认值 |
| ------------------------------------- | ------- | ------------------------------------------------------------------------------------------------------ | ---------------- |
| **minConfidence** (可选) | string | 最小置信度，仅返回大于等于该值的数据。取值范围:[0-1] | 0.1 |
| **preferBackgroundProcessing** (可选) | boolean | 如果设置为 `true`，则此属性会减少请求的内存占用、处理占用和 CPU/GPU 争用，但可能会花费更长的执行时间。 | false |
| **usesCPUOnly** (可选) | boolean | 仅在 CPU 上执行。设置 `false` 表示可以自由地利用 GPU 来加速其处理。 | false |
| **orientation** (可选) | number | 图像的方向 | `Orientation.Up` |
### Result - 识别结果
| 名称 | 类型 | 描述 |
| -------------- | ------ | --------------- |
| **identifier** | object | 分类标签名 |
| **confidence** | number | 置信度，[0 - 1] |
### Orientation
- `Orientation.Up`: `1` - 默认方向
- `Orientation.UpMirrored`: `2` - 水平翻转
- `Orientation.Down`: `3` - 旋转 180°
- `Orientation.DownMirrored`: `4` - 垂直翻转
- `Orientation.Left`: `5` - 水平翻转并逆时针旋转 90°
- `Orientation.LeftMirrored`: `6` - 顺时针旋转 90°
- `Orientation.Right`: `7` - 水平翻转并顺时针旋转 90°
- `Orientation.RightMirrored`: `8` - 顺时针旋转 90°
## Troubleshooting
1. 检查您的最低 iOS 版本。react-native-classify-image 要求最低 iOS 版本为 11.0（目前仅支持 iOS 13.0+ 使用）。
- 打开你的 Podfile
- 确保 `platform :ios` 设置为 11.0 或更高
- 确保 `iOS Deployment Target` 设置为 11.0 或更高
2. 确保您在项目中创建了 Swift 桥接头。
- 使用 Xcode 打开你的项目（**xxx.xcworkspace**）
- 按照以下步骤创建 Swift 文件 **File > New > File (⌘+N)**
- 选择 **Swift File** 并点击 **Next**
- 输入文件名 **BridgingFile.swift**，然后点击创建，提示时点击 **Create Bridging Header**
## TODO
- [ ] 支持 Android
- [ ] 支持识别指定区域
- [ ] 支持网络图像
## License
MIT