tenfingers commited on
Commit
b800099
·
verified ·
1 Parent(s): a519624

Wipe v0.11 artefacts ahead of v2.0 rebuild upload

Browse files
Files changed (3) hide show
  1. README.md +0 -121
  2. powershell-docs-bundled.rlat +0 -3
  3. powershell-docs.rlat +0 -3
README.md DELETED
@@ -1,121 +0,0 @@
1
- ---
2
- license: other
3
- language:
4
- - en
5
- pretty_name: "PowerShell Docs — rlat knowledge model"
6
- tags:
7
- - retrieval
8
- - knowledge-model
9
- - resonance-lattice
10
- - rlat
11
- - embeddings
12
- - powershell
13
- - windows
14
- - scripting
15
- - devops
16
- - automation
17
- size_categories:
18
- - 1M<n<10M
19
- ---
20
-
21
- # PowerShell Docs — rlat knowledge model
22
-
23
- Prebuilt [Resonance Lattice](https://github.com/tenfingerseddy/resonance-lattice-cli)
24
- knowledge model over **[MicrosoftDocs/PowerShell-Docs](https://github.com/MicrosoftDocs/PowerShell-Docs)**, built for
25
- retrieval-augmented coding assistants and LLM context injection.
26
-
27
- **Audience:** Windows admins, DevOps engineers, and developers scripting with PowerShell 5.1 or 7.x.
28
-
29
- ## Two variants — which do you want?
30
-
31
- | File | Size | When to pick |
32
- |------|------|------|
33
- | [`powershell-docs.rlat`](./powershell-docs.rlat) | 260 MB | **Remote** — knowledge model pins to a GitHub commit SHA. Source text is fetched from `https://github.com/MicrosoftDocs/PowerShell-Docs` on first query and cached locally. Freshest; smaller download. Needs network on first query. |
34
- | [`powershell-docs-bundled.rlat`](./powershell-docs-bundled.rlat) | 556 MB | **Bundled** — fully self-contained. Source text is packed inside the `.rlat` as zstd frames. Works offline forever. Larger download; no drift tracking. |
35
-
36
- **Pick bundled** if you care about reliability, offline use, or air-gapped environments.
37
- **Pick remote** if you want automatic freshness via `rlat freshness` / `rlat sync`, or if you plan to query from CI where cold-cache fetches are fine.
38
-
39
- Both variants serve **identical retrieval quality** — same field, same registry, same encoder (BGE-large-en-v1.5 with random projection heads, 5 bands × 2048 dim, 8-bit quantized registry, zstd compressed).
40
-
41
- ## Usage
42
-
43
- ```bash
44
- # Install the CLI (one-time)
45
- pip install resonance-lattice
46
-
47
- # Download one of the variants (pick bundled for zero-network queries):
48
- huggingface-cli download tenfingers/powershell-docs-rlat powershell-docs-bundled.rlat --local-dir .
49
-
50
- # Query:
51
- rlat search powershell-docs-bundled.rlat "how do I filter objects with Where-Object"
52
- rlat ask powershell-docs-bundled.rlat "how do I filter objects with Where-Object"
53
-
54
- # Use as Claude / Cursor / ChatGPT context:
55
- rlat resonate powershell-docs-bundled.rlat "how do I filter objects with Where-Object" --format context | pbcopy
56
- ```
57
-
58
- ## Sample queries
59
-
60
- - `how do I filter objects with Where-Object`
61
- - `convert JSON to a PowerShell object`
62
- - `write a function with pipeline input`
63
- - `sign a PowerShell script`
64
-
65
- ## Corpus provenance
66
-
67
- - **Upstream repo:** https://github.com/MicrosoftDocs/PowerShell-Docs
68
- - **Pinned commit SHA:** `4d079111904d56e4e9982ca283c66595e19519e3`
69
- - **Files indexed:** 2,719
70
- - **Chunks (semantic passages):** 17,369
71
- - **Encoder:** `BAAI/bge-large-en-v1.5` with 5 random projection heads (2048 dim × 5 bands)
72
- - **Registry compression:** 8-bit quantized (≈75% size reduction, ≥0.99 per-band cosine similarity vs fp32)
73
- - **Build flags:** `--quantize-registry 8 --compression zstd`
74
- - **Build date:** 2026-04-22
75
-
76
- ## Licensing
77
-
78
- ### Source content
79
-
80
- This knowledge model indexes (and in the **bundled** variant, redistributes) content from **[MicrosoftDocs/PowerShell-Docs](https://github.com/MicrosoftDocs/PowerShell-Docs)**.
81
-
82
- - **Copyright:** © Microsoft Corporation. All rights reserved.
83
- - **License:** [CC BY 4.0](https://creativecommons.org/licenses/by/4.0/) (for documentation content); code samples are licensed under the [MIT License](https://opensource.org/license/mit)
84
- - **Modifications:** Source files are chunked into retrieval-sized passages and indexed into a semantic field + registry. In the **bundled** variant, the source files themselves are packed unchanged as zstd frames inside the `.rlat` (lossless; re-chunking at query time produces the same bytes as the upstream file at the pinned SHA). In the **remote** variant, no source content is redistributed — queries fetch directly from the upstream repo on first access.
85
-
86
- 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.
87
-
88
- ### Artifact structure
89
-
90
- The knowledge-model *structure* — semantic field tensor, source registry, manifest, encoder configuration — is licensed under the [Business Source License 1.1](https://mariadb.com/bsl11/), the same license as the [Resonance Lattice project](https://github.com/tenfingerseddy/resonance-lattice-cli). Each release converts to MPL 2.0 four years after it's first published.
91
-
92
- BSL 1.1 applies to the *structure* of the knowledge model (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. See the [BSL 1.1 plain-language summary](https://github.com/tenfingerseddy/resonance-lattice-cli/blob/main/docs/LICENSE_FAQ.md).
93
-
94
- ### Trademark notice
95
-
96
- Microsoft Fabric, Power BI, PowerShell, SQL Server, Windows, Azure, and related product names are trademarks or registered trademarks of Microsoft Corporation in the United States and/or other countries. This project is not affiliated with, endorsed by, or sponsored by Microsoft Corporation.
97
-
98
- ## Keeping it fresh (remote variant only)
99
-
100
- ```bash
101
- # Read-only drift check — one GitHub API call
102
- rlat freshness powershell-docs.rlat
103
-
104
- # Pull upstream diff into the local knowledge model
105
- rlat sync powershell-docs.rlat
106
- ```
107
-
108
- `rlat sync` fetches only the files that changed between the pinned SHA and upstream HEAD, rechunks them, and reconciles against the existing registry. Cost is proportional to the diff, not the full corpus.
109
-
110
- ## Citation
111
-
112
- If you use this rlat in research, please cite:
113
-
114
- ```
115
- @misc{resonance-lattice-rlats-2026,
116
- title = {Resonance Lattice launch rlats},
117
- author = {Snyder, Kane},
118
- year = {2026},
119
- howpublished = {HuggingFace Hub, \url{https://huggingface.co/datasets/tenfingers/powershell-docs-rlat}}
120
- }
121
- ```
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
powershell-docs-bundled.rlat DELETED
@@ -1,3 +0,0 @@
1
- version https://git-lfs.github.com/spec/v1
2
- oid sha256:b9ecaba8cb66591e98b47495ce784bda9967011c6abced8ea62f0e402caae076
3
- size 582541065
 
 
 
 
powershell-docs.rlat DELETED
@@ -1,3 +0,0 @@
1
- version https://git-lfs.github.com/spec/v1
2
- oid sha256:dbbcc6db5616a7df7ba88f077869d04f42a451302e160f7d9a1eed42286da64f
3
- size 272568374