@elarsaks/umap-wasm 0.4.0 → 0.4.2

package/README.md

@@ -14,6 +14,20 @@ npm install umap-wasm
 yarn add umap-wasm
 ```
 
+### Make the WASM artifacts available in the browser
+
+For browser builds the loader expects the compiled WASM bundle at `/wasm/pkg/web/umap_wasm_core.js` (and the accompanying `.wasm` binary) to be served as static assets. If your bundler does not automatically copy files from `node_modules`, add a `postinstall` script that copies only the web build into your public/static directory:
+
+```json
+{
+  "scripts": {
+    "postinstall": "mkdir -p public/wasm/pkg/web && cp -r node_modules/@elarsaks/umap-wasm/wasm/pkg/web/* public/wasm/pkg/web/"
+  }
+}
+```
+
+Adjust the destination (`public/wasm/pkg`) to match your framework's static assets folder (e.g., `static/` for SvelteKit, `public/` for Vite/Next). Node.js-only usage does not need this step.
+
 ## 🚀 Usage
 
 ### Basic Usage (Synchronous)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@elarsaks/umap-wasm",
-  "version": "0.4.0",
+  "version": "0.4.2",
   "description": "JavaScript implementation of UMAP",
   "author": {
     "name": "Elar Saks",

package/wasm/pkg/node/umap_wasm_core.d.ts

@@ -218,15 +218,11 @@ export function optimize_layout_batch(state: OptimizerState, rng_seed: bigint, n
 
 /**
  * Perform a single optimization step for UMAP layout.
- * 
- * This function executes one epoch of the stochastic gradient descent algorithm
- * used to optimize the low-dimensional embedding. It processes attractive forces
- * between known neighbors and repulsive forces from negative samples.
- * 
+ *
  * # Arguments
  * * `state` - Mutable reference to the optimizer state
  * * `rng_seed` - Seed for random number generation (will be updated internally)
- * 
+ *
  * # Returns
  * The updated embedding as a flat vector
  */

package/wasm/pkg/node/umap_wasm_core.js

@@ -301,7 +301,7 @@ class OptimizerState {
      * @returns {number}
      */
     get n_epochs() {
-        const ret = wasm.optimizerstate_n_epochs(this.__wbg_ptr);
+        const ret = wasm.flattree_dim(this.__wbg_ptr);
         return ret >>> 0;
     }
 }
@@ -661,10 +661,6 @@ exports.optimize_layout_batch = optimize_layout_batch;
 /**
  * Perform a single optimization step for UMAP layout.
  *
- * This function executes one epoch of the stochastic gradient descent algorithm
- * used to optimize the low-dimensional embedding. It processes attractive forces
- * between known neighbors and repulsive forces from negative samples.
- *
  * # Arguments
  * * `state` - Mutable reference to the optimizer state
  * * `rng_seed` - Seed for random number generation (will be updated internally)

package/wasm/pkg/node/umap_wasm_core_bg.wasm.d.ts

@@ -18,7 +18,6 @@ export const optimize_layout_batch: (a: number, b: bigint, c: number) => [number
 export const optimize_layout_step: (a: number, b: bigint) => [number, number];
 export const optimizerstate_current_epoch: (a: number) => number;
 export const optimizerstate_head_embedding: (a: number) => [number, number];
-export const optimizerstate_n_epochs: (a: number) => number;
 export const optimizerstate_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number) => number;
 export const search_flat_tree: (a: number, b: number, c: number, d: bigint) => [number, number];
 export const sparse_add: (a: number, b: number) => number;
@@ -45,6 +44,7 @@ export const wasmsparsematrix_new: (a: number, b: number, c: number, d: number,
 export const wasmsparsematrix_nnz: (a: number) => number;
 export const wasmsparsematrix_set: (a: number, b: number, c: number, d: number) => [number, number];
 export const wasmsparsematrix_to_array: (a: number) => any;
+export const optimizerstate_n_epochs: (a: number) => number;
 export const __wbindgen_externrefs: WebAssembly.Table;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/wasm/pkg/web/umap_wasm_core.d.ts

@@ -218,15 +218,11 @@ export function optimize_layout_batch(state: OptimizerState, rng_seed: bigint, n
 
 /**
  * Perform a single optimization step for UMAP layout.
- * 
- * This function executes one epoch of the stochastic gradient descent algorithm
- * used to optimize the low-dimensional embedding. It processes attractive forces
- * between known neighbors and repulsive forces from negative samples.
- * 
+ *
  * # Arguments
  * * `state` - Mutable reference to the optimizer state
  * * `rng_seed` - Seed for random number generation (will be updated internally)
- * 
+ *
  * # Returns
  * The updated embedding as a flat vector
  */
@@ -323,7 +319,6 @@ export interface InitOutput {
   readonly optimize_layout_step: (a: number, b: bigint) => [number, number];
   readonly optimizerstate_current_epoch: (a: number) => number;
   readonly optimizerstate_head_embedding: (a: number) => [number, number];
-  readonly optimizerstate_n_epochs: (a: number) => number;
   readonly optimizerstate_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number) => number;
   readonly search_flat_tree: (a: number, b: number, c: number, d: bigint) => [number, number];
   readonly sparse_add: (a: number, b: number) => number;
@@ -350,6 +345,7 @@ export interface InitOutput {
   readonly wasmsparsematrix_nnz: (a: number) => number;
   readonly wasmsparsematrix_set: (a: number, b: number, c: number, d: number) => [number, number];
   readonly wasmsparsematrix_to_array: (a: number) => any;
+  readonly optimizerstate_n_epochs: (a: number) => number;
   readonly __wbindgen_externrefs: WebAssembly.Table;
   readonly __wbindgen_malloc: (a: number, b: number) => number;
   readonly __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;

package/wasm/pkg/web/umap_wasm_core.js

@@ -306,7 +306,7 @@ export class OptimizerState {
      * @returns {number}
      */
     get n_epochs() {
-        const ret = wasm.optimizerstate_n_epochs(this.__wbg_ptr);
+        const ret = wasm.flattree_dim(this.__wbg_ptr);
         return ret >>> 0;
     }
 }
@@ -659,10 +659,6 @@ export function optimize_layout_batch(state, rng_seed, n_steps) {
 /**
  * Perform a single optimization step for UMAP layout.
  *
- * This function executes one epoch of the stochastic gradient descent algorithm
- * used to optimize the low-dimensional embedding. It processes attractive forces
- * between known neighbors and repulsive forces from negative samples.
- *
  * # Arguments
  * * `state` - Mutable reference to the optimizer state
  * * `rng_seed` - Seed for random number generation (will be updated internally)

package/wasm/pkg/web/umap_wasm_core_bg.wasm.d.ts

@@ -18,7 +18,6 @@ export const optimize_layout_batch: (a: number, b: bigint, c: number) => [number
 export const optimize_layout_step: (a: number, b: bigint) => [number, number];
 export const optimizerstate_current_epoch: (a: number) => number;
 export const optimizerstate_head_embedding: (a: number) => [number, number];
-export const optimizerstate_n_epochs: (a: number) => number;
 export const optimizerstate_new: (a: number, b: number, c: number, d: number, e: number, f: number, g: number, h: number, i: number, j: number, k: number, l: number, m: number, n: number, o: number, p: number, q: number, r: number, s: number, t: number) => number;
 export const search_flat_tree: (a: number, b: number, c: number, d: bigint) => [number, number];
 export const sparse_add: (a: number, b: number) => number;
@@ -45,6 +44,7 @@ export const wasmsparsematrix_new: (a: number, b: number, c: number, d: number,
 export const wasmsparsematrix_nnz: (a: number) => number;
 export const wasmsparsematrix_set: (a: number, b: number, c: number, d: number) => [number, number];
 export const wasmsparsematrix_to_array: (a: number) => any;
+export const optimizerstate_n_epochs: (a: number) => number;
 export const __wbindgen_externrefs: WebAssembly.Table;
 export const __wbindgen_malloc: (a: number, b: number) => number;
 export const __wbindgen_realloc: (a: number, b: number, c: number, d: number) => number;