dtourolle
cb97ebe7ac
The Windows installer and the Flatpak carried no ONNX Runtime, so they ran every model on tract's one core; the Arch package left it to an optional dependency. Each now installs two builds under runtimes/ — Intel's OpenVINO build and the generic WebGPU one, both with the CPU provider — fetched by tools/fetch-bundled-runtimes.sh from PyPI wheels pinned by SHA-256, pruned to the native libraries (81 + 31 MB on Linux, 67 + 42 MB on Windows), licence texts beside them. darkroom-desktop searches runtimes/openvino and runtimes/webgpu under each place a package installs to; the engine opens all it finds and keeps the one that fits the GPU, so a CUDA or ROCm runtime installed beside them still wins on its vendor's card. On Windows the chosen runtime's directory goes on PATH, because Intel's build leaves OpenVINO's DLLs for the loader to find there. The Windows image gains unzip; the installer smoke test checks both runtimes landed.
116 lines
5.5 KiB
Bash
Executable File
116 lines
5.5 KiB
Bash
Executable File
#!/usr/bin/env bash
|
|
# Assemble the Windows installer from a finished cross-build.
|
|
#
|
|
# ./docker/windows/build.sh docker/windows/package.sh
|
|
#
|
|
# Expects `cargo build --release --target x86_64-pc-windows-gnu -p darkroom-desktop`
|
|
# to have run in the same target directory. Produces
|
|
# DarkRoom-<version>-x86_64-setup.exe in $OUT (default: target-windows/installer).
|
|
#
|
|
# Runs inside the container, where makensis is; docs/dev/windows.md §5 is the
|
|
# specification this implements.
|
|
set -euo pipefail
|
|
|
|
HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
|
|
REPO="$(cd "${HERE}/../.." && pwd)"
|
|
# Absolute, whatever CARGO_TARGET_DIR was. NSIS on a POSIX host translates
|
|
# the backslashes in `${STAGE}\LICENSE` only when it can tell the path is a
|
|
# POSIX one, which it decides from a leading `/`; a relative `target-windows`
|
|
# — which is exactly what CI sets — reaches it as a name with a literal
|
|
# backslash in it and "LicenseData: open failed". The first CI run died there,
|
|
# after every step before it had passed.
|
|
TARGET_DIR="$(realpath -m "${CARGO_TARGET_DIR:-${REPO}/target}")"
|
|
TARGET="${TARGET_DIR}/x86_64-pc-windows-gnu/release"
|
|
OUT="$(realpath -m "${OUT:-${TARGET_DIR}/installer}")"
|
|
|
|
EXE="${TARGET}/darkroom-desktop.exe"
|
|
[[ -f "${EXE}" ]] || { echo "error: ${EXE} not built" >&2; exit 1; }
|
|
|
|
# The version, from the workspace rather than restated here — the same single
|
|
# source tools/set-version.sh writes and the APK packager reads.
|
|
VERSION="$(sed -n 's/^version = "\(.*\)"$/\1/p' "${REPO}/Cargo.toml" | head -1)"
|
|
[[ -n "${VERSION}" ]] || { echo "error: no version in Cargo.toml" >&2; exit 1; }
|
|
echo "==> version ${VERSION}"
|
|
|
|
# Staging: exactly what the installer carries (windows.md §5.2), and nothing
|
|
# from a previous run — a model dropped from the tree must not linger here
|
|
# and go on shipping.
|
|
STAGE="${OUT}/stage"
|
|
rm -rf "${STAGE}"
|
|
mkdir -p "${STAGE}/models"
|
|
cp "${EXE}" "${STAGE}/darkroom.exe"
|
|
# CRLF for the licence page: it is shown in a Windows edit control, which
|
|
# draws a bare LF as nothing and runs the whole GPL together.
|
|
sed 's/$/\r/' "${REPO}/LICENSE" > "${STAGE}/LICENSE"
|
|
|
|
# The models, with the guard every other packager carries: an LFS pointer is
|
|
# ~130 bytes and looks exactly like a model to `cp`. Shipped, it fails inside
|
|
# tract on the user's machine with a message about a broken graph rather than
|
|
# a checkout that needed `git lfs pull`. Only the weights are checked; the
|
|
# scene model's vocabulary and category descriptor are legitimately small.
|
|
#
|
|
# The directories are the ones the APK stages (assemble-apk.sh) and the Arch
|
|
# package installs: the face pair and its eye-state models, the scene model
|
|
# with its two descriptors, the panorama border filler and the denoiser. The installer
|
|
# smoke test counts the same directories, so a model added here is expected
|
|
# there without a number to update.
|
|
#
|
|
# Not the quantised siblings (`*.int8.onnx`, `*.a16w8.onnx`, `*.a16w16.onnx`):
|
|
# they are the Hexagon's forms (docs/dev/inference.md §1.5), and a Windows
|
|
# machine has no Hexagon to load them.
|
|
for dir in face scene inpaint denoise; do
|
|
for f in "${REPO}/models/${dir}"/*; do
|
|
case "$(basename "${f}")" in
|
|
README.md | *.int8.onnx | *.a16w8.onnx | *.a16w16.onnx) continue ;;
|
|
esac
|
|
if [[ "${f}" == *.onnx && "$(stat -c%s "${f}")" -lt 100000 ]]; then
|
|
echo "error: $(basename "${f}") is $(stat -c%s "${f}") bytes — an LFS pointer, not a model." >&2
|
|
echo " run: git lfs pull" >&2
|
|
exit 1
|
|
fi
|
|
cp "${f}" "${STAGE}/models/"
|
|
done
|
|
done
|
|
echo "==> staged $(ls "${STAGE}/models" | wc -l) model file(s)"
|
|
|
|
# The manual: the rendered page and its pictures, beside the executable where
|
|
# dr_ui::manual looks on Windows (dr_plat::system_data_dirs is the exe's own
|
|
# directory there). The pictures are LFS objects; a pointer is ~130 bytes of
|
|
# text that every browser draws as a broken image, so refuse it here rather
|
|
# than ship a manual with no pictures in it.
|
|
mkdir -p "${STAGE}/manual/media"
|
|
cp "${REPO}/docs/manual/index.html" "${STAGE}/manual/"
|
|
for f in "${REPO}/docs/manual/media"/*; do
|
|
if head -c 40 "${f}" | grep -q '^version https://git-lfs'; then
|
|
echo "error: $(basename "${f}") is an LFS pointer, not a picture." >&2
|
|
echo " run: git lfs pull --include='docs/manual/media/**'" >&2
|
|
exit 1
|
|
fi
|
|
cp "${f}" "${STAGE}/manual/media/"
|
|
done
|
|
echo "==> staged the manual and $(ls "${STAGE}/manual/media" | wc -l) picture(s)"
|
|
|
|
# The two ONNX Runtime builds the app chooses between at launch
|
|
# (docs/dev/inference.md §3.2): Intel's OpenVINO build for an Intel GPU and
|
|
# the WebGPU build — D3D12 — for any other, both carrying the CPU provider.
|
|
# Beside the executable under `runtimes\`, where darkroom-desktop looks.
|
|
"${REPO}/tools/fetch-bundled-runtimes.sh" windows "${STAGE}/runtimes"
|
|
echo "==> staged $(ls "${STAGE}/runtimes"/* | wc -l) runtime file(s)"
|
|
|
|
# One installer in the output directory, the one just built. The directory
|
|
# is cached between CI runs, so after a version bump a glob over it would find
|
|
# two and the smoke test would hand Wine both names as one path.
|
|
rm -f "${OUT}"/DarkRoom-*-x86_64-setup.exe
|
|
INSTALLER="${OUT}/DarkRoom-${VERSION}-x86_64-setup.exe"
|
|
# NSIS wants Windows-style paths in File directives even on a POSIX host, and
|
|
# the script takes its inputs by define so nothing about the layout here is
|
|
# written into it.
|
|
makensis -V2 \
|
|
-DVERSION="${VERSION}" \
|
|
-DSTAGE="${STAGE}" \
|
|
-DOUT="${INSTALLER}" \
|
|
"${REPO}/packaging/windows/darkroom.nsi"
|
|
|
|
ls -la "${INSTALLER}"
|
|
echo "==> ${INSTALLER}"
|