Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing Python API documentation #5408

Open
jakubdolejs opened this issue Apr 4, 2024 · 0 comments
Open

Missing Python API documentation #5408

jakubdolejs opened this issue Apr 4, 2024 · 0 comments

Comments

@jakubdolejs
Copy link

I'd expect a library as widely used as NCNN to have full documentation of its API. The documentation links I found are scattered over various websites and they all contain tips on how to use a subset of features. It's frustrating to have to guess the return types and arguments of functions, or indeed the function names, especially when using languages like Python where type hinting is optional.

Also, it's impossible to tell whether the API changed from release to release. Is there a reason why releases aren't semantically versioned?

Is there a plan to document the NCNN Python API? Or is it already documented and I'm missing a link?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant