From 006adb2b0ffb45d78a7a3db3196023adf8db6ce4 Mon Sep 17 00:00:00 2001 From: Andrea Borio Date: Wed, 22 Jul 2026 19:21:02 +0200 Subject: [PATCH] Close final Hebrus documentation gaps --- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 4 ++-- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/performance_report.yml | 2 +- CITATION.cff | 4 ++-- FORK_NOTES.md | 2 +- MERGE_LOG.md | 4 ++-- SECURITY.md | 2 +- docs/ENGINE_REFERENCE.md | 10 +++++----- docs/contracts/BRAND_COMPATIBILITY.md | 9 ++++----- docs/guides/MIGRATING_TO_HEBRUS.md | 7 ++++--- 11 files changed, 24 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 45c86b6c8..451a2ee7b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -7,7 +7,7 @@ body: value: | Thanks for helping improve Hebrus. Search existing issues before filing a report. - For a possible vulnerability, stop here and follow the [security policy](https://github.com/andreaborio/ds4/blob/main/SECURITY.md). Do not post vulnerability details, secrets, private data, model weights, or model blobs in an issue. + For a possible vulnerability, stop here and follow the [security policy](https://github.com/andreaborio/hebrus/blob/main/SECURITY.md). Do not post vulnerability details, secrets, private data, model weights, or model blobs in an issue. - type: checkboxes id: prerequisites diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index 8ab4777ee..6ba83af54 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,8 +1,8 @@ blank_issues_enabled: false contact_links: - name: Security policy - url: https://github.com/andreaborio/ds4/blob/main/SECURITY.md + url: https://github.com/andreaborio/hebrus/blob/main/SECURITY.md about: Read the private-reporting status before reporting a vulnerability. Do not disclose vulnerability details in a public issue. - name: Contribution guide - url: https://github.com/andreaborio/ds4/blob/main/CONTRIBUTING.md + url: https://github.com/andreaborio/hebrus/blob/main/CONTRIBUTING.md about: Review the contribution, validation, evidence, and compatibility requirements before opening a pull request. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 20076297b..ee7daf45c 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -7,7 +7,7 @@ body: value: | Explain the user problem before the implementation. Hebrus prioritizes Apple Metal inference and SSD streaming while preserving deliberate compatibility and upstream attribution. - Performance claims belong in the dedicated performance report. Security reports must follow [SECURITY.md](https://github.com/andreaborio/ds4/blob/main/SECURITY.md) and must not be disclosed here. + Performance claims belong in the dedicated performance report. Security reports must follow [SECURITY.md](https://github.com/andreaborio/hebrus/blob/main/SECURITY.md) and must not be disclosed here. - type: checkboxes id: prerequisites diff --git a/.github/ISSUE_TEMPLATE/performance_report.yml b/.github/ISSUE_TEMPLATE/performance_report.yml index 8d2cdadb0..ffd2c30eb 100644 --- a/.github/ISSUE_TEMPLATE/performance_report.yml +++ b/.github/ISSUE_TEMPLATE/performance_report.yml @@ -7,7 +7,7 @@ body: value: | Performance reports must be reproducible and correctness-preserving. Separate cold and warm runs, identify exact artifacts, and disclose memory pressure or competing workloads. - Do not attach model weights, model blobs, large binaries, secrets, or private prompts. Possible vulnerabilities belong under [SECURITY.md](https://github.com/andreaborio/ds4/blob/main/SECURITY.md), not in a public issue. + Do not attach model weights, model blobs, large binaries, secrets, or private prompts. Possible vulnerabilities belong under [SECURITY.md](https://github.com/andreaborio/hebrus/blob/main/SECURITY.md), not in a public issue. - type: checkboxes id: prerequisites diff --git a/CITATION.cff b/CITATION.cff index e305a849b..f76b040c7 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -10,8 +10,8 @@ abstract: >- An open-source inference engine focused on Apple Metal, embedded ExpertMajor model stores, and SSD streaming for large mixture-of-experts models. license: MIT -repository-code: "https://github.com/andreaborio/ds4" -url: "https://github.com/andreaborio/ds4" +repository-code: "https://github.com/andreaborio/hebrus" +url: "https://github.com/andreaborio/hebrus" keywords: - Apple Metal - GGUF diff --git a/FORK_NOTES.md b/FORK_NOTES.md index 05bfd836f..429f191d5 100644 --- a/FORK_NOTES.md +++ b/FORK_NOTES.md @@ -1,4 +1,4 @@ -# Fork notes — andreaborio/ds4 +# Fork notes — andreaborio/hebrus This is a transparent co-development fork of **antirez/ds4** (DwarfStar). This file records grouped fork deltas, their evidence, and their upstream status so diff --git a/MERGE_LOG.md b/MERGE_LOG.md index 28f465310..a4d56521f 100644 --- a/MERGE_LOG.md +++ b/MERGE_LOG.md @@ -1,6 +1,6 @@ # Upstream merge log -Record of syncs of this fork (`andreaborio/ds4`) with upstream `antirez/ds4`, and how the +Record of syncs of this fork (`andreaborio/hebrus`) with upstream `antirez/ds4`, and how the fork's engine additions were preserved across upstream refactors. See [`FORK_NOTES.md`](FORK_NOTES.md) for per-change upstreamability and [`README.md`](README.md) ("This fork") for what each addition does. @@ -17,7 +17,7 @@ short-context bring-up rather than a mainline feature. No new upstream commits were present after `80ebbc3` during the 2026-06-24 refresh; the work here is publishing the already-validated sync and bringing the -fork README up to date before pushing `andreaborio/ds4`. +fork README up to date before pushing the repository now named `andreaborio/hebrus`. ### 2026-06-24 verification on M5 Pro / 64 GB diff --git a/SECURITY.md b/SECURITY.md index 3de3d555a..f86aaed4f 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -5,7 +5,7 @@ The project intends to receive vulnerability reports through GitHub's private vulnerability reporting flow: - + Private vulnerability reporting is not enabled for this repository yet. Enabling it is a required administrative step before public launch; until then, diff --git a/docs/ENGINE_REFERENCE.md b/docs/ENGINE_REFERENCE.md index c5b6a700f..d33c0019a 100644 --- a/docs/ENGINE_REFERENCE.md +++ b/docs/ENGINE_REFERENCE.md @@ -339,11 +339,11 @@ comparable. | Mac / tested ds4 build | Cache and context | Bounded workload | Prefill | Generation | | --- | --- | --- | ---: | ---: | -| M1 Pro, 16 GB / [`2f95e67`](https://github.com/andreaborio/ds4/commit/2f95e67fdec1db988fe8b1a699330f387de66004) | exact 259, 8,192 | DSBox API, 9 prompt + 2 output tokens | — | 0.30 t/s cold; 0.53 / 0.51 / 0.51 t/s warm (~0.52 t/s) | -| M1 Pro, 16 GB / [`bf4201c`](https://github.com/andreaborio/ds4/commit/bf4201c47b901f0f479dc4af3f3df77330fabacf) | exact 259, 8,192 | extremely hot CLI, 14 + 2 tokens | 1.02–1.64 t/s | 2.13–2.46 t/s | +| M1 Pro, 16 GB / [`2f95e67`](https://github.com/andreaborio/hebrus/commit/2f95e67fdec1db988fe8b1a699330f387de66004) | exact 259, 8,192 | DSBox API, 9 prompt + 2 output tokens | — | 0.30 t/s cold; 0.53 / 0.51 / 0.51 t/s warm (~0.52 t/s) | +| M1 Pro, 16 GB / [`bf4201c`](https://github.com/andreaborio/hebrus/commit/bf4201c47b901f0f479dc4af3f3df77330fabacf) | exact 259, 8,192 | extremely hot CLI, 14 + 2 tokens | 1.02–1.64 t/s | 2.13–2.46 t/s | | M5 Pro, 64 GB / `6aa496d` | AUTO 3,613, 32,768 | DSBox API, two sequential 22–23 prompt + 64 output-token requests | — | 9.88 / 12.86 t/s | -| M5 Pro, 64 GB / [`f4e0e64`](https://github.com/andreaborio/ds4/commit/f4e0e64e76ab62151700f9ea404297ea1769c550) | AUTO 4,387, 32,768 | `ds4-bench`, 128 + 64 tokens, ABBA legs A1/A2 | 21.63 / 22.21 t/s | 13.05 / 13.59 t/s (13.3173 geomean) | -| M5 Pro, 64 GB / [`f4e0e64`](https://github.com/andreaborio/ds4/commit/f4e0e64e76ab62151700f9ea404297ea1769c550) | exact 4,342, 32,768 | same bounded ABBA, legs B1/B2 | 22.22 / 22.13 t/s | 13.74 / 13.78 t/s (13.7600 geomean) | +| M5 Pro, 64 GB / [`f4e0e64`](https://github.com/andreaborio/hebrus/commit/f4e0e64e76ab62151700f9ea404297ea1769c550) | AUTO 4,387, 32,768 | `ds4-bench`, 128 + 64 tokens, ABBA legs A1/A2 | 21.63 / 22.21 t/s | 13.05 / 13.59 t/s (13.3173 geomean) | +| M5 Pro, 64 GB / [`f4e0e64`](https://github.com/andreaborio/hebrus/commit/f4e0e64e76ab62151700f9ea404297ea1769c550) | exact 4,342, 32,768 | same bounded ABBA, legs B1/B2 | 22.22 / 22.13 t/s | 13.74 / 13.78 t/s (13.7600 geomean) | The M5 exact 4,342 arm was 3.32% faster in decode than AUTO 4,387, with identical frontier logits and zero new swapout. The generic default remains @@ -359,7 +359,7 @@ a service-path observation, while the 4,387/4,342 rows are controlled `ds4-bench` comparisons. The M1 `2f95e67` server build was later reverted by -[`8a2a53f`](https://github.com/andreaborio/ds4/commit/8a2a53f323d29e5afd99010852f99019ef0cc8f4) +[`8a2a53f`](https://github.com/andreaborio/hebrus/commit/8a2a53f323d29e5afd99010852f99019ef0cc8f4) because its startup bridge could admit the cache under insufficient sustained headroom. The token loop and effective 259-entry cache in that bounded trace were unchanged, but the row is historical rather than a current-release diff --git a/docs/contracts/BRAND_COMPATIBILITY.md b/docs/contracts/BRAND_COMPATIBILITY.md index a5f449e3c..556af795a 100644 --- a/docs/contracts/BRAND_COMPATIBILITY.md +++ b/docs/contracts/BRAND_COMPATIBILITY.md @@ -88,11 +88,10 @@ compatibility, not permission to reset an absolute local path. ## Repository and application bridge -Until the administrative rename occurs, the engine repository remains -`andreaborio/ds4`. Bridge consumers accept both `andreaborio/ds4` and the -planned `andreaborio/hebrus` identity over HTTPS or SSH. The existing fork is -renamed in place; no history-less replacement is created and the old repository -name must not be reused. +The engine repository was renamed in place to `andreaborio/hebrus`. Bridge +consumers accept both the previous `andreaborio/ds4` identity and the canonical +identity over HTTPS or SSH. No history-less replacement was created, and the +old repository name must not be reused. The companion application's public name is **Hebrus Studio**. Its persisted DSBox identity remains a compatibility boundary for the bridge release: diff --git a/docs/guides/MIGRATING_TO_HEBRUS.md b/docs/guides/MIGRATING_TO_HEBRUS.md index 48e1a064d..a95ce66b4 100644 --- a/docs/guides/MIGRATING_TO_HEBRUS.md +++ b/docs/guides/MIGRATING_TO_HEBRUS.md @@ -79,9 +79,10 @@ cleanly before replacing an application bundle; do not delete `$HOME/.dsbox`. ## 2. Install the announced bridge revision -Use the immutable release tag or commit from the release announcement. Until a -release is announced, the public repository remains -[`andreaborio/ds4`](https://github.com/andreaborio/ds4). +Use the immutable release tag or commit from the release announcement. The +canonical public repository is +[`andreaborio/hebrus`](https://github.com/andreaborio/hebrus); the previous URL +continues to redirect for transport compatibility. For a user-local source installation: