wasm-bhtsne 0.1.2 → 0.1.4

package/README.md

@@ -11,21 +11,13 @@ This is the wasm version of the [bhtsne](https://github.com/frjnn/bhtsne) crate.
 Parallel implementations of Barnes-Hut and exact implementations of the t-SNE algorithm written in Rust to run in wasm. The tree-accelerated version of the algorithm is described with fine detail in [this paper](http://lvdmaaten.github.io/publications/papers/JMLR_2014.pdf) by [Laurens van der Maaten](https://github.com/lvdmaaten). The exact, original, version of the algorithm is described in [this other paper](https://www.jmlr.org/papers/volume9/vandermaaten08a/vandermaaten08a.pdf) by [G. Hinton](https://www.cs.toronto.edu/~hinton/) and Laurens van der Maaten.
 Additional implementations of the algorithm, are listed at [this page](http://lvdmaaten.github.io/tsne/).
 
-## Installation 
-
-Add this line to your `Cargo.toml`:
-```toml
-[dependencies]
-bhtsne = "0.5.2"
+## Installation
+```shell
+npm i wasm-bhtsne
 ```
-### Documentation
-
-The API documentation is available [here](https://docs.rs/bhtsne).
 
 ### Example
 
-The implementation supports custom data types and custom defined metrics. For instance, general vector data can be handled in the following way.
-
 ```javascript
 import {tSNE} from "wasm-bhtsne";
 
@@ -41,14 +33,4 @@ tsne_encoder.exact();
 const embedded_stuff = tsne_encoder.embedding();
 
 console.log(embedded_stuff);
-```
-
-In the example euclidean distance is used, but any other distance metric on data types of choice, such as strings, can be defined and plugged in. 
-
-## Parallelism 
-Being built on [rayon](https://github.com/rayon-rs/rayon), the algorithm uses the same number of threads as the number of CPUs available. Do note that on systems with hyperthreading enabled this equals the number of logical cores and not the physical ones. See [rayon's FAQs](https://github.com/rayon-rs/rayon/blob/master/FAQ.md) for additional informations.
-
-## MNIST embedding
-The following embedding has been obtained by preprocessing the [MNIST](https://git-disl.github.io/GTDLBench/datasets/mnist_datasets/) train set using PCA to reduce its 
-dimensionality to 50. It took approximately **3 minutes and 6 seconds** on a 2.0GHz quad-core 10th-generation i5 MacBook Pro. 
-![mnist](imgs/mnist_embedding.png) 
+```

package/package.json

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

package/wasm_bhtsne.d.ts

@@ -30,6 +30,25 @@ export class tSNE {
 */
   exact(): void;
 /**
+* Performs a parallel Barnes-Hut approximation of the t-SNE algorithm.
+*
+* # Arguments
+*
+* * `theta` - determines the accuracy of the approximation. Must be **strictly greater than
+* 0.0**. Large values for θ increase the speed of the algorithm but decrease its accuracy.
+* For small values of θ it is less probable that a cell in the space partitioning tree will
+* be treated as a single point. For θ equal to 0.0 the method degenerates in the exact
+* version.
+*
+* * `metric_f` - metric function.
+*
+*
+* **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
+*/
+  barnes_hut(theta: number): void;
+/**
 * Sets a new value for the embedding dimension.
 *
 * # Arguments

package/wasm_bhtsne_bg.js

@@ -309,6 +309,27 @@ export class tSNE {
     exact() {
         wasm.tsne_exact(this.__wbg_ptr);
     }
+    /**
+    * Performs a parallel Barnes-Hut approximation of the t-SNE algorithm.
+    *
+    * # Arguments
+    *
+    * * `theta` - determines the accuracy of the approximation. Must be **strictly greater than
+    * 0.0**. Large values for θ increase the speed of the algorithm but decrease its accuracy.
+    * For small values of θ it is less probable that a cell in the space partitioning tree will
+    * be treated as a single point. For θ equal to 0.0 the method degenerates in the exact
+    * version.
+    *
+    * * `metric_f` - metric function.
+    *
+    *
+    * **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
+    */
+    barnes_hut(theta) {
+        wasm.tsne_barnes_hut(this.__wbg_ptr, theta);
+    }
 }
 
 export function __wbg_new_abda76e883ba8a5f() {