Skip to content

Commit eb18db2

Browse files
zhmiaoCopilot
andcommitted
docs(oq-2+oq-4): add --dest example to README + brew README 'all 6' → 'all 8 SONAMEs'
OQ-2026-05-28-2 close: PW README.md 'Point Sparrow Engine at the directory' section now shows BOTH the default-path env-var example AND a custom-path example for users who used --dest. OQ-2026-05-28-4 close: installer/homebrew/README.md 'all 6' → 'all 8 required CUDA sidecar SONAMEs (across 7 pip packages)' at all 3 occurrences. Matches the existing 7-row sidecar table at lines 56-64 which lists 8 SONAMEs. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 861ec89 commit eb18db2

2 files changed

Lines changed: 15 additions & 10 deletions

File tree

README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,10 @@ bash scripts/download_models.sh --dest /custom/path
156156
Point Sparrow Engine at the directory (only needed if you used `--dest`; the default location is auto-detected):
157157

158158
```bash
159+
# Default path (auto-detected — env var only needed if you want to be explicit):
159160
export SPARROW_ENGINE_MODEL_DIR=$(realpath ~/.sparrow-engine/models)
161+
# Custom path (required if you used `--dest /opt/sparrow-models`):
162+
export SPARROW_ENGINE_MODEL_DIR=/opt/sparrow-models
160163
spe models list # confirms catalog discovery
161164
spe detect --model MDV6-yolov10-e --print image.jpg
162165
```

installer/homebrew/README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,11 +11,12 @@ the rest of the codebase.
1111
the `spe` binary with bundled `libonnxruntime`.
1212
- `sparrow-engine-gpu.rb` — GPU formula. brew-Linux x86_64 only. Ships
1313
`spe-gpu` with bundled `libonnxruntime` + ORT CUDA provider sidecars.
14-
Adds a wrapper script that auto-discovers ALL 6 required CUDA sidecar
15-
libs (`libcudnn.so.9`, `libnvjpeg.so.12`, `libnvrtc.so.12`,
14+
Adds a wrapper script that auto-discovers all 8 required CUDA sidecar
15+
SONAMEs (`libcudnn.so.9`, `libnvjpeg.so.12`, `libnvrtc.so.12`,
1616
`libcudart.so.12`, `libcublas.so.12` + `libcublasLt.so.12`,
17-
`libcurand.so.10`, `libcufft.so.11`) from common host locations at
18-
startup (no `LD_LIBRARY_PATH` manual setup required).
17+
`libcurand.so.10`, `libcufft.so.11`) — 7 pip packages, since `libcublas`
18+
and `libcublasLt` ship together in `nvidia-cublas-cu12` — from common
19+
host locations at startup (no `LD_LIBRARY_PATH` manual setup required).
1920

2021
Both formulas point at the GH Release tarballs produced by RP-4
2122
(`.github/workflows/release.yml § build-cli-*` + `publish-cli-release-assets`).
@@ -43,8 +44,9 @@ share the model cache at `~/.sparrow-engine/models/`.
4344
## The wrapper script (GPU only)
4445

4546
`brew install sparrow-engine-gpu` generates `bin/spe-gpu` as a small
46-
POSIX shell wrapper (not a symlink) that auto-discovers ALL 6 hard-
47-
required CUDA sidecar libraries before `exec`'ing the real binary at
47+
POSIX shell wrapper (not a symlink) that auto-discovers all 8 hard-
48+
required CUDA sidecar SONAMEs (across 7 pip packages — see table below)
49+
before `exec`'ing the real binary at
4850
`libexec/bin/spe-gpu`. The discovery loop covers, per library, the same
4951
9 candidate locations (pip wheel under `~/.sparrow-engine/cuda-sidecars`,
5052
PyTorch / TensorFlow / JAX bundles, system CUDA, apt, HPC, RHEL). The
@@ -64,13 +66,13 @@ Required libs (matches `probe_gpu_quality.sh:144-150`):
6466
| `nvidia-cufft-cu12` | `libcufft.so.11` |
6567

6668
Override the search via `SPARROW_ENGINE_CUDA_LIB_DIR=/some/path
67-
spe-gpu …` — the wrapper skips auto-discovery for all 6 libs when this
69+
spe-gpu …` — the wrapper skips auto-discovery for all 8 SONAMEs when this
6870
env var is set. Brew rewrites the wrapper on every `(re)install`; do
6971
NOT edit it in place.
7072

71-
Full caveats block (with the 9 location list and the 6-lib table)
72-
appears at the end of `brew install` output, or run `brew info
73-
sparrow-engine-gpu`.
73+
Full caveats block (with the 9 location list and the 7-package /
74+
8-SONAME table) appears at the end of `brew install` output, or run
75+
`brew info sparrow-engine-gpu`.
7476

7577
## Bootstrapping the tap repo (one-time, operator action — DONE 2026-05-27)
7678

0 commit comments

Comments
 (0)