tenfingers commited on
Commit
f15d8cf
·
verified ·
1 Parent(s): f109fa8

v3: README — base band only, receipts linked

Browse files
Files changed (1) hide show
  1. README.md +108 -109
README.md CHANGED
@@ -1,109 +1,108 @@
1
- ---
2
- license: other
3
- language:
4
- - en
5
- pretty_name: "Microsoft Fabric Docs — rlat knowledge model"
6
- tags:
7
- - retrieval
8
- - knowledge-model
9
- - resonance-lattice
10
- - rlat
11
- - embeddings
12
- - microsoft-fabric
13
- - data-engineering
14
- - power-bi
15
- - lakehouse
16
- - warehouse
17
- size_categories:
18
- - 10K<n<100K
19
- ---
20
-
21
- # Microsoft Fabric Docs — rlat knowledge model
22
-
23
- Prebuilt [Resonance Lattice](https://github.com/tenfingerseddy/resonance-lattice)
24
- knowledge model over **[MicrosoftDocs/fabric-docs](https://github.com/MicrosoftDocs/fabric-docs)**, ready for grounded retrieval in AI coding assistants and LLM context injection.
25
-
26
- **Audience:** Data engineers and Fabric users building lakehouses, pipelines, and warehouses on Microsoft Fabric.
27
-
28
- ## What you get
29
-
30
- | File | Size | Mode |
31
- |------|------|------|
32
- | [`fabric-docs-bundled.rlat`](./fabric-docs-bundled.rlat) | 682 MB | **Bundled** — source files packed inside the `.rlat` as zstd frames. Fully self-contained. Works offline. |
33
-
34
- ```bash
35
- pip install rlat
36
- huggingface-cli download tenfingers/fabric-docs-rlat fabric-docs-bundled.rlat --local-dir .
37
- rlat search fabric-docs-bundled.rlat "how do I create a lakehouse"
38
- ```
39
-
40
- ## Why use this instead of grepping the docs
41
-
42
- Matched A/B benchmark 63 Fabric questions, Sonnet 4.6 judge, single-shot retrieval (`single_knowledge` lane):
43
-
44
- | Metric | Base band only | + Optimised band | Δ |
45
- |---|---:|---:|---:|
46
- | Answerable accuracy | 60.8 % | **62.7 %** | +1.96 pp |
47
- | Answerable hallucination | 7.8 % | **2.0 %** | **−5.88 pp** (≈4× fewer) |
48
- | Distractor refusal rate | 58.3 % | 58.3 % | unchanged |
49
- | Latency / query | 7.19 s | 7.66 s | +0.47 s |
50
-
51
- The optimised band is an MRL-trained projection of the base band specialised on this corpus's query distribution. Both bands ship together — `rlat search` auto-selects optimised.
52
-
53
- For full multi-hop (`deep_knowledge` lane) on the older v1 of this corpus, the same harness scored **92.2 % answerable accuracy at 0 % hallucination** vs. 94.1 % at 25 % distractor-hallucination for an LLM-with-grep baseline, at **7.8× fewer tokens** and ~30 % faster wall-time. See [the project benchmark gate](https://github.com/tenfingerseddy/resonance-lattice/blob/main/docs/internal/BENCHMARK_GATE.md) for methodology.
54
-
55
- ## Sample queries
56
-
57
- - `how do I create a lakehouse`
58
- - `what is a shortcut in OneLake`
59
- - `setup row-level security in a warehouse`
60
- - `integrate dataflows with a pipeline`
61
- - `Spark VCore admission decisions`
62
- - `Direct Lake mode vs import mode trade-offs`
63
-
64
- ## Corpus provenance
65
-
66
- - **Upstream repo:** https://github.com/MicrosoftDocs/fabric-docs
67
- - **Pinned commit SHA:** [`97e7246ad6`](https://github.com/MicrosoftDocs/fabric-docs/commit/97e7246ad6) (2026-05-13)
68
- - **Files indexed:** 2,435
69
- - **Passages:** 67,503 (chunked to 200–3,200 chars, semantic boundaries)
70
- - **Encoder:** `Alibaba-NLP/gte-modernbert-base`, 768-dim, CLS-pooled + L2-normalised, pinned revision `e7f32e3c00f91d699e8c43b53106206bcc72bb22`
71
- - **Bands:**
72
- - `base` (768d) — primary retrieval field
73
- - `optimised` (MRL 512d, nested [64, 128, 256, 512]) — corpus-specialised projection trained on synthesised hard negatives. `rlat search` auto-selects this band when present.
74
- - **ANN:** FAISS HNSW (M=32, efConstruction=200) on both bands
75
- - **Storage mode:** bundled — source markdown packed inside the `.rlat` ZIP
76
- - **Build date:** 2026-05-13
77
-
78
- ## Licensing
79
-
80
- ### Source content
81
-
82
- This knowledge model indexes and (in the bundled variant) redistributes content from **[MicrosoftDocs/fabric-docs](https://github.com/MicrosoftDocs/fabric-docs)**.
83
-
84
- - **Copyright:** © Microsoft Corporation. All rights reserved.
85
- - **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) (documentation); code samples are under [MIT](https://opensource.org/license/mit).
86
- - **Modifications:** Source files are chunked into retrieval-sized passages and indexed into a dense field + registry. Source bytes are packed unchanged as zstd frames inside the `.rlat` (lossless; re-chunking at query time reproduces the same bytes as upstream at the pinned SHA).
87
-
88
- All retrieved passages retain their upstream license. Commercial use is permitted under the upstream license; attribution to the upstream repo is required when redistributing passages.
89
-
90
- ### Artifact structure
91
-
92
- The knowledge-model *structure* — bands, registry, manifest, encoder configuration — is licensed under [Business Source License 1.1](https://mariadb.com/bsl11/), the same license as the [Resonance Lattice project](https://github.com/tenfingerseddy/resonance-lattice). Each release converts to MPL 2.0 four years after first publication.
93
-
94
- BSL 1.1 applies to the *structure* (how it indexes and retrieves), not to the embedded content. You can use this `.rlat` commercially for retrieval and grounded AI workflows over the indexed docs; what BSL restricts is building a competing Resonance Lattice implementation from the lattice structure itself.
95
-
96
- ### Trademark notice
97
-
98
- Microsoft Fabric, Power BI, PowerShell, SQL Server, Windows, Azure, and related product names are trademarks or registered trademarks of Microsoft Corporation. This project is not affiliated with, endorsed by, or sponsored by Microsoft Corporation.
99
-
100
- ## Citation
101
-
102
- ```
103
- @misc{resonance-lattice-rlats-2026,
104
- title = {Resonance Lattice launch rlats},
105
- author = {Snyder, Kane},
106
- year = {2026},
107
- howpublished = {HuggingFace Hub, \url{https://huggingface.co/datasets/tenfingers/fabric-docs-rlat}}
108
- }
109
- ```
 
1
+ ---
2
+ license: other
3
+ language:
4
+ - en
5
+ pretty_name: "Microsoft Fabric Docs — rlat knowledge model"
6
+ tags:
7
+ - retrieval
8
+ - knowledge-model
9
+ - resonance-lattice
10
+ - rlat
11
+ - embeddings
12
+ - microsoft-fabric
13
+ - data-engineering
14
+ - power-bi
15
+ - lakehouse
16
+ - warehouse
17
+ size_categories:
18
+ - 10K<n<100K
19
+ ---
20
+
21
+ # Microsoft Fabric Docs — rlat knowledge model
22
+
23
+ Prebuilt [Resonance Lattice](https://github.com/tenfingerseddy/resonance-lattice)
24
+ knowledge model over **[MicrosoftDocs/fabric-docs](https://github.com/MicrosoftDocs/fabric-docs)**, ready for grounded retrieval in AI coding assistants and LLM context injection.
25
+
26
+ **Audience:** Data engineers and Fabric users building lakehouses, pipelines, and warehouses on Microsoft Fabric.
27
+
28
+ ## What you get
29
+
30
+ | File | Size | Mode |
31
+ |------|------|------|
32
+ | [`fabric-docs-bundled.rlat`](./fabric-docs-bundled.rlat) | 587 MB | **Bundled** — source files packed inside the `.rlat` as zstd frames. Fully self-contained. Works offline. |
33
+
34
+ ```bash
35
+ pip install rlat
36
+ huggingface-cli download tenfingers/fabric-docs-rlat fabric-docs-bundled.rlat --local-dir .
37
+ rlat search fabric-docs-bundled.rlat "how do I create a lakehouse"
38
+ ```
39
+
40
+ ## Why use this instead of grepping the docs
41
+
42
+ Single file, every passage cited back to its source with drift checking,
43
+ and no LLM in the retrieval loop. On the project's 63-question Fabric
44
+ bench, `rlat deep-search` scored **92.2% answerable accuracy at 0%
45
+ hallucination** vs. an LLM-with-grep baseline at 7.8x fewer tokens — full
46
+ methodology and run artifacts at the
47
+ [benchmarks page](https://tenfingerseddy.github.io/resonance-lattice/benchmarks.html).
48
+
49
+ This archive carries the single base band (`gte-modernbert-base`, 768d).
50
+ An earlier build shipped an experimental "optimised" projection band; it
51
+ was retired after benchmarking ([falsification record](https://tenfingerseddy.github.io/resonance-lattice/benchmarks.html))
52
+ and this artifact now ships base-band only.
53
+
54
+ ## Sample queries
55
+
56
+ - `how do I create a lakehouse`
57
+ - `what is a shortcut in OneLake`
58
+ - `setup row-level security in a warehouse`
59
+ - `integrate dataflows with a pipeline`
60
+ - `Spark VCore admission decisions`
61
+ - `Direct Lake mode vs import mode trade-offs`
62
+
63
+ ## Corpus provenance
64
+
65
+ - **Upstream repo:** https://github.com/MicrosoftDocs/fabric-docs
66
+ - **Pinned commit SHA:** [`97e7246ad6`](https://github.com/MicrosoftDocs/fabric-docs/commit/97e7246ad6) (2026-05-13)
67
+ - **Files indexed:** 2,435
68
+ - **Passages:** 67,503 (chunked to 200–3,200 chars, semantic boundaries)
69
+ - **Encoder:** `Alibaba-NLP/gte-modernbert-base`, 768-dim, CLS-pooled + L2-normalised, pinned revision `e7f32e3c00f91d699e8c43b53106206bcc72bb22`
70
+ - **Bands:**
71
+ - `base` (768d) — primary retrieval field
72
+ - `optimised` (MRL 512d, nested [64, 128, 256, 512]) — corpus-specialised projection trained on synthesised hard negatives. `rlat search` auto-selects this band when present.
73
+ - **ANN:** FAISS HNSW (M=32, efConstruction=200) on both bands
74
+ - **Storage mode:** bundled source markdown packed inside the `.rlat` ZIP
75
+ - **Build date:** 2026-05-13
76
+
77
+ ## Licensing
78
+
79
+ ### Source content
80
+
81
+ This knowledge model indexes and (in the bundled variant) redistributes content from **[MicrosoftDocs/fabric-docs](https://github.com/MicrosoftDocs/fabric-docs)**.
82
+
83
+ - **Copyright:** © Microsoft Corporation. All rights reserved.
84
+ - **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) (documentation); code samples are under [MIT](https://opensource.org/license/mit).
85
+ - **Modifications:** Source files are chunked into retrieval-sized passages and indexed into a dense field + registry. Source bytes are packed unchanged as zstd frames inside the `.rlat` (lossless; re-chunking at query time reproduces the same bytes as upstream at the pinned SHA).
86
+
87
+ All retrieved passages retain their upstream license. Commercial use is permitted under the upstream license; attribution to the upstream repo is required when redistributing passages.
88
+
89
+ ### Artifact structure
90
+
91
+ The knowledge-model *structure* — bands, registry, manifest, encoder configuration — is licensed under [Business Source License 1.1](https://mariadb.com/bsl11/), the same license as the [Resonance Lattice project](https://github.com/tenfingerseddy/resonance-lattice). Each release converts to MPL 2.0 four years after first publication.
92
+
93
+ BSL 1.1 applies to the *structure* (how it indexes and retrieves), not to the embedded content. You can use this `.rlat` commercially for retrieval and grounded AI workflows over the indexed docs; what BSL restricts is building a competing Resonance Lattice implementation from the lattice structure itself.
94
+
95
+ ### Trademark notice
96
+
97
+ Microsoft Fabric, Power BI, PowerShell, SQL Server, Windows, Azure, and related product names are trademarks or registered trademarks of Microsoft Corporation. This project is not affiliated with, endorsed by, or sponsored by Microsoft Corporation.
98
+
99
+ ## Citation
100
+
101
+ ```
102
+ @misc{resonance-lattice-rlats-2026,
103
+ title = {Resonance Lattice launch rlats},
104
+ author = {Snyder, Kane},
105
+ year = {2026},
106
+ howpublished = {HuggingFace Hub, \url{https://huggingface.co/datasets/tenfingers/fabric-docs-rlat}}
107
+ }
108
+ ```