@lloyal-labs/lloyal.node 1.0.3-alpha

package/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright 2025 lloyal.ai
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,356 @@
+# lloyal.node
+
+Node.js bindings for [liblloyal](https://github.com/lloyal-ai/liblloyal)—the inference kernel that orchestrates llama.cpp in-process for agentic inference patterns.
+
+## Installation
+
+```bash
+npm install lloyal.node
+```
+
+Prebuilt binaries for 13 platforms:
+
+| Platform | Arch  | Acceleration        |
+| -------- | ----- | ------------------- |
+| macOS    | arm64 | Metal               |
+| macOS    | x64   | CPU                 |
+| Linux    | x64   | CPU / CUDA / Vulkan |
+| Linux    | arm64 | CPU / CUDA / Vulkan |
+| Windows  | x64   | CPU / CUDA / Vulkan |
+| Windows  | arm64 | CPU / Vulkan        |
+
+Falls back to source build if your platform isn't covered.
+
+```bash
+LLOYAL_GPU=cuda npm install    # NVIDIA
+LLOYAL_GPU=vulkan npm install  # AMD/Intel
+LLOYAL_GPU=cpu npm install     # Force CPU
+```
+
+See [DISTRIBUTION.md](./docs/DISTRIBUTION.md) for package details.
+
+## Quick Start
+
+Complete example with greedy sampling:
+
+```typescript
+import { createContext } from 'lloyal.node';
+
+async function generate(prompt: string, maxTokens = 100): Promise<string> {
+  const ctx = await createContext({
+    modelPath: './model.gguf',
+    nCtx: 2048,
+    nThreads: 4,
+  });
+
+  try {
+    const tokens = await ctx.tokenize(prompt);
+    await ctx.decode(tokens, 0);
+
+    const output: number[] = [];
+    let pos = tokens.length;
+
+    for (let i = 0; i < maxTokens; i++) {
+      const token = ctx.greedySample();
+      if (token < 0) break; // EOS
+
+      output.push(token);
+      await ctx.decode([token], pos++);
+    }
+
+    return ctx.detokenize(output);
+  } finally {
+    ctx.dispose();
+  }
+}
+
+const response = await generate('The capital of France is');
+console.log(response);
+```
+
+## Test-Time Alignment
+
+TTA is token-level test-time alignment by exposing logits so TypeScript can apply stateful policies/constraints to the full next-token distribution before sampling—no retraining. Enabling fusion of application state with sampling strategy at every token step. Instead of generating text and validating after, you enforce constraints _during_ generation.
+
+This requires two things:
+
+1. **Raw logits** — the probability distribution over all possible next tokens
+2. **TypeScript sampling** — so your app logic can modify probabilities before selection
+
+lloyal.node provides the logits. [tsampler](https://github.com/lloyal-ai/tsampler) provides the sampling:
+
+```typescript
+import { createContext } from 'lloyal.node';
+import {
+  sampleWithStrategy,
+  computeModelEntropy,
+  TokenHistoryTracker,
+  SamplerWorkspace,
+  Xoroshiro128Plus,
+} from '@lloyal/tsampler';
+
+const ctx = await createContext({ modelPath: './model.gguf' });
+const prng = new Xoroshiro128Plus(42); // Deterministic PRNG
+const tokenHistory = new TokenHistoryTracker(64); // For repetition penalties
+const workspace = new SamplerWorkspace(256); // Pre-allocated, zero-alloc hot path
+
+const tokens = await ctx.tokenize(prompt);
+await ctx.decode(tokens, 0);
+
+let pos = tokens.length;
+const output: number[] = [];
+
+while (output.length < maxTokens) {
+  const logits = ctx.getLogits();
+
+  // === YOUR STEERING LOGIC HERE ===
+
+  // Enforce domain rules
+  if (currency === 'JPY') {
+    logits[DECIMAL_TOKEN] = -Infinity; // JPY has no decimal subdivision
+  }
+
+  // Adapt to model confidence
+  const entropy = computeModelEntropy(logits);
+  const params =
+    entropy < 2.0
+      ? { topK: 256, temperature: 1.5 } // Low confidence → explore more
+      : { topK: 40, temperature: 0.8 }; // High confidence → stay focused
+
+  // === END STEERING LOGIC ===
+
+  const token = sampleWithStrategy(logits, {
+    tokenHistory,
+    params,
+    workspace,
+    prng,
+  });
+
+  if (token < 0) break;
+
+  tokenHistory.accept(token);
+  output.push(token);
+  await ctx.decode([token], pos++);
+}
+```
+
+### Domain Constraints
+
+```typescript
+// Financial: JPY has no decimal subdivision
+if (currency === 'JPY' && parsingAmount) {
+  logits[DECIMAL_TOKEN] = -Infinity;
+  DIGIT_TOKENS.forEach((id) => (logits[id] += 2.0));
+}
+
+// Legal: Boost required terminology
+if (contractType === 'NDA') {
+  CONFIDENTIALITY_TOKENS.forEach((id) => (logits[id] += 5.0));
+}
+
+// Medical: Enforce terminology based on actual lab values
+if (glucoseLevel > normalMax) {
+  ELEVATED_TOKENS.forEach((id) => (logits[id] += 10.0));
+  NORMAL_TOKENS.forEach((id) => (logits[id] = -Infinity));
+}
+```
+
+### Quality Gates
+
+```typescript
+import { computeModelSurprisal, RollingPerplexity } from '@lloyal/tsampler';
+
+const ppl = new RollingPerplexity();
+
+while (generating) {
+  const logits = ctx.getLogits();
+  const token = sampleWithStrategy(logits, {
+    tokenHistory,
+    params,
+    workspace,
+    prng,
+  });
+
+  const surprisal = computeModelSurprisal(logits, token);
+  ppl.addSurprisal(surprisal);
+
+  if (ppl.ppl() > 50) {
+    // Generation quality degrading — options:
+    // 1. Trigger RAG retrieval for more context
+    // 2. Prune KV cache (evict stale context)
+    // 3. Early stop and retry with different prompt
+  }
+
+  // ...
+}
+```
+
+### Entropy-Adaptive Retrieval
+
+```typescript
+import { computeModelEntropy } from '@lloyal/tsampler';
+
+while (generating) {
+  const logits = ctx.getLogits();
+  const entropy = computeModelEntropy(logits);
+
+  if (entropy > 5.0) {
+    // Model is uncertain — retrieve relevant context
+    const context = await rag.retrieve(currentQuery);
+    await injectContext(ctx, context);
+    continue; // Re-evaluate with new context
+  }
+
+  const token = sampleWithStrategy(logits, {
+    tokenHistory,
+    params,
+    workspace,
+    prng,
+  });
+  // ...
+}
+```
+
+## Why TypeScript Sampling?
+
+|                         | Native C++   | TypeScript (tsampler) |
+| ----------------------- | ------------ | --------------------- |
+| Speed                   | ~0.3ms/token | ~3-5ms/token          |
+| Overhead vs 50ms decode | —            | ~6-10%                |
+| Logit steering          | ❌           | ✅                    |
+| Adaptive strategies     | ❌           | ✅                    |
+| OTA updates             | Rebuild app  | Ship new JS           |
+| Debugging               | printf       | Full inspect          |
+
+The overhead is imperceptible. A 50ms decode dominates; 3ms sampling is noise.
+
+### tsampler Capabilities
+
+[tsampler](https://github.com/lloyal-ai/tsampler) provides llama.cpp sampling parity in pure TypeScript:
+
+**Sampling methods:** greedy, top-k, top-p, min-p, typical-p, top-n-sigma, temperature, mirostat v1/v2
+
+**Penalties:** repetition, frequency, presence (exact llama.cpp formulas)
+
+**Infrastructure:**
+
+- `Xoroshiro128Plus` — deterministic PRNG, reproducible generations
+- `TokenHistoryTracker` — sliding window for penalty calculations
+- `SamplerWorkspace` — pre-allocated buffers, zero-alloc hot path
+- `computeModelEntropy()` — Shannon entropy in nats
+- `computeModelSurprisal()` — per-token surprisal
+- `RollingPerplexity` — streaming perplexity tracking
+
+### Native References
+
+lloyal.node includes native C++ implementations for validation:
+
+```typescript
+// TypeScript implementation
+const tsEntropy = computeModelEntropy(logits);
+
+// Native reference (C++)
+const nativeEntropy = ctx.computeEntropy();
+
+// Should match within float precision
+console.assert(Math.abs(tsEntropy - nativeEntropy) < 1e-5);
+```
+
+Available references:
+
+- `ctx.computeEntropy()` — Shannon entropy in nats
+- `ctx.greedySample()` — argmax token ID
+
+Build with confidence. Validate against native. Deploy TypeScript.
+
+## Embeddings
+
+lloyal.node supports embedding extraction with configurable pooling:
+
+```typescript
+import { createContext } from 'lloyal.node';
+
+const ctx = await createContext({
+  modelPath: './nomic-embed-text.gguf',
+  embeddings: true,
+  poolingType: 1, // 0=NONE, 1=MEAN, 2=CLS, 3=LAST
+});
+
+async function embed(text: string): Promise<Float32Array> {
+  const tokens = await ctx.tokenize(text);
+  await ctx.encode(tokens);
+
+  const embedding = ctx.getEmbeddings(true); // L2-normalized
+  await ctx.kvCacheClear(); // Reset for next text
+
+  return embedding;
+}
+
+const vec = await embed('Document to embed');
+console.log(`Dimension: ${ctx.getEmbeddingDimension()}`); // e.g., 768
+```
+
+## API Reference
+
+**📖 [Full API Documentation](https://lloyal-ai.github.io/lloyal.node)** - Complete reference with examples and type definitions
+
+### Context Creation
+
+```typescript
+const ctx = await createContext({
+  modelPath: string,       // Path to .gguf file (required)
+  nCtx?: number,           // Context size (default: 2048)
+  nThreads?: number,       // CPU threads (default: 4)
+  nGpuLayers?: number,     // Layers to offload to GPU (default: 0)
+  embeddings?: boolean,    // Enable embedding mode (default: false)
+  poolingType?: number     // 0=NONE, 1=MEAN, 2=CLS, 3=LAST (default: 0)
+});
+```
+
+### Inference
+
+| Method                     | Returns             | Description                                           |
+| -------------------------- | ------------------- | ----------------------------------------------------- |
+| `tokenize(text)`           | `Promise<number[]>` | Text → token IDs                                      |
+| `detokenize(tokens)`       | `Promise<string>`   | Token IDs → text                                      |
+| `decode(tokens, position)` | `Promise<void>`     | Forward pass, populates KV cache                      |
+| `getLogits()`              | `Float32Array`      | Vocabulary-sized probability distribution (zero-copy) |
+
+### Native References
+
+| Method             | Returns  | Description             |
+| ------------------ | -------- | ----------------------- |
+| `greedySample()`   | `number` | Argmax token ID         |
+| `computeEntropy()` | `number` | Shannon entropy in nats |
+
+### Embeddings
+
+| Method                      | Returns         | Description                                |
+| --------------------------- | --------------- | ------------------------------------------ |
+| `encode(tokens)`            | `Promise<void>` | Forward pass for embedding extraction      |
+| `getEmbeddings(normalize?)` | `Float32Array`  | Embedding vector, optionally L2-normalized |
+| `getEmbeddingDimension()`   | `number`        | Vector dimension                           |
+| `kvCacheClear()`            | `Promise<void>` | Clear KV cache between texts               |
+
+### Lifecycle
+
+| Method      | Description                                           |
+| ----------- | ----------------------------------------------------- |
+| `dispose()` | Free native resources. **Required** — call when done. |
+
+## LLoyal Ecosystem
+
+| Package                                                 | Language     | What it does                                                                                                                                                                                             |
+| ------------------------------------------------------- | ------------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [liblloyal](https://github.com/lloyal-ai/liblloyal)     | C++          | Inference kernel. Orchestrates llama.cpp with composable primitives: tokenization, decoding, KV cache, sampling chains, metrics, embeddings. Plus `branch.hpp` / `lease.hpp` for state forking and SMMA. |
+| **lloyal.node**                                         | N-API        | Node.js bindings. Zero-copy logits, native references for validation.                                                                                                                                    |
+| [tsampler](https://github.com/lloyal-ai/tsampler)       | TypeScript   | Sampling library with llama.cpp parity. All filters, penalties, entropy metrics. Plugin for lloyal.node—consumes logits, returns tokens.                                                                 |
+| [nitro-llama](https://github.com/lloyal-ai/nitro-llama) | React Native | Mobile bindings via Nitro Modules. Same liblloyal primitives on iOS/Android.                                                                                                                             |
+
+## Contributing
+
+See [CONTRIBUTING.md](./CONTRIBUTING.md) for development setup, build instructions, and release process.
+
+## License
+
+Apache 2.0 — See [LICENSE](./LICENSE) for details.