ncnn_mp Modification Roadmap

[Willaaaaaaa]

Project Intro

This project aims to introduce the high-performance ncnn inference framework into the MicroPython ecosystem. Building on the basic functionality already implemented, I plan the following modifications to improve the project's usability, reliability, and practicality.

Key Goals

1. API Design: Implementing an Object-Oriented Interface
2. Improving Usability: Adding Syntax Hints
3. Improving Stability: Testing and Examples
4. Comprehensive Documentation
5. Streamline the Build Process

Checklist

• Encapsulate the current c api's process-oriented functions into Pythonic object-oriented classes and functions.

• Create an ncnn_mp.pyi file to support code completion and syntax hints.

• Based on the new object-oriented interface, write tests to ensure api stability.

• Provide more real-world application examples as a guide.

• Write documents, including api references and contribution guidelines, to help users better use the project.

[Willaaaaaaa]

1. 已有成果

目前我已经初步完成了“为 micropython 平台实现 ncnn c api 的绑定和调用例子”。

1. 实现了 micropython 平台的 ncnn c api 的绑定和调用例子。
2. 完成了在 Unix(Ubuntu) 和 esp32-s3 开发板上的简单测试。
3. 撰写了初步的文档供用户使用。

2. 修改分析

尽管当前的项目已经“可用”，但还远远达不到“好用”、“易用”的程度。为了使这个项目更加完美，我准备进行修改，具体修改内容和原因如下：

1. 由面向过程到面向对象：当前的 micropython 接口是严格按照 c_api.cpp 这个文件进行实现的。但 C 语言是典型的面向过程的语言，而 Python 是面向对象的语言。c api 接口在 micropython 平台上应当是符合 Python 语言习惯的，应该修改使其由面向过程变为面向对象。

2. 完善针对 micropython 接口的测试和示例：由于当前考虑到 c_api.cpp 的文件修改，当前的测试文件是由 AI 初步生成的，仅作为检查的作用。下一步完成接口调整优化后会对测试和示例进行完善。

3. 语法提示：当前使用 micropython 接口写 Python 的时候不会出现语法提示，这是由于 Python lsp 没有关于 ncnn_mp 的语法信息，所以在接口完善后可以写一个 .pyi 文件，以达到易用的效果。

4. 多平台端口支持：（需要帮助）完善其他端口的 micropython 接口的上板子测试等等。

5. 完善文档和构建：包括开发过程、接口使用文档、贡献文档、构建文档，以及构建文件的修改等等。针对于构建，我在考虑直接写成构建脚本，这样可以开箱即用。但又感觉没有太大必要，后续会针对构建复杂度进一步考虑。