Skip to content
v0.11.0

This content is for v0.11.0. Switch to the latest version for up-to-date documentation.

tigris zoo

Find and download precompiled .tgrs models from the TiGrIS model zoo. Downloads need no account.

Terminal window
tigris zoo list [OPTIONS]
tigris zoo fetch [MODEL] [OPTIONS]
tigris run downloaded-model/model.tgrs --input downloaded-model/example-input.bin --output prediction.bin
tigris codegen downloaded-model/model.tgrs --format core -o model.c

list and fetch take the same filters. All are optional; unspecified resources stay unconstrained.

Flag Description
--model Model name (fetch takes it as the first argument)
--category Task category, e.g. time-series-forecasting
--runtime A runtime release the build must be compatible with, e.g. 0.10.0
--backend Kernel backend, e.g. reference
--quantization, --quant Weight and activation precision, e.g. float32
-m, --mem Maximum fast arena; repeat for the slow arena
-f, --flash Maximum plan size in bytes

-m and -f bound the plan’s own arenas and size, not total application RAM or flash. The newest published build that matches wins.

Flag Description
--json Print the matching catalog entries as JSON
-v, --verbose Show artifact IDs, runtime compatibility and publication details

Without --verbose it prints a table of model, category, precision and memory.

Flag Description
--artifact ID Fetch an exact build, including a withdrawn one (with a warning)
-o, --output New destination directory; defaults to the artifact ID

fetch verifies every file hash and never replaces an existing directory.

Flag Description
--offline Use the Hugging Face cache without network requests
--catalog FILE Read a local zoo snapshot instead of the model repository
--revision Catalog revision to read; defaults to main
File Content
model.tgrs The plan
readme.md Input and output conventions, normalization, evaluation and limitations
evaluation.json Task measurements and runtime parity results
example-input.bin, example-output.bin One input tensor and its ONNX Runtime reference output
license.txt The model’s license and data attribution
manifest.json The build record as published: compiler, sources, file hashes
download.json The current runtime constraints, tested runtime releases and catalog revision

Use download.json for dependency decisions. Runtime ranges include both ends; a missing maximum means no known upper bound. Tested releases are listed separately, and matching a range does not claim every release in it was tested.

On a native wheel, tigris run executes a download directly on your machine with the bundled reference runtime:

Terminal window
tigris zoo fetch electricity-hourly -o downloaded-model
tigris inspect downloaded-model/model.tgrs
tigris run downloaded-model/model.tgrs \
--input downloaded-model/example-input.bin --output prediction.bin

Before executing, run checks the plan’s checksum against manifest.json and the loaded runtime against the model’s runtime range, taken from download.json (which must belong to the same artifact) or else from the manifest. example-output.bin comes from ONNX Runtime, so compare prediction.bin with it numerically, not byte for byte. evaluation.json records the tolerance and the parity measured for the runtime releases the model was tested with.

For a device, the runtime is supplied separately: the C runtime from tigris-runtime or the ESP-IDF component, at a release inside the model’s runtime range.