Skip to content

Commit 32df929

Browse files
committed
update README.md
1 parent 4baa286 commit 32df929

File tree

1 file changed

+37
-21
lines changed

1 file changed

+37
-21
lines changed

README.md

Lines changed: 37 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,46 @@ Star 🌟👆🏻 this repo if it does any helps to you ~ 🙃🤪🍀
2525
</div>
2626

2727

28-
*Lite.AI.ToolKit* 🚀🚀🌟: A lite C++ toolkit of awesome AI models which contains *[70+](https://github.com/DefTruth/lite.ai.toolkit/tree/main/docs/hub/lite.ai.toolkit.hub.onnx.md)* models now. It's a collection of personal interests. Such as YOLOX, YOLOP, YOLOR, YoloV5, YoloV4, DeepLabV3, ArcFace, etc. *Lite.AI.ToolKit* based on *[onnxruntime](https://github.com/microsoft/onnxruntime)* by default. I do have plans to reimplement it with *[ncnn](https://github.com/Tencent/ncnn)* and *[MNN](https://github.com/alibaba/MNN)*, but not coming soon. It includes [object detection](#lite.ai.toolkit-object-detection), [face detection](#lite.ai.toolkit-face-detection), [face alignment](#lite.ai.toolkit-face-alignment), [face recognition](#lite.ai.toolkit-face-recognition), [segmentation](#lite.ai.toolkit-segmentation), [colorization](#lite.ai.toolkit-colorization), [matting](#lite.ai.toolkit-matting), etc. You can use these awesome models simply through *lite::cv::Type::Class* syntax, such as *[lite::cv::detection::YoloV5](#lite.ai.toolkit-object-detection)*.
28+
*Lite.AI.ToolKit* 🚀🚀🌟: A lite C++ toolkit of awesome AI models which contains *[70+](https://github.com/DefTruth/lite.ai.toolkit/tree/main/docs/hub/lite.ai.toolkit.hub.onnx.md)* models now. It's a collection of personal interests. Such as YOLOX, YOLOP, YOLOR, YoloV5, YoloV4, DeepLabV3, ArcFace, etc. *Lite.AI.ToolKit* based on *[onnxruntime](https://github.com/microsoft/onnxruntime)* by default. I do have plans to reimplement it with *[ncnn](https://github.com/Tencent/ncnn)* and *[MNN](https://github.com/alibaba/MNN)*, but not coming soon. The core features of *Lite.AI.ToolKit* are listed as follows.
29+
30+
* Simply and User friendly.
31+
To use Lite.AI.ToolKit, you do not need to have a lot of AI skills, C++ is enough. You can use these awesome models simply through *lite::cv::Type::Class* syntax, see [examples](#lite.ai.toolkit-Examples-for-Lite.AI.ToolKit).
32+
```c++
33+
auto *yolox = new lite::cv::detection::YoloX("yolox_nano.onnx"); // 3.5Mb only !
34+
auto *yolov5 = new lite::cv::detection::YoloV5("yolov5s.onnx"); // for mobile device
35+
```
36+
37+
* Minimum Dependencies & Easy to build.
38+
Currently, Lite.AI.ToolKit only depends on OpencV and ONNXRuntime. 🚀 You can download the latest *ONNXRuntime* official built libs from [v1.8.1](https://github.com/microsoft/onnxruntime/releases), [v1.7.0](https://github.com/microsoft/onnxruntime/releases/tag/v1.7.0). No more attentions needed pay to build it from source. On MacOS, it takes only a few lines of command to build Lite.AI.ToolKit, see [build](#lite.ai.toolkit-Build-Lite.AI.ToolKit).
39+
```shell
40+
git clone --depth=1 https://github.com/DefTruth/lite.ai.toolkit.git # latest
41+
cd lite.ai.toolkit
42+
sh ./build.sh # On MacOS, you can use the built OpenCV and ONNXRuntime libs in this repo.
43+
```
44+
45+
* Cross-platform support.
46+
Lite.AI.ToolKit support MacOS/Linux/Windows and CPU/GPU now. More platforms may be supported in the future ~
47+
48+
49+
* Lots of Algorithm Modules.
50+
Currently, Lite.AI.ToolKit includes 10+ modules for Computer Vision, see [model zoo](#lite.ai.toolkit-Model-Zoo). Such as:
51+
* [image classification](#lite.ai.toolkit-image-classification)
52+
* [object detection](#lite.ai.toolkit-object-detection)
53+
* [face detection](#lite.ai.toolkit-face-detection)
54+
* [face alignment](#lite.ai.toolkit-face-alignment)
55+
* [face recognition](#lite.ai.toolkit-face-recognition)
56+
* [face attributes analysis](#lite.ai.toolkit-face-attributes-analysis)
57+
* [head pose estimation](#lite.ai.toolkit-head-pose-estimation)
58+
* [segmentation](#lite.ai.toolkit-segmentation)
59+
* [colorization](#lite.ai.toolkit-colorization)
60+
* [style transfer](#lite.ai.toolkit-style-transfer)
61+
* [matting](#lite.ai.toolkit-matting)
62+
63+
2964

3065
## Citations.
3166

32-
Cite it as follows if you use *Lite.AI.ToolKit*. Note, More models will continue to be added ~
67+
Cite it as follows if you use *Lite.AI.ToolKit*. Watch 👀👆🏻 this repo, more models will continue to be added ~
3368
```BibTeX
3469
@misc{lite.ai.toolkit2021,
3570
title={lite.ai.toolkit: A lite C++ toolkit of awesome AI models.},
@@ -114,25 +149,6 @@ install `OpenCV` and `onnxruntime` libraries using Homebrew or you can download
114149
brew install onnxruntime
115150
```
116151

117-
<details>
118-
<summary> Expand for More Details of Dependencies.</summary>
119-
120-
### Linux.
121-
* *todo*⚠️
122-
123-
### Windows.
124-
* *todo*⚠️
125-
126-
### Inference Engine Plans:
127-
* *doing*:
128-
❇️ `onnxruntime`
129-
* *todo*:
130-
⚠️ `NCNN`
131-
⚠️ `MNN`
132-
⚠️ `OpenMP`
133-
134-
</details>
135-
136152
---->
137153

138154
## 1. Build Lite.AI.ToolKit

0 commit comments

Comments
 (0)