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/hebangwen/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.1.tar.gz (31.8 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.1-py3-none-any.whl (25.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: rknncli-0.3.1.tar.gz
  • Upload date:
  • Size: 31.8 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.1.tar.gz
Algorithm Hash digest
SHA256 ef7b1768d9a6e982c863f0c7fa5e7a2675d5e05d9368f74dbf9b09ebbb677dcc
MD5 0be72fe2b4d1243b2ef2224fcee9fcbb
BLAKE2b-256 9764c72b501404d0ec0415f2bdf713ef68a8fef555be4d0c45976268631995b3

See more details on using hashes here.

Provenance

The following attestation bundles were made for rknncli-0.3.1.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.1-py3-none-any.whl.

File metadata

  • Download URL: rknncli-0.3.1-py3-none-any.whl
  • Upload date:
  • Size: 25.2 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 cf9152278039deb5150577e6286973886cecc8b74eb240123f50af1439cef71c
MD5 48815669713cbc65c533d5172e46958e
BLAKE2b-256 56441098efcd5f9449febc4b57f14793553390ea1ad2d77675b59f688a1d73b0

See more details on using hashes here.

Provenance

The following attestation bundles were made for rknncli-0.3.1-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