catniff 0.2.6 → 0.2.8

package/README.md

@@ -39,8 +39,6 @@ const B = new Tensor(3);
 console.log(A.add(B).val());
 ```
 
-All available APIs are in `./src/core.ts`.
-
 ## Autograd
 
 To compute the gradient wrt multiple variables of our mathematical expression, we can simply set `requiresGrad` to `true`:
@@ -74,11 +72,11 @@ G.backward();
 console.log(X.grad.val(), Y.grad.val());
 ```
 
-All available APIs are in `./src/core.ts`.
-
 ## Documentation
 
-Todo :/
+Full documentation is available in [`./docs/documentation.md`](./docs/documentation.md).
+
+All available APIs are in [`./src/core.ts`](./src/core.ts) if you want to dig deeper.
 
 ## Todos
 

package/dist/core.d.ts

@@ -91,7 +91,9 @@ export declare class Tensor {
     mv(other: TensorValue | Tensor): Tensor;
     matmul(other: TensorValue | Tensor): Tensor;
     static fullLike(tensor: Tensor, num: number, options?: TensorOptions): Tensor;
+    static onesLike(tensor: Tensor, options?: TensorOptions): Tensor;
+    static zerosLike(tensor: Tensor, options?: TensorOptions): Tensor;
     backward(): void;
-    val(): any;
+    val(): TensorValue;
     withGrad(requiresGrad: boolean): Tensor;
 }

package/dist/core.js

@@ -872,6 +872,18 @@ class Tensor {
             return new Tensor(num, options);
         return new Tensor(new Array(tensor.value.length).fill(num), { shape: tensor.shape, strides: tensor.strides, ...options });
     }
+    // Utility to create a new tensor with shape of another tensor, filled with 1
+    static onesLike(tensor, options = {}) {
+        if (typeof tensor.value === "number")
+            return new Tensor(1, options);
+        return new Tensor(new Array(tensor.value.length).fill(1), { shape: tensor.shape, strides: tensor.strides, ...options });
+    }
+    // Utility to create a new tensor with shape of another tensor, filled with 0
+    static zerosLike(tensor, options = {}) {
+        if (typeof tensor.value === "number")
+            return new Tensor(0, options);
+        return new Tensor(new Array(tensor.value.length).fill(0), { shape: tensor.shape, strides: tensor.strides, ...options });
+    }
     // Reverse-mode autodiff call
     backward() {
         // Build topological order
@@ -880,7 +892,7 @@ class Tensor {
         function build(node) {
             if (!visited.has(node) && node.requiresGrad) {
                 visited.add(node);
-                node.grad = Tensor.fullLike(node, 0); // Reset grad with 0
+                node.grad = Tensor.zerosLike(node); // Reset grad with 0
                 for (let child of node.children)
                     build(child);
                 topo.push(node);
@@ -888,7 +900,7 @@ class Tensor {
         }
         build(this);
         // Feed backward to calculate gradient
-        this.grad = Tensor.fullLike(this, 1);
+        this.grad = Tensor.onesLike(this);
         for (let index = topo.length - 1; index > -1; index--) {
             topo[index].gradFn();
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "catniff",
-  "version": "0.2.6",
+  "version": "0.2.8",
   "description": "A cute autograd engine for Javascript",
   "main": "index.js",
   "scripts": {