autograd-ts 0.1.0 → 0.1.2

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.
Files changed (2) hide show
  1. package/README.md +19 -2
  2. package/package.json +6 -2
package/README.md CHANGED
@@ -1,5 +1,4 @@
1
1
  # autograd-ts
2
-
3
2
  A tiny Typescript library that implements **reverse-mode automatic differentiation** (autograd) and neural network training.
4
3
 
5
4
  The goal of the project is exploring the fundamental mechanism that allows neural networks to learn.
@@ -10,6 +9,25 @@ Producing an output is straightforward. However, learning requires determining h
10
9
 
11
10
  This library explores the mechanism that makes that possible.
12
11
 
12
+ ## Usage
13
+
14
+ Install:
15
+
16
+ ```bash
17
+ npm install autograd-ts
18
+ ```
19
+
20
+ ## Import
21
+ ```ts
22
+ import {
23
+ Value,
24
+ val,
25
+ MLP,
26
+ mse,
27
+ sgd,
28
+ } from 'autograd-ts';
29
+ ```
30
+
13
31
  ---
14
32
 
15
33
  # Understanding Learning
@@ -225,7 +243,6 @@ This feedback loop is the mechanism that allows neural networks to learn.
225
243
  ---
226
244
 
227
245
  # Project Scope
228
-
229
246
  Version 0.1.0 focuses on a minimal learning system.
230
247
 
231
248
  ## Core Autograd Engine
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "autograd-ts",
3
- "version": "0.1.0",
3
+ "version": "0.1.2",
4
4
  "description": "A tiny reverse-mode automatic differentiation engine in TypeScript",
5
5
  "main": "./dist/index.js",
6
6
  "types": "./dist/index.d.ts",
@@ -10,7 +10,11 @@
10
10
  "types": "./dist/index.d.ts"
11
11
  }
12
12
  },
13
- "files": ["dist", "README.md", "LICENSE"],
13
+ "files": [
14
+ "dist",
15
+ "README.md",
16
+ "LICENSE"
17
+ ],
14
18
  "scripts": {
15
19
  "build": "tsc",
16
20
  "dev": "vitest run tests/value.test.ts",