wickra-genome-wasm
v0.1.4
Published
WebAssembly bindings for wickra-genome — the market vector database in the browser.
Readme
Wickra Genome — WASM
Part of the Wickra ecosystem: — for WASM. npm install wickra-genome-wasm — pure WebAssembly, runs anywhere a modern JS engine does.
WebAssembly bindings for the Wickra Genome vector engine, compiled from Rust with
wasm-bindgen. A Genome is built
from a spec JSON and driven by command JSONs over a JSON boundary, so a browser
front-end runs against the exact same core as every other Wickra Genome binding.
Install
npm install wickra-genome-wasmBuilding from this repository (contributors)
wasm-pack build --target web # for a browser bundler
wasm-pack build --target nodejs # for node:test / Node.jsThe output lands in pkg/.
Quick start
import init, { Genome } from "wickra-genome-wasm";
await init();
const spec = JSON.stringify({
features: [{ kind: "price", field: "close" }],
symbols: ["AAA", "BBB", "CCC"],
normalize: "z_score",
metric: "euclid",
seed: 24333,
});
const g = new Genome(spec);
const data = {
AAA: [{ time: 0, open: 1, high: 1, low: 1, close: 1, volume: 0 }],
BBB: [{ time: 0, open: 2, high: 2, low: 2, close: 2, volume: 0 }],
CCC: [{ time: 0, open: 100, high: 100, low: 100, close: 100, volume: 0 }],
};
g.command(JSON.stringify({ cmd: "build", data }));
console.log(g.command(JSON.stringify({ cmd: "similar", symbol: "AAA", k: 2 })));The engine runs single-threaded in the browser, and because every cross-section reduction runs serially in key order, the result is byte-identical to the native parallel run — the exact cross-language golden check.
Benchmark
Every binding forwards to the same data-driven Rust core, so what this one adds is
the call overhead of wasm-bindgen, not a different result. The core's throughput is
measured by the repository's benchmark suite and the nightly bench.yml run; the
numbers, the machine and how to reproduce them are in the repository
BENCHMARKS.md.
Documentation
The full guide, the spec reference and the API documentation live in the main repository and the documentation site:
- Repository: https://github.com/wickra-lib/wickra-genome
- Docs (guides, spec reference, cookbook): https://genome.wickra.org
- Runnable example:
examples/wasm/
Wickra Genome ships native bindings for Python, Node.js, WASM and Rust, plus a C ABI hub that any
C-capable language (C, C++, C#, Go, Java, R) links against — all forwarding to the
same data-driven, unsafe-forbidden Rust core.
Security
Found a security issue? Please don't open a public issue. Report it privately
via the repository's Security tab ("Report a vulnerability") or email
[email protected] with a subject line starting [wickra security]. Full
policy: https://github.com/wickra-lib/wickra-genome/blob/main/SECURITY.md.
Disclaimer
Wickra Genome is research and analytics software. Its similarity, clustering and anomaly outputs are not investment advice, and nothing here is a recommendation to trade. Use at your own risk.
License
Licensed under either of Apache-2.0 or MIT at your option.
