# Sipp Browser Package

`lib/web` is the browser package source for the public `@sipphq/sipp` package. It
supports browser-local GGUF inference, gateway calls, streaming text, and an
OPFS-backed model store, with browser runtime lifecycle management through
`SippClient`.

Source builds use the workspace manifest in this directory. Public docs use the
`@sipphq/sipp` package target.

## Source Checkout

From the repository root, after `source ./setup.sh`:

```bash
sipp build wasm && sipp run examples serve browser
```

`sipp` forwards to `cargo xtask`; use `cargo xtask ...` with the same arguments
if the launcher is not active.

## Local GGUF Query

```ts
import { EndpointDescriptor, SippClient } from '@sipphq/sipp';

const client = new SippClient();
const model = await client.models.add(['/models/model.gguf']);
await client.add(
  'default',
  EndpointDescriptor.local(model.id, {
    runtime: {
      context: { n_ctx: 2048 },
      scheduler: { continuous_batching: true, prefill_chunk_size: 0 },
      cache: { mode: 'live_slot_prefix' },
      observability: { runtime_metrics: true },
    },
  })
);

const run = client.query('Explain Sipp in one sentence.', {
  emitTokens: true,
  maxTokens: 64,
  contextKey: 'web-local',
});

let streamed = '';
for await (const batch of run.tokens) {
  streamed += batch.text;
}
const response = await run.response;
console.log(streamed || response.text);
await client.close();
```

## WebGPU Engine

The browser runtime links the Rust WASM ABI with llama.cpp and ggml through
Emscripten. It runs GGUF text and vision models with WebGPU on compatible
browsers, falls back to CPU execution for compatible local workflows, and
keeps models in OPFS after the first URL fetch or `File` import so later loads
can reuse the returned model ID.

<!--
Future benchmark graph placeholder:
- Sipp browser WebGPU engine
- transformers.js WebGPU
- WebLLM WebGPU
Add the graph only with checked-in benchmark methodology, model names, browser
versions, hardware, and raw measurements.
-->

Gateway clients use the same endpoint API. Browser applications provide
short-lived gateway tokens at runtime.

## Learn More

- [Browser package docs](../../docs/en/packages/browser.md)
- [Browser caching](../../docs/en/guides/browser-caching.md)
- [Gateway and hybrid inference](../../docs/en/guides/gateway-hybrid.md)
- [Web examples](../../examples/web/README.md)