timmx 0.1.0__tar.gz

timmx-0.1.0/PKG-INFO

@@ -0,0 +1,344 @@
+Metadata-Version: 2.3
+Name: timmx
+Version: 0.1.0
+Summary: Extensible CLI and Python package for exporting timm models.
+Requires-Dist: rich
+Requires-Dist: timm
+Requires-Dist: torch>=2.5.0
+Requires-Dist: typer
+Requires-Dist: coremltools>=9.0 ; extra == 'coreml'
+Requires-Dist: executorch>=1.1.0 ; extra == 'executorch'
+Requires-Dist: litert-torch>=0.8.0 ; extra == 'litert'
+Requires-Dist: pnnx ; extra == 'ncnn'
+Requires-Dist: onnx>=1.16 ; extra == 'onnx'
+Requires-Dist: onnxscript ; extra == 'onnx'
+Requires-Python: >=3.11
+Provides-Extra: coreml
+Provides-Extra: executorch
+Provides-Extra: litert
+Provides-Extra: ncnn
+Provides-Extra: onnx
+Description-Content-Type: text/markdown
+
+# timmx
+
+An extensible CLI and Python package for exporting [timm](https://github.com/huggingface/pytorch-image-models) models to various deployment formats. Born out of having too many one-off export scripts for fine-tuned timm models — `timmx` unifies them behind a single command-line interface with a plugin-based backend system.
+
+## Supported Formats
+
+| Format | Command | Output |
+|--------|---------|--------|
+| ONNX | `timmx export onnx` | `.onnx` |
+| Core ML | `timmx export coreml` | `.mlpackage` / `.mlmodel` |
+| LiteRT / TFLite | `timmx export litert` | `.tflite` |
+| ncnn | `timmx export ncnn` | directory (`.param` + `.bin`) |
+| TensorRT | `timmx export tensorrt` | `.engine` |
+| ExecuTorch | `timmx export executorch` | `.pte` |
+| torch.export | `timmx export torch-export` | `.pt2` |
+| TorchScript | `timmx export torchscript` | `.pt` |
+
+## Requirements
+
+- Python `>=3.11`
+- [`uv`](https://docs.astral.sh/uv/)
+
+## Installation
+
+Core install (includes `timm`, `torch`, `typer`, `rich`):
+
+```bash
+pip install timmx
+```
+
+Install with specific backend extras:
+
+```bash
+pip install 'timmx[onnx]'           # ONNX export
+pip install 'timmx[coreml]'         # Core ML export
+pip install 'timmx[litert]'         # LiteRT/TFLite export
+pip install 'timmx[ncnn]'           # ncnn export (via pnnx)
+pip install 'timmx[executorch]'     # ExecuTorch export (XNNPack, CoreML delegates)
+pip install 'timmx[onnx,coreml]'    # multiple backends
+```
+
+TensorRT requires CUDA and must be installed separately:
+
+```bash
+pip install tensorrt  # Linux/Windows with CUDA only
+```
+
+> **Note:** The `executorch` and `litert` extras have conflicting torch version
+> requirements (`executorch` needs `torch>=2.10.0`, `litert` needs `torch<2.10.0`)
+> and cannot be installed in the same environment.
+
+Check which backends are available:
+
+```bash
+timmx doctor
+```
+
+## Quick Start
+
+```bash
+uv sync --extra onnx --extra coreml --extra ncnn --group dev
+uv run timmx doctor
+uv run timmx --help
+```
+
+## Usage Examples
+
+### ONNX
+
+```bash
+uv run timmx export onnx resnet18 --pretrained --output ./artifacts/resnet18.onnx
+```
+
+Export a fine-tuned checkpoint with dynamic batching:
+
+```bash
+uv run timmx export onnx resnet18 \
+  --checkpoint ./checkpoints/model.pth \
+  --input-size 3 224 224 \
+  --dynamic-batch \
+  --output ./artifacts/resnet18_finetuned.onnx
+```
+
+### Core ML
+
+```bash
+uv run timmx export coreml resnet18 \
+  --pretrained \
+  --convert-to mlprogram \
+  --compute-precision float16 \
+  --output ./artifacts/resnet18.mlpackage
+```
+
+Flexible batch size:
+
+```bash
+uv run timmx export coreml resnet18 \
+  --dynamic-batch \
+  --batch-size 2 \
+  --batch-upper-bound 8 \
+  --output ./artifacts/resnet18_dynamic.mlpackage
+```
+
+### LiteRT / TFLite
+
+Supported modes: `fp32`, `fp16`, `dynamic-int8`, `int8`.
+
+```bash
+uv run timmx export litert resnet18 \
+  --mode fp16 \
+  --output ./artifacts/resnet18_fp16.tflite
+```
+
+INT8 with calibration data:
+
+```bash
+# generate a calibration tensor
+uv run python -c "import torch; torch.save(torch.randn(64, 3, 224, 224), 'calibration.pt')"
+
+uv run timmx export litert resnet18 \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.tflite
+```
+
+NHWC input layout:
+
+```bash
+uv run timmx export litert resnet18 \
+  --mode fp32 \
+  --nhwc-input \
+  --output ./artifacts/resnet18_nhwc.tflite
+```
+
+### ncnn
+
+Exports via [pnnx](https://github.com/pnnx/pnnx) and writes a deployment-ready ncnn model directory containing `model.ncnn.param`, `model.ncnn.bin`, and `model_ncnn.py`. pnnx intermediate files are removed automatically.
+
+```bash
+uv run timmx export ncnn resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18_ncnn
+```
+
+Export without fp16 weight quantization:
+
+```bash
+uv run timmx export ncnn resnet18 \
+  --pretrained \
+  --no-fp16 \
+  --output ./artifacts/resnet18_ncnn_fp32
+```
+
+### TensorRT
+
+Requires an NVIDIA GPU with CUDA and the `tensorrt` package (`pip install tensorrt`).
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --mode fp16 \
+  --output ./artifacts/resnet18_fp16.engine
+```
+
+INT8 with calibration:
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.engine
+```
+
+Dynamic batch size:
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 4 \
+  --batch-min 1 \
+  --batch-max 32 \
+  --output ./artifacts/resnet18_dynamic.engine
+```
+
+### ExecuTorch
+
+Export with XNNPack delegation (default, runs on CPU across all platforms):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18.pte
+```
+
+CoreML delegation (macOS — targets Apple Neural Engine / GPU / CPU):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --output ./artifacts/resnet18_coreml.pte
+```
+
+CoreML with explicit fp32 compute precision (default is fp16):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --compute-precision float32 \
+  --output ./artifacts/resnet18_coreml_fp32.pte
+```
+
+INT8 quantized with XNNPack:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.pte
+```
+
+INT8 quantized with CoreML:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --mode int8 \
+  --output ./artifacts/resnet18_coreml_int8.pte
+```
+
+Dynamic batch size:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 2 \
+  --output ./artifacts/resnet18_dynamic.pte
+```
+
+### torch.export
+
+```bash
+uv run timmx export torch-export resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 2 \
+  --output ./artifacts/resnet18.pt2
+```
+
+> When using `--dynamic-batch`, set `--batch-size` to at least `2` so PyTorch can capture a symbolic batch dimension.
+
+### TorchScript
+
+```bash
+uv run timmx export torchscript resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18.pt
+```
+
+Use `torch.jit.script` instead of the default `trace`:
+
+```bash
+uv run timmx export torchscript resnet18 \
+  --pretrained \
+  --method script \
+  --output ./artifacts/resnet18_scripted.pt
+```
+
+## Diagnostics
+
+Run `timmx doctor` to check your installation and see which backends are available:
+
+```bash
+timmx doctor
+```
+
+This shows the timmx version, Python/torch versions, and a table of backend availability with install hints for any missing dependencies.
+
+## Roadmap
+
+- [x] ONNX
+- [x] Core ML
+- [x] LiteRT / TFLite
+- [x] ncnn
+- [x] torch.export
+- [x] TensorRT
+- [x] TorchScript
+- [x] ExecuTorch (XNNPack + CoreML delegates)
+- [ ] OpenVINO
+- [ ] TensorFlow (SavedModel / .pb)
+- [ ] TensorFlow.js
+- [ ] TFLite Edge TPU
+- [ ] RKNN
+- [ ] MNN
+- [ ] PaddlePaddle
+
+## Development
+
+```bash
+uv sync --extra onnx --extra coreml --extra ncnn --group dev  # install extras + pytest
+uvx ruff format .                                              # format
+uvx ruff check .                                               # lint
+uv run pytest                                                  # test
+uv build                                                       # build
+```
+
+## Adding a New Backend
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for a step-by-step guide on implementing and registering a new export backend.
+
+## AI Disclaimer
+
+This project is developed with the assistance of AI tools. The original export logic comes from various standalone scripts I wrote for exporting fine-tuned timm models to different deployment formats. The process of consolidating these scripts into a unified CLI tool has been aided by AI, with my oversight at every step, reviewing generated code, manually fixing issues during backend porting, and validating that exports produce correct results.

timmx-0.1.0/README.md

@@ -0,0 +1,322 @@
+# timmx
+
+An extensible CLI and Python package for exporting [timm](https://github.com/huggingface/pytorch-image-models) models to various deployment formats. Born out of having too many one-off export scripts for fine-tuned timm models — `timmx` unifies them behind a single command-line interface with a plugin-based backend system.
+
+## Supported Formats
+
+| Format | Command | Output |
+|--------|---------|--------|
+| ONNX | `timmx export onnx` | `.onnx` |
+| Core ML | `timmx export coreml` | `.mlpackage` / `.mlmodel` |
+| LiteRT / TFLite | `timmx export litert` | `.tflite` |
+| ncnn | `timmx export ncnn` | directory (`.param` + `.bin`) |
+| TensorRT | `timmx export tensorrt` | `.engine` |
+| ExecuTorch | `timmx export executorch` | `.pte` |
+| torch.export | `timmx export torch-export` | `.pt2` |
+| TorchScript | `timmx export torchscript` | `.pt` |
+
+## Requirements
+
+- Python `>=3.11`
+- [`uv`](https://docs.astral.sh/uv/)
+
+## Installation
+
+Core install (includes `timm`, `torch`, `typer`, `rich`):
+
+```bash
+pip install timmx
+```
+
+Install with specific backend extras:
+
+```bash
+pip install 'timmx[onnx]'           # ONNX export
+pip install 'timmx[coreml]'         # Core ML export
+pip install 'timmx[litert]'         # LiteRT/TFLite export
+pip install 'timmx[ncnn]'           # ncnn export (via pnnx)
+pip install 'timmx[executorch]'     # ExecuTorch export (XNNPack, CoreML delegates)
+pip install 'timmx[onnx,coreml]'    # multiple backends
+```
+
+TensorRT requires CUDA and must be installed separately:
+
+```bash
+pip install tensorrt  # Linux/Windows with CUDA only
+```
+
+> **Note:** The `executorch` and `litert` extras have conflicting torch version
+> requirements (`executorch` needs `torch>=2.10.0`, `litert` needs `torch<2.10.0`)
+> and cannot be installed in the same environment.
+
+Check which backends are available:
+
+```bash
+timmx doctor
+```
+
+## Quick Start
+
+```bash
+uv sync --extra onnx --extra coreml --extra ncnn --group dev
+uv run timmx doctor
+uv run timmx --help
+```
+
+## Usage Examples
+
+### ONNX
+
+```bash
+uv run timmx export onnx resnet18 --pretrained --output ./artifacts/resnet18.onnx
+```
+
+Export a fine-tuned checkpoint with dynamic batching:
+
+```bash
+uv run timmx export onnx resnet18 \
+  --checkpoint ./checkpoints/model.pth \
+  --input-size 3 224 224 \
+  --dynamic-batch \
+  --output ./artifacts/resnet18_finetuned.onnx
+```
+
+### Core ML
+
+```bash
+uv run timmx export coreml resnet18 \
+  --pretrained \
+  --convert-to mlprogram \
+  --compute-precision float16 \
+  --output ./artifacts/resnet18.mlpackage
+```
+
+Flexible batch size:
+
+```bash
+uv run timmx export coreml resnet18 \
+  --dynamic-batch \
+  --batch-size 2 \
+  --batch-upper-bound 8 \
+  --output ./artifacts/resnet18_dynamic.mlpackage
+```
+
+### LiteRT / TFLite
+
+Supported modes: `fp32`, `fp16`, `dynamic-int8`, `int8`.
+
+```bash
+uv run timmx export litert resnet18 \
+  --mode fp16 \
+  --output ./artifacts/resnet18_fp16.tflite
+```
+
+INT8 with calibration data:
+
+```bash
+# generate a calibration tensor
+uv run python -c "import torch; torch.save(torch.randn(64, 3, 224, 224), 'calibration.pt')"
+
+uv run timmx export litert resnet18 \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.tflite
+```
+
+NHWC input layout:
+
+```bash
+uv run timmx export litert resnet18 \
+  --mode fp32 \
+  --nhwc-input \
+  --output ./artifacts/resnet18_nhwc.tflite
+```
+
+### ncnn
+
+Exports via [pnnx](https://github.com/pnnx/pnnx) and writes a deployment-ready ncnn model directory containing `model.ncnn.param`, `model.ncnn.bin`, and `model_ncnn.py`. pnnx intermediate files are removed automatically.
+
+```bash
+uv run timmx export ncnn resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18_ncnn
+```
+
+Export without fp16 weight quantization:
+
+```bash
+uv run timmx export ncnn resnet18 \
+  --pretrained \
+  --no-fp16 \
+  --output ./artifacts/resnet18_ncnn_fp32
+```
+
+### TensorRT
+
+Requires an NVIDIA GPU with CUDA and the `tensorrt` package (`pip install tensorrt`).
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --mode fp16 \
+  --output ./artifacts/resnet18_fp16.engine
+```
+
+INT8 with calibration:
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.engine
+```
+
+Dynamic batch size:
+
+```bash
+uv run timmx export tensorrt resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 4 \
+  --batch-min 1 \
+  --batch-max 32 \
+  --output ./artifacts/resnet18_dynamic.engine
+```
+
+### ExecuTorch
+
+Export with XNNPack delegation (default, runs on CPU across all platforms):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18.pte
+```
+
+CoreML delegation (macOS — targets Apple Neural Engine / GPU / CPU):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --output ./artifacts/resnet18_coreml.pte
+```
+
+CoreML with explicit fp32 compute precision (default is fp16):
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --compute-precision float32 \
+  --output ./artifacts/resnet18_coreml_fp32.pte
+```
+
+INT8 quantized with XNNPack:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --mode int8 \
+  --calibration-data ./calibration.pt \
+  --calibration-steps 8 \
+  --output ./artifacts/resnet18_int8.pte
+```
+
+INT8 quantized with CoreML:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --delegate coreml \
+  --mode int8 \
+  --output ./artifacts/resnet18_coreml_int8.pte
+```
+
+Dynamic batch size:
+
+```bash
+uv run timmx export executorch resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 2 \
+  --output ./artifacts/resnet18_dynamic.pte
+```
+
+### torch.export
+
+```bash
+uv run timmx export torch-export resnet18 \
+  --pretrained \
+  --dynamic-batch \
+  --batch-size 2 \
+  --output ./artifacts/resnet18.pt2
+```
+
+> When using `--dynamic-batch`, set `--batch-size` to at least `2` so PyTorch can capture a symbolic batch dimension.
+
+### TorchScript
+
+```bash
+uv run timmx export torchscript resnet18 \
+  --pretrained \
+  --output ./artifacts/resnet18.pt
+```
+
+Use `torch.jit.script` instead of the default `trace`:
+
+```bash
+uv run timmx export torchscript resnet18 \
+  --pretrained \
+  --method script \
+  --output ./artifacts/resnet18_scripted.pt
+```
+
+## Diagnostics
+
+Run `timmx doctor` to check your installation and see which backends are available:
+
+```bash
+timmx doctor
+```
+
+This shows the timmx version, Python/torch versions, and a table of backend availability with install hints for any missing dependencies.
+
+## Roadmap
+
+- [x] ONNX
+- [x] Core ML
+- [x] LiteRT / TFLite
+- [x] ncnn
+- [x] torch.export
+- [x] TensorRT
+- [x] TorchScript
+- [x] ExecuTorch (XNNPack + CoreML delegates)
+- [ ] OpenVINO
+- [ ] TensorFlow (SavedModel / .pb)
+- [ ] TensorFlow.js
+- [ ] TFLite Edge TPU
+- [ ] RKNN
+- [ ] MNN
+- [ ] PaddlePaddle
+
+## Development
+
+```bash
+uv sync --extra onnx --extra coreml --extra ncnn --group dev  # install extras + pytest
+uvx ruff format .                                              # format
+uvx ruff check .                                               # lint
+uv run pytest                                                  # test
+uv build                                                       # build
+```
+
+## Adding a New Backend
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for a step-by-step guide on implementing and registering a new export backend.
+
+## AI Disclaimer
+
+This project is developed with the assistance of AI tools. The original export logic comes from various standalone scripts I wrote for exporting fine-tuned timm models to different deployment formats. The process of consolidating these scripts into a unified CLI tool has been aided by AI, with my oversight at every step, reviewing generated code, manually fixing issues during backend porting, and validating that exports produce correct results.

timmx-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "timmx"
+version = "0.1.0"
+description = "Extensible CLI and Python package for exporting timm models."
+readme = "README.md"
+requires-python = ">=3.11"
+dependencies = [
+  "rich",
+  "timm",
+  "torch>=2.5.0",
+  "typer",
+]
+
+[project.optional-dependencies]
+coreml = ["coremltools>=9.0"]
+executorch = ["executorch>=1.1.0"]
+litert = ["litert-torch>=0.8.0"]
+ncnn = ["pnnx"]
+onnx = ["onnx>=1.16", "onnxscript"]
+
+[project.scripts]
+timmx = "timmx.cli:main"
+
+[dependency-groups]
+dev = [
+  "pytest>=8.3.4",
+]
+
+[build-system]
+requires = ["uv_build>=0.10.0,<0.11.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "timmx"
+module-root = "src"
+
+[tool.uv]
+conflicts = [
+  [
+    { extra = "executorch" },
+    { extra = "litert" },
+  ],
+]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 100
+
+[tool.ruff.lint]
+extend-select = ["I"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-q"

timmx-0.1.0/src/timmx/__init__.py

@@ -0,0 +1,6 @@
+"""timmx package."""
+
+from importlib.metadata import version
+
+__all__ = ["__version__"]
+__version__ = version("timmx")