consolidate updates to README.md#6739
Merged
Merged
Conversation
Member
|
|
Contributor
There was a problem hiding this comment.
Pull request overview
This PR refreshes and consolidates README.md to present a more modern “getting started” flow for ncnn (PyTorch/ONNX → pnnx → ncnn), and reorganizes the rest of the document into clearer sections for build, conversion, features, examples, and documentation links.
Changes:
- Rewrites the top-level project description (EN + 中文) to reflect broader deployment targets and current tooling (pnnx).
- Adds a new “Quick Start” section with end-to-end snippets (pnnx export + C++/Python inference).
- Replaces/condenses older sections into streamlined “Build”, “Model Conversion”, “Features”, “Project Examples”, and “Documentation And FAQ” tables.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+84
to
+88
| **Or use Python** | ||
|
|
||
| ```python | ||
| import numpy as np | ||
| import ncnn |
| | --- | --- | --- | | ||
| | PyTorch | `pnnx.export(model, "model.pt", (input_tensor,))` or `pnnx model.pt inputshape=[...]` | [pnnx](tools/pnnx), [PyTorch / ONNX guide](https://github.com/Tencent/ncnn/wiki/use-ncnn-with-pytorch-or-onnx) | | ||
| | ONNX | `pnnx model.onnx` | [pnnx](tools/pnnx), [onnx tools](tools/onnx) | | ||
| | ncnn model optimization | `ncnnoptimize model.param model.bin new.param new.bin flag` | [quantization](tools/quantize), [model file spec](https://github.com/Tencent/ncnn/wiki/param-and-model-file-structure) | |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
No description provided.