catniff 0.2.7 → 0.2.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -39,8 +39,6 @@ const B = new Tensor(3);
39
39
  console.log(A.add(B).val());
40
40
  ```
41
41
 
42
- All available APIs are in `./src/core.ts`.
43
-
44
42
  ## Autograd
45
43
 
46
44
  To compute the gradient wrt multiple variables of our mathematical expression, we can simply set `requiresGrad` to `true`:
@@ -74,11 +72,11 @@ G.backward();
74
72
  console.log(X.grad.val(), Y.grad.val());
75
73
  ```
76
74
 
77
- All available APIs are in `./src/core.ts`.
78
-
79
75
  ## Documentation
80
76
 
81
- Todo :/
77
+ Full documentation is available in [`./docs/documentation.md`](./docs/documentation.md).
78
+
79
+ All available APIs are in [`./src/core.ts`](./src/core.ts) if you want to dig deeper.
82
80
 
83
81
  ## Todos
84
82
 
package/dist/core.d.ts CHANGED
@@ -94,6 +94,6 @@ export declare class Tensor {
94
94
  static onesLike(tensor: Tensor, options?: TensorOptions): Tensor;
95
95
  static zerosLike(tensor: Tensor, options?: TensorOptions): Tensor;
96
96
  backward(): void;
97
- val(): any;
97
+ val(): TensorValue;
98
98
  withGrad(requiresGrad: boolean): Tensor;
99
99
  }
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "catniff",
3
- "version": "0.2.7",
3
+ "version": "0.2.8",
4
4
  "description": "A cute autograd engine for Javascript",
5
5
  "main": "index.js",
6
6
  "scripts": {