wasm-bhtsne 0.2.0 → 0.3.1

package/README.md

@@ -19,18 +19,23 @@ npm i wasm-bhtsne
 ### Example
 
 ```javascript
-import {tSNE} from "wasm-bhtsne";
+import { tSNE } from "wasm-bhtsne";
 
-const data = [];
-
-for (let i = 0; i < 300; i++) {
-    const randomNumber = Math.random();
-    data.push(randomNumber);
+function createRandomMatrix(rows, columns) {
+    return Array.from({ length: rows }, () =>
+        Array.from({ length: columns }, () => Math.random())
+    );
 }
 
-const tsne_encoder = new tSNE(data, 4);
-tsne_encoder.exact();
-const embedded_stuff = tsne_encoder.embedding();
+// create random points and dimensions
+const data = createRandomMatrix(5000, 512);
+
+const tsne_encoder = new tSNE(data);
+
+let compressed_vectors = []
+
+// as argument the number of epochs,
+compressed_vectors = tsne_encoder.barnes_hut(1000);
 
-console.log(embedded_stuff);
+console.log("Compressed Vectors:", compressed_vectors);
 ```

package/package.json

@@ -4,7 +4,7 @@
     "lv291 <baiunco291@proton.me>"
   ],
   "description": "Exact and Barnes-Hut implementations of t-SNE in wasm",
-  "version": "0.2.0",
+  "version": "0.3.1",
   "license": "MIT",
   "repository": {
     "type": "git",

package/wasm_bhtsne.d.ts

@@ -11,20 +11,6 @@ export class tSNE {
 */
   constructor(vectors: Array<any>);
 /**
-* Performs a parallel exact version of the t-SNE algorithm. Pairwise distances between samples
-* in the input space will be computed accordingly to the supplied function `distance_f`.
-*
-* # Arguments
-*
-* `distance_f` - distance function.
-*
-* **Do note** that such a distance function needs not to be a metric distance, i.e. it is not
-* necessary for it so satisfy the triangle inequality. Consequently, the squared euclidean
-* distance, and many other, can be used.
-* @returns {Array<any>}
-*/
-  exact(): Array<any>;
-/**
 * Performs a parallel Barnes-Hut approximation of the t-SNE algorithm.
 *
 * # Arguments
@@ -40,10 +26,10 @@ export class tSNE {
 *
 * **Do note that** `metric_f` **must be a metric distance**, i.e. it must
 * satisfy the [triangle inequality](https://en.wikipedia.org/wiki/Triangle_inequality).
-* @param {number} theta
+* @param {number} epochs
 * @returns {Array<any>}
 */
-  barnes_hut(theta: number): Array<any>;
+  barnes_hut(epochs: number): Array<any>;
 /**
 * Returns the computed embedding.
 * @returns {Array<any>}
@@ -58,14 +44,6 @@ export class tSNE {
 */
   embedding_dim: number;
 /**
-* Sets new epochs, i.e the maximum number of fitting iterations.
-*
-* # Arguments
-*
-* `epochs` - new value for the epochs.
-*/
-  epochs: number;
-/**
 * Sets a new final momentum.
 *
 * # Arguments
@@ -120,4 +98,7 @@ export class tSNE {
 * `stop_lying_epoch` - new value for the stop lying epoch.
 */
   stop_lying_epoch: number;
+/**
+*/
+  theta: number;
 }

package/wasm_bhtsne_bg.js

@@ -237,23 +237,6 @@ export class tSNE {
         return tSNE.__wrap(ret);
     }
     /**
-    * Performs a parallel exact version of the t-SNE algorithm. Pairwise distances between samples
-    * in the input space will be computed accordingly to the supplied function `distance_f`.
-    *
-    * # Arguments
-    *
-    * `distance_f` - distance function.
-    *
-    * **Do note** that such a distance function needs not to be a metric distance, i.e. it is not
-    * necessary for it so satisfy the triangle inequality. Consequently, the squared euclidean
-    * distance, and many other, can be used.
-    * @returns {Array<any>}
-    */
-    exact() {
-        const ret = wasm.tsne_exact(this.__wbg_ptr);
-        return takeObject(ret);
-    }
-    /**
     * Performs a parallel Barnes-Hut approximation of the t-SNE algorithm.
     *
     * # Arguments
@@ -269,11 +252,11 @@ export class tSNE {
     *
     * **Do note that** `metric_f` **must be a metric distance**, i.e. it must
     * satisfy the [triangle inequality](https://en.wikipedia.org/wiki/Triangle_inequality).
-    * @param {number} theta
+    * @param {number} epochs
     * @returns {Array<any>}
     */
-    barnes_hut(theta) {
-        const ret = wasm.tsne_barnes_hut(this.__wbg_ptr, theta);
+    barnes_hut(epochs) {
+        const ret = wasm.tsne_barnes_hut(this.__wbg_ptr, epochs);
         return takeObject(ret);
     }
     /**
@@ -288,15 +271,10 @@ export class tSNE {
         wasm.tsne_set_learning_rate(this.__wbg_ptr, learning_rate);
     }
     /**
-    * Sets new epochs, i.e the maximum number of fitting iterations.
-    *
-    * # Arguments
-    *
-    * `epochs` - new value for the epochs.
-    * @param {number} epochs
+    * @param {number} theta
     */
-    set epochs(epochs) {
-        wasm.tsne_set_epochs(this.__wbg_ptr, epochs);
+    set theta(theta) {
+        wasm.tsne_set_theta(this.__wbg_ptr, theta);
     }
     /**
     * Sets a new momentum.