mini-jstorch 1.1.6 → 1.1.9

package/CHANGELOG.md

@@ -0,0 +1,32 @@
+## Changelog ##
+
+**Official Release:** 2025-Monday-August-18  
+**Version:** 1.1.9
+
+New Files that will All notable changes to *Mini-JSTorch* will be documented in this file.
+
+---
+
+## [1.1.9] - 2025-Monday-August-18
+
+### Added
+- Complete overhaul of core engine for stability and full feature support.
+- Adam optimizer fully integrated with batch gradient handling.
+- NaN-safe operations for forward/backward passes and loss calculations.
+- Sequential container with robust parameter tracking.
+- Utility functions enhanced for numeric safety and matrix operations.
+- Ready-to-use example scripts with multiple hidden layers for frontend experimentation.
+- Full handling for lightweight devices, optimized for speed and low memory usage.
+
+### Fixed
+- bugs in ReLU and gradient propagation causing NaN loss values.
+- Backward propagation errors for batch matrices corrected.
+- Critical Error while startup Engine.
+
+### Changed
+- Layer and activation API standardized for consistency.
+- CrossEntropyLoss now safely handles edge cases in probability computations.
+- Improvements systems for make experiences more stable and not heavy.
+- Minor numeric stability improvements.
+
+---

package/README.md

@@ -0,0 +1,130 @@
+## Mini-JSTorch ##
+
+# IMPORTANT! #
+
+This Module will not gonna Run *Well* In at GPU or a Backend.
+We're will gonna *Optimize* So all User can still use this Module.
+
+---
+
+**Mini JSTorch** is a lightweight, high-performance JavaScript library designed for rapid prototyping of neural networks directly in the frontend environment and for low-end devices. Its core purpose is to enable experimentation and learning on devices with limited computing resources, without compromising stability or training reliability.
+
+---
+
+## Vision
+
+Our vision is to democratize AI experimentation by providing a tool that is:
+
+- **Accessible**: Runs efficiently on *low-end* laptops or mobile devices.
+- **Stable**: Handles gradient calculations and NaN values robustly.
+- **Educational**: Clear abstractions for neural network layers, activations, and optimizers.
+- **Fast**: Immediate output without lengthy training delays.
+
+*Mini JSTorch* aims to bridge the gap between conceptual AI learning and hands-on experimentation, making it possible to explore neural network behavior interactively, even on minimal hardware.
+
+---
+
+## Features
+
+- **Core Layers**
+  - `Linear`: Fully connected layer with weight and bias support.
+- **Activations**
+  - `ReLU`: Rectified Linear Unit activation.
+  - `Sigmoid`: Sigmoid activation function.
+- **Loss Functions**
+  - `CrossEntropyLoss`: Combines softmax and cross-entropy for classification tasks.
+- **Optimizers**
+  - `Adam`: Adaptive optimizer for stable and efficient training.
+- **Utilities**
+  - `zeros(rows, cols)`: Generate a zero matrix.
+  - `randomMatrix(rows, cols, scale)`: Random initialization for weights.
+  - `softmax(x)`: Compute softmax probabilities.
+  - `crossEntropy(pred, target)`: Compute cross-entropy loss.
+  - `dot(a, b)`: Matrix multiplication.
+  - `addMatrices(a, b)`: Element-wise addition of matrices.
+- **Model Container**
+  - `Sequential`: Container to stack layers sequentially with easy forward and backward passes.
+
+---
+
+## Installation
+
+```bash
+npm install mini-jstorch
+# Node.js v20+ recommended for a good experience while using module
+```
+
+---
+
+## Example Scripts
+
+```javascript
+import { Sequential, Linear, ReLU, Sigmoid, CrossEntropy, Adam } from './engine/MainEngine.js'; // use import to import the modules
+
+// Construct a model with two hidden layers
+const model = new Sequential([
+    new Linear(2, 4),
+    new ReLU(),
+    new Linear(4, 4),
+    new ReLU(),
+    new Linear(4, 2),
+    new Sigmoid()
+]);
+
+// Training data (XOR)
+const inputs = [
+    [0,0], [0,1], [1,0], [1,1]
+];
+const targets = [
+    [1,0], [0,1], [0,1], [1,0]
+];
+
+// Optimizer and loss
+const optimizer = new Adam(model.parameters(), 0.01);
+const lossFunc = CrossEntropy;
+
+// Training loop
+for(let epoch = 1; epoch <= 5000; epoch++) {
+    let totalLoss = 0;
+    for(let i = 0; i < inputs.length; i++) {
+        const output = model.forward([inputs[i]]);
+        const loss = lossFunc(output, [targets[i]]);
+        totalLoss += loss;
+        model.zeroGrad();
+        model.backward(lossFunc.backward());
+        optimizer.step();
+    }
+    if(epoch % 500 === 0) console.log(`Epoch ${epoch}, Loss: ${totalLoss.toFixed(6)}`);
+}
+
+// Predictions
+inputs.forEach(inp => {
+    const pred = model.forward([inp]);
+    console.log(`${inp} -> ${pred.map(p => p.toFixed(4))}`);
+});
+```
+---
+
+## Intended Use Cases
+
+- **Experimentation on low-end devices or mobile browsers.**
+- **Learning and teaching foundational neural network concepts.**
+- **Testing small to medium feedforward models in real-time.**
+- **Quick prototyping without GPU dependency or complex setup.**
+
+---
+
+## Roadmap
+
+- **Browser-based interactive playground.**
+- **Additional activation functions and loss options.**
+- **Visualization of training metrics and loss curves in real-time.**
+- **Support for small convolutional networks in frontend environments.**
+
+---
+
+## Facts
+
+- **This module is implemented entirely in pure JavaScript.**
+- **The `Dummy` folder contains modules used for development, testing, and debugging before integration into the main engine.**
+- **This module was created by a `single` developer.**

package/index.js

@@ -1,4 +1,4 @@
-// Entry point of the library, export main classes and functions
+// Entry point of the library, export main classes and functions [DEPRECATED]
 export { Seq } from './models/seq.js';
 export { Dense } from './layers/dense.js';
 export * as act from './act/linear.js';

package/package.json

@@ -1,16 +1,18 @@
 {
   "name": "mini-jstorch",
-  "version": "1.1.6",
+  "version": "1.1.9",
   "type": "module", 
-  "description": "A lightweight JavaScript neural network framework for browser & Node.js, inspired by PyTorch.",
+  "description": "A lightweight JavaScript neural network library for rapid frontend AI experimentation on low-resource devices Inspired by PyTorch.",
   "main": "index.js",
   "keywords": [
     "neural-network",
     "javascript",
     "lightweight",
     "ai",
+    "jstorch",
+    "pytorch",
+    "front-end",
     "machine-learning",
-    "browser",
     "mini"
   ],
   "author": "Rizal",