Skip to main content

Spox

CI Documentation Status

Spox makes it easy to construct ONNX models through clean and idiomatic Python code.

Why use Spox?

A common application of ONNX is converting models from various frameworks. This requires replicating their runtime behaviour with ONNX operators. In the past this has been a major challenge. Based on our experience, we designed Spox from the ground up to make the process of writing converters (and ONNX models in general) as easy as possible.

Spox's features include:

  • Eager operator validation and type inference
  • Errors with Python tracebacks to offending operators
  • First-class support for subgraphs (control flow)
  • A lean and predictable API

Installation

Spox releases are available on PyPI:

pip install spox

There is also a package available on conda-forge:

conda install spox

Quick start

In Spox, you primarily interact with Var objects - variables - which are placeholders for runtime values. The initial Var objects, which represent the arguments of a model (the model inputs in ONNX nomenclature), are created with an explicit type using the argument(Type) -> Var function. The possible types include Tensor, Sequence, and Optional. All further Var objects are created by calling functions which take existing Var objects as inputs and produce new Var objects as outputs. Spox determines the Var.type for these eagerly to allow validation. Spox provides such functions for all operators in the standard. They are grouped by domain and version in the spox.opset submodule.

The final onnx.ModelProto object is built by passing input and output Vars for the model to the spox.build function.

Below is an example for defining an ONNX graph which computes the geometric mean of two inputs. Make sure to consult the Spox documentation to find more details and tutorials.

import onnx

from spox import argument, build, Tensor, Var
# Import operators from the ai.onnx domain at version 17
from spox.opset.ai.onnx import v17 as op

def geometric_mean(x: Var, y: Var) -> Var:
    # use the standard Sqrt and Mul
    return op.sqrt(op.mul(x, y))

# Create typed model inputs. Each tensor is of rank 1
# and has the runtime-determined length 'N'.
a = argument(Tensor(float, ('N',)))
b = argument(Tensor(float, ('N',)))

# Perform operations on `Var`s
c = geometric_mean(a, b)

# Build an `onnx.ModelProto` for the given inputs and outputs.
model: onnx.ModelProto = build(inputs={'a': a, 'b': b}, outputs={'c': c})

Credits

Original designed and developed by @jbachurski with the supervision of @cbourjau.

Metadata

Release files for spox 0.18.2

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for spox 0.18.2
File Size Uploaded Provenance Actions
spox-0.18.2.tar.gz 594.0 kB With provenance Details for spox-0.18.2.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for spox 0.18.2
File Interpreter ABI Platform Actions
spox-0.18.2-py3-none-any.whl Python 3 none any Details for spox-0.18.2-py3-none-any.whl

Total release size: 959.3 kB

Release files / spox-0.18.2.tar.gz

Download URL spox-0.18.2.tar.gz
Size 594.0 kB
Tags Source
SHA-256 checksum
How to use checksums
e1f73429f5b21f297c6660d8a13b2534678139d25237de5c4776c11c60e19613
BLAKE2b-256 checksum
How to use checksums
fd5c9e6bb9bbc22bfb390933b98d9bf6dbb3a5cebb95bc34a9577dbe94827644
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Release files / spox-0.18.2-py3-none-any.whl

Download URL spox-0.18.2-py3-none-any.whl
Size 365.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
8ba79f1669c14ae8082f4b43e049241ce521e5e37d0c38b75554192d377122ac
BLAKE2b-256 checksum
How to use checksums
59222c6fabc25803f83aa3b54874bb34b2e20e329df8ee5073b430dc67cf2055
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

Security for spox 0.18.2

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for spox-0.18.2.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 20, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page