Skip to content

Commit

Permalink
update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Sg4Dylan committed Apr 1, 2020
1 parent 3c69c2f commit 50fc9ab
Showing 1 changed file with 29 additions and 2 deletions.
31 changes: 29 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,10 @@

使用到的主要工具是 EfficientNet 和 Hnswlib,使用前者在 ImageNet 上的预训练模型进行特征抽取,使用后者进行特征索引及检索。因 EfficientNet 的 PyTorch 实现尚未提供 Python 3.7 及后续版本的支持,使用 ONNX 进行推理可方便安装使用,降低依赖门槛同时方便进一步移植开发 ~~(虽然大概率咕了)~~

使用前请注意,如果有任何使用上的问题请尽量自行解决(特别是 GUI 版本)。
比起花费时间维护,咱更希望像 Eagle 这样的专业图像管理软件加入特性持续维护。
如果您有任何新点子,欢迎 fork 实现后 pull request。

### 依赖
- Python 3.6+
- numpy
Expand All @@ -15,6 +19,26 @@

### 使用

#### GUI 使用

> 当前 GUI 版本打包仅支持 Windows x86_64 环境使用
初次使用需要建立索引:
1. 双击 `start.bat` 打开
2. 单击 `设置` - `添加索引目录` 添加需要索引的图库目录
3. 单击 `更新索引目录` 建立索引

搜索图片:
1. 单击 `...` 选择图片
2. 设置返回结果数量
3. 单击 `开始搜索`
4. 双击返回结果的文件路径打开图片

后续索引更新:
1. 单击 `设置` - `更新索引目录` 更新索引

#### 编程使用

1. 第一次使用时对图片仓库文件夹建立索引
```python
from utils import *
Expand Down Expand Up @@ -71,10 +95,13 @@ print(f'Input: {input_path} Result: {",".join(results)}')
> Q:更换更大规模的模型?
> A:首先转换 EfficientNet 模型到 ONNX 格式并使用 `opti.py` 优化,接着修改 `efficient_ir.py` 中的 `img_size``model_path`,最后重新索引即可。
> Q:检索效果不佳怎么解决?
> A:当前代码中使用 b2 级别模型是权衡之后决定的,若追求更佳检索效果请自行更换更大规模的模型。
### TODO

- [ ] 实现 Cli 工具
- [ ] 实现 GUI 工具
- [ ] ~~实现 Cli 工具~~
- [x] 实现 GUI 工具
- [ ] 移植到 C++ 使用 [ncnn](https://github.com/Tencent/ncnn) 推理

### References
Expand Down

0 comments on commit 50fc9ab

Please sign in to comment.