umap-js - npm Package Compare versions

Comparing version 1.0.0 to 1.0.1

package.json

 {
   "name": "umap-js",
-  "version": "1.0.0",
+  "version": "1.0.1",
   "description": "JavaScript implementation of UMAP",
@@ -5,0 +5,0 @@ "author": {

README.md

@@ -16,2 +16,8 @@ # UMAP-JS
 
+#### Installation
+
+```sh
+yarn add umap-js
+```
+
 #### Synchronous fitting
@@ -50,3 +56,3 @@
 
-The UMAP constructor can accept a number of parameters:
+The UMAP constructor can accept a number of parameters via a `UMAPParameters` object:
 
@@ -60,2 +66,10 @@ | Parameter     | Description                                                           | default                  |
 
+```typescript
+const umap = new UMAP({
+  nComponents: 2,
+  nEpochs: 400,
+  nNeighbors: 15,
+});
+```
+
 ### Testing
@@ -62,0 +76,0 @@

src/index.ts

@@ -1,1 +0,1 @@
-export { UMAP } from './umap';
+export { UMAP, UMAPParameters } from './umap';

No alert changes

Improved metrics

Total package byte prevSize

305299

increased by0.06%

Number of lines in readme file

81

increased by20.9%

No dependency changes