Skip to main content

A command line tool for parsing and displaying RKNN model information

Project description

RKNN CLI

A command line tool for parsing and displaying RKNN model information with FlatBuffers support.

Features

  • Parse both FlatBuffers binary data and JSON metadata from RKNN files
  • Extract detailed model information including format, compiler, runtime
  • Display input/output tensor information with layout (NCHW) and data type
  • Visualize FlatBuffers graph with Graphviz (SVG output)
  • Python 3.8+ compatible

Installation

From PyPI (Recommended)

pip install rknncli

Development Installation

git clone https://github.com/your-username/rknncli.git
cd rknncli
pip install -e .

Usage

rknncli <path-to-rknn-model>

Example:

rknncli assets/base-encoder.rknn

Graph visualization:

rknncli assets/base-encoder.rknn --draw base-encoder.svg

Note: Graph visualization requires Graphviz installed and dot available in PATH.

Output Format

The tool prints comprehensive model information including FlatBuffers metadata:

Model: rknn model
Target Platform: rk3588
Format: RKNPU v2
Source: ONNX
Compiler: 2.1.0+708089d1(compiler version: 2.1.0)
Runtime: rk3588
Number of graphs: 1

Input information
--------------------------------------------------------------------------------
  ValueInfo "base-mel": type FLOAT32, shape [1, 80, 3000], layout NCHW,

Output information
--------------------------------------------------------------------------------
  ValueInfo "cross_k_0": type FLOAT16, shape [1, 1500, 512], layout NCHW,
  ValueInfo "cross_v_0": type FLOAT16, shape [1, 1500, 512], layout NCHW,

Development

Prerequisites

  • Python 3.8+
  • FlatBuffers compiler (for schema updates)

Setup

# Clone the repository
git clone https://github.com/your-username/rknncli.git
cd rknncli

# Install in development mode
pip install -e .

# Run tests
rknncli assets/base-encoder.rknn

Updating FlatBuffers Schema

If you need to update the RKNN schema:

cd schemas
./generate_schema.sh

Publishing to PyPI

To publish a new version:

# Build the package
python -m build

# Upload to PyPI
./scripts/upload_to_pypi.sh

Changelog

See CHANGELOG.md for version history.

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

rknncli-0.3.0.tar.gz (31.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

rknncli-0.3.0-py3-none-any.whl (23.9 kB view details)

Uploaded Python 3

File details

Details for the file rknncli-0.3.0.tar.gz.

File metadata

  • Download URL: rknncli-0.3.0.tar.gz
  • Upload date:
  • Size: 31.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rknncli-0.3.0.tar.gz
Algorithm Hash digest
SHA256 3fe7bad7dc92f82ab6f47fd4258c3391ad29c4351f65f32383222920f6df57d2
MD5 4ea330428fa8321556f276eb2f5670ba
BLAKE2b-256 0c603f65cf254716d3ee446260219d543c82530708d672252edccbf3cdd9c6f6

See more details on using hashes here.

Provenance

The following attestation bundles were made for rknncli-0.3.0.tar.gz:

Publisher: release.yml on hebangwen/rknncli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file rknncli-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: rknncli-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 23.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for rknncli-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6da314e3e93d4243c35c8a28fc36fac31a52e4d478adafcbd575bf62e030fde1
MD5 b51fa68e535209ea241885c19345d946
BLAKE2b-256 2b328ab0ff38ceea458ab2f59ed862f03641737944195fe75404ebafa422a10b

See more details on using hashes here.

Provenance

The following attestation bundles were made for rknncli-0.3.0-py3-none-any.whl:

Publisher: release.yml on hebangwen/rknncli

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page