Files
DarkRoom/tools/fix-face-model-shapes.sh
T
dtourolleandClaude Opus 5 72410f39c6 Answer M1: tract loads both face graphs once their dims are pinned
Neither InsightFace export parses as shipped -- SCRFD fails at its input
node, ArcFace at the first Conv -- which is the same wall dr-segment hit
on YOLO's dynamic export. Both load cleanly with the input dims frozen,
so the pure-Rust runtime holds for the face pipeline too.

tools/fix-face-model-shapes.sh does the freezing, and exists so the
artefact is reproducible rather than a binary someone once produced. It
takes two forms because the two graphs need different ones: ArcFace's
batch is a named dim_param, SCRFD's H and W are dynamic but unnamed.

Also notes YuNet loading with no intervention, which matters for the
licence question in faces.md 2.3.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
2026-08-26 19:51:02 +02:00

110 lines
4.2 KiB
Bash
Executable File

#!/usr/bin/env bash
# Freeze the input dimensions of the face models so tract can parse them.
#
# ./tools/fix-face-model-shapes.sh IN.onnx OUT.onnx --input NAME=1,3,640,640
# ./tools/fix-face-model-shapes.sh IN.onnx OUT.onnx --dim NAME=1
#
# The two the face pipeline needs, verified 2026-08-26 (docs/faces.md §12 M1):
#
# ... det_500m.onnx scrfd_500m_640.onnx --input input.1=1,3,640,640
# ... w600k_mbf.onnx arcface_mbf_b1.onnx --dim None=1
#
# ## Why this exists
#
# The InsightFace exports declare dynamic input dimensions — SCRFD's H and W,
# ArcFace's batch N. **tract cannot parse either graph in that form**, failing
# at the input node and at the first Conv respectively:
#
# scrfd_500m_bnkps.onnx Translating node #0 "input.1" Source ToTypedTranslator
# arcface_w600k_mbf.onnx Failed analyse for node #139 "Conv_0" ConvHir
#
# Both load cleanly once the dims are pinned. This is the same wall dr-segment
# hit, which is why `tools/export-seg-model.sh` passes `dynamic=False`; here we
# cannot re-export from PyTorch, because the weights are InsightFace's and the
# training code is not in the loop, so the dims are rewritten in the ONNX file
# instead.
#
# `make_dynamic_shape_fixed` only edits the declared dimension; it does not
# retrain, requantise, or change a single weight. The output is numerically the
# same graph with one shape pinned. SCRFD's *outputs* were already static — the
# export was made at 640 and only its input forgot to say so — which is why 640
# is not a free choice here.
#
# ## Why it is a script and not a build step
#
# Same reason as the segmentation export: the model is not a build input
# (docs/faces.md §2.2 — the weights are never committed, because InsightFace's
# grant is non-commercial). This runs once, wherever the user's model lives,
# and the app loads the result. It exists so the transformation is reproducible
# rather than a binary someone once produced and nobody can regenerate.
#
# Requires `uv`. Everything else is fetched into a throwaway venv, in /var/tmp
# rather than /tmp — /tmp here is a tmpfs, and onnxruntime is not small.
set -euo pipefail
if [ "$#" -lt 4 ]; then
sed -n '2,10p' "$0" >&2
exit 2
fi
IN="$1"; shift
OUT="$1"; shift
[ -f "$IN" ] || { echo "no such model: $IN" >&2; exit 1; }
WORK="$(mktemp -d -p /var/tmp fix-face-shapes.XXXXXX)"
trap 'rm -rf "${WORK}"' EXIT
echo "==> venv in ${WORK}"
uv venv --python 3.12 "${WORK}/venv" >/dev/null
VIRTUAL_ENV="${WORK}/venv" uv pip install --quiet onnx onnxruntime
# Two forms, because the two models need different ones — and which one a graph
# needs is not a matter of taste:
#
# --dim NAME=VALUE for a *named* symbolic dimension.
# --input NAME=D,D,D,D for a dimension that is dynamic but unnamed.
#
# ArcFace declares its batch as the literal dim_param "None", so `--dim` binds
# it. SCRFD's H and W carry no dim_param at all, so there is no name to bind
# and the whole input shape has to be restated. Reaching for `--dim` first and
# getting a silent no-op is the half-hour worth skipping.
CUR="$IN"
STEP=0
while [ "$#" -gt 0 ]; do
FLAG="$1"; shift
PAIR="${1:-}"; shift || true
NAME="${PAIR%%=*}"
VAL="${PAIR#*=}"
STEP=$((STEP + 1))
NEXT="${WORK}/step${STEP}.onnx"
case "$FLAG" in
--dim)
echo "==> dim_param ${NAME} := ${VAL}"
"${WORK}/venv/bin/python" -m onnxruntime.tools.make_dynamic_shape_fixed \
--dim_param "${NAME}" --dim_value "${VAL}" "${CUR}" "${NEXT}"
;;
--input)
echo "==> input ${NAME} := ${VAL}"
"${WORK}/venv/bin/python" -m onnxruntime.tools.make_dynamic_shape_fixed \
--input_name "${NAME}" --input_shape "${VAL}" "${CUR}" "${NEXT}"
;;
*)
echo "unknown flag ${FLAG} (want --dim or --input)" >&2
exit 2
;;
esac
CUR="${NEXT}"
done
cp "${CUR}" "${OUT}"
echo "==> wrote ${OUT}"
"${WORK}/venv/bin/python" - "$OUT" <<'PY'
import sys, onnx
m = onnx.load(sys.argv[1])
for vi in list(m.graph.input) + list(m.graph.output):
dims = [d.dim_value if d.HasField("dim_value") else (d.dim_param or "?")
for d in vi.type.tensor_type.shape.dim]
print(f" {vi.name:<24} {dims}")
PY