mini-jstorch 1.3.2 → 1.4.3

package/README.md

@@ -1,39 +1,42 @@
 # Mini-JSTorch
 
-A lightweight JavaScript neural network library for rapid frontend AI experimentation on low-resource devices Inspired by PyTorch.
+A lightweight JavaScript neural network library for rapid frontend AI experimentation on low-resource devices, inspired by PyTorch.
 
 ## Overview
 
-Mini-JSTorch is a lightweight, high-performance JavaScript library for building neural networks that runs efficiently in both frontend and backend environments, including low-end devices. The library enables experimentation and learning in AI without compromising stability, accuracy, or training reliability.
+Mini-JSTorch is a high-performance, minimalist JavaScript library for building neural networks. It runs efficiently in both frontend and backend environments, including low-end devices. The library enables quick experimentation and learning in AI without compromising stability, accuracy, or training reliability.
 
-This release, **version 1.2.3**, is a just some fix a typo and delete not used files.
+This release, **version 1.4.3**, We make `Matrix Utils` now can be used in others Files.
 
 ---
 
-## Features Overview
-
-- Full **Conv2D support** with forward and backward operations.
-- **Tensor operations** now support broadcasting and reshaping.
-- Added new activations:  `LeakyReLU`, `GELU`.
-- Optimizers: `Adam` and `SGD` fully integrated with gradient updates.
-- Dropout layer added for regularization.
-- Advanced utilities for tensor manipulation: `flatten`, `stack`, `concat`, `eye`, `reshape`.
-- End-to-end training and prediction workflow now fully tested.
-- Save and load model functionality included for seamless persistence.
-- Optimized performance for both frontend and backend usage.
-- Maintained backward compatibility for previous core layers and activations.
-- folder tests files template that you can use it before make your models.
+## Feature Highlights
+
+- **Learning Rate Schedulers:** New `StepLR` and `LambdaLR` for dynamic optimizer learning rate adjustment.
+- **Full Conv2D support:** Forward and backward operations for convolutional layers.
+- **Tensor operations:** Broadcasting, reshaping, and reduction utilities.
+- **Advanced Activations:** Includes `LeakyReLU`, `GELU`, `Mish`, `SiLU`, `ELU`, and more.
+- **Optimizers:** `Adam` and `SGD` with gradient updates.
+- **Dropout Layer:** For regularization during training.
+- **BatchNorm2D:** For stable training in convolutional models.
+- **Tensor Manipulation:** Utilities like `flatten`, `stack`, `concat`, `eye`, `reshape`.
+- **Model Save & Load:** Easy persistence and restore of models.
+- **Test/Demo Templates:** The `tests/` folder provides ready-to-run examples for model building and feature usage.
+- **Performance Optimized:** Suitable for both frontend and backend usage.
+- **Backward Compatibility:** Maintained for core layers and activations.
 
 ---
 
-## Features
+## Core Features
 
-- **Core Layers**: Linear, Conv2D  
-- **Activations**: ReLU, Sigmoid, Tanh, LeakyReLU, GELU  
-- **Loss Functions**: MSELoss, CrossEntropyLoss  
-- **Optimizers**: Adam, SGD  
-- **Utilities**: zeros, randomMatrix, softmax, crossEntropy, dot, addMatrices, reshape, stack, flatten, eye, concat  
-- **Model Container**: Sequential (for stacking layers with forward/backward passes)  
+- **Layers:** Linear, Conv2D  
+- **Activations:** ReLU, Sigmoid, Tanh, LeakyReLU, GELU, Mish, SiLU, ELU  
+- **Loss Functions:** MSELoss, CrossEntropyLoss
+- **Optimizers:** Adam, SGD  
+- **Schedulers:** StepLR, LambdaLR  , ReduceLROnPlateau
+- **Regularization:** Dropout, BatchNorm2D  
+- **Utilities:** zeros, randomMatrix, softmax, crossEntropy, dot, addMatrices, reshape, stack, flatten, eye, concat  
+- **Model Container:** Sequential (for stacking layers with forward/backward passes)  
 
 ---
 
@@ -49,7 +52,7 @@ npm install mini-jstorch
 ## Quick Start Example
 
 ```javascript
-import { Sequential, Linear, ReLU, Sigmoid, CrossEntropyLoss, Adam } from './src/MainEngine.js';
+import { Sequential, Linear, ReLU, Sigmoid, CrossEntropyLoss, Adam, StepLR } from 'mini-jstorch';
 
 // Build model
 const model = new Sequential([
@@ -70,6 +73,7 @@ const Y = [
 // Loss & optimizer
 const lossFn = new CrossEntropyLoss();
 const optimizer = new Adam(model.parameters(), 0.1);
+const scheduler = new StepLR(optimizer, 20, 0.5); // Halve LR every 20 epochs
 
 // Training loop
 for (let epoch = 1; epoch <= 100; epoch++) {
@@ -78,7 +82,8 @@ for (let epoch = 1; epoch <= 100; epoch++) {
   const gradLoss = lossFn.backward();
   model.backward(gradLoss);
   optimizer.step();
-  if (epoch % 20 === 0) console.log(`Epoch ${epoch}, Loss: ${loss.toFixed(4)}`);
+  scheduler.step();
+  if (epoch % 20 === 0) console.log(`Epoch ${epoch}, Loss: ${loss.toFixed(4)}, LR: ${optimizer.lr.toFixed(4)}`);
 }
 
 // Prediction
@@ -94,7 +99,7 @@ predTest.forEach((p,i) => {
 ## Save & Load Models
 
 ```javascript
-import { saveModel, loadModel } from 'mini-jstorch';
+import { saveModel, loadModel, Sequential } from './src/MainEngine.js';
 
 const json = saveModel(model);
 const model2 = new Sequential([...]); // same architecture
@@ -103,7 +108,22 @@ loadModel(model2, json);
 
 ---
 
+## Demos & Testing
+
+Check the `tests/` directory for ready-to-run demos:
+- **tests/MakeModel.js:** Build and run a simple neural network.
+- **tests/scheduler.js:** Experiment with learning rate schedulers.
+- Add your own scripts for quick prototyping!
+
+```bash
+node tests/MakeModel.js
+node tests/scheduler.js
+```
+
+---
+
 ## Intended Use Cases
+
  - Rapid prototyping of neural networks in frontend and backend.
  - Learning and teaching foundational neural network concepts.
  - Experimentation on low-end devices or mobile browsers.
@@ -113,14 +133,24 @@ loadModel(model2, json);
 
 # License
 
-**MIT © 2025 Rizal**
+`MIT License`
 
----
+**Copyright (c) 2025 rizal-editors**
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-## Facts
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
 
-- **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.**
-- **files startup.cpu is actually an some random files lol.**
-- **This module was created by a `single` developer.**
-- **You can join to the `mjs-group` Organization on my profile!**
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/index.js

@@ -1,90 +1,2 @@
-// =====================================================
-// FILE: index.js - Main entry point
-// =====================================================
-
-// Import all modules
-import { Tensor } from './src/tensor.js';
-import { 
-    Linear, Dense, Conv2d, MaxPool2d, AvgPool2d, Flatten, Dropout, 
-    BatchNorm2d, ReLU, Sigmoid, Tanh, LeakyReLU, ELU, Softmax, Sequential 
-} from './src/layers.js';
-import { MSELoss, CrossEntropyLoss, BCELoss } from './src/loss.js';
-import { SGD, Adam, RMSprop } from './src/optimizers.js';
-import { Model, Trainer, models, optimizers, losses, layers, tensors, utils } from './src/model.js';
-
-// Export everything
-export {
-    // Core classes
-    Tensor,
-    Model,
-    Trainer,
-    
-    // Layer classes
-    Linear,
-    Dense,
-    Conv2d,
-    MaxPool2d,
-    AvgPool2d,
-    Flatten,
-    Dropout,
-    BatchNorm2d,
-    ReLU,
-    Sigmoid,
-    Tanh,
-    LeakyReLU,
-    ELU,
-    Softmax,
-    Sequential,
-    
-    // Loss classes
-    MSELoss,
-    CrossEntropyLoss,
-    BCELoss,
-    
-    // Optimizer classes
-    SGD,
-    Adam,
-    RMSprop,
-    
-    // Factory functions
-    models,
-    optimizers,
-    losses,
-    layers,
-    tensors,
-    utils
-};
-
-// Default export
-export default {
-    Tensor,
-    Model,
-    Trainer,
-    Linear,
-    Dense,
-    Conv2d,
-    MaxPool2d,
-    AvgPool2d,
-    Flatten,
-    Dropout,
-    BatchNorm2d,
-    ReLU,
-    Sigmoid,
-    Tanh,
-    LeakyReLU,
-    ELU,
-    Softmax,
-    Sequential,
-    MSELoss,
-    CrossEntropyLoss,
-    BCELoss,
-    SGD,
-    Adam,
-    RMSprop,
-    models,
-    optimizers,
-    losses,
-    layers,
-    tensors,
-    utils
-};
+// package root
+export * from "./src/MainEngine.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "mini-jstorch",
-  "version": "1.3.2",
+  "version": "1.4.3",
   "type": "module", 
   "description": "A lightweight JavaScript neural network library for rapid frontend AI experimentation on low-resource devices Inspired by PyTorch.",
   "main": "index.js",

package/src/MainEngine.js

@@ -1,18 +1,77 @@
+/*!
+ * Project: mini-jstorch
+ * File: MainEngine.js
+ * Author: M. Rizal H. (Actual Author Name)
+ * License: MIT
+ * Copyright (C) 2025 M. Rizal H.
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+ * SOFTWARE.
+ */
 
-// MINI JSTORCH ENGINE
-// LICENSE: MIT (C) Rizal 2025
-// 1.2.3 ENGINE VERSIONS
-// IMPORTANT: CORE ENGINE DO NOT EDIT THIS FILES VERY SENSITIVE IT WILL CRASHING YOUR ENGINE SYSTEMS!
 
 // ---------------------- Utilities ----------------------
-function zeros(rows, cols) { return Array.from({length:rows},()=>Array(cols).fill(0)); }
-function ones(rows, cols) { return Array.from({length:rows},()=>Array(cols).fill(1)); }
-function randomMatrix(rows, cols, scale=0.1){ return Array.from({length:rows},()=>Array.from({length:cols},()=> (Math.random()*2-1)*scale)); }
-function transpose(matrix){ return matrix[0].map((_,i)=>matrix.map(row=>row[i])); }
-function addMatrices(a,b){ return a.map((row,i)=>row.map((v,j)=>v+(b[i] && b[i][j]!==undefined?b[i][j]:0))); }
-function dot(a,b){ const res=zeros(a.length,b[0].length); for(let i=0;i<a.length;i++) for(let j=0;j<b[0].length;j++) for(let k=0;k<a[0].length;k++) res[i][j]+=a[i][k]*b[k][j]; return res; }
-function softmax(x){ const m=Math.max(...x); const exps=x.map(v=>Math.exp(v-m)); const s=exps.reduce((a,b)=>a+b,0); return exps.map(v=>v/s); }
-function crossEntropy(pred,target){ const eps=1e-12; return -target.reduce((sum,t,i)=>sum+t*Math.log(pred[i]+eps),0); }
+export function zeros(rows, cols) { 
+    return Array.from({length:rows},()=>Array(cols).fill(0)); 
+}
+
+export function ones(rows, cols) { 
+    return Array.from({length:rows},()=>Array(cols).fill(1)); 
+}
+
+export function randomMatrix(rows, cols, scale=0.1){ 
+    return Array.from({length:rows},()=>
+        Array.from({length:cols},()=> (Math.random()*2-1)*scale)
+    ); 
+}
+
+export function transpose(matrix){ 
+    return matrix[0].map((_,i)=>matrix.map(row=>row[i])); 
+}
+
+export function addMatrices(a,b){ 
+    return a.map((row,i)=>
+        row.map((v,j)=>v+(b[i] && b[i][j]!==undefined?b[i][j]:0))
+    ); 
+}
+
+export function dot(a,b){ 
+    const res=zeros(a.length,b[0].length); 
+    for(let i=0;i<a.length;i++) 
+        for(let j=0;j<b[0].length;j++) 
+            for(let k=0;k<a[0].length;k++) 
+                res[i][j]+=a[i][k]*b[k][j]; 
+    return res; 
+}
+
+export function softmax(x){ 
+    const m=Math.max(...x); 
+    const exps=x.map(v=>Math.exp(v-m)); 
+    const s=exps.reduce((a,b)=>a+b,0); 
+    return exps.map(v=>v/s); 
+}
+
+export function crossEntropy(pred,target){ 
+    const eps=1e-12; 
+    return -target.reduce((sum,t,i)=>sum+t*Math.log(pred[i]+eps),0); 
+}
+/* Not Added more Utils yet. (this patch not MINOR)
+   Just make it Public to other files. */ 
 
 // ---------------------- Tensor ----------------------
 export class Tensor {
@@ -225,6 +284,48 @@ export class Adam{
     }
 }
 
+// ---------------------- Learning Rate Schedulers ----------------------
+export class StepLR {
+    constructor(optimizer, step_size, gamma=1.0) {
+        this.optimizer = optimizer;
+        this.step_size = step_size;
+        this.gamma = gamma;
+        this.last_epoch = 0;
+        this.base_lr = optimizer.lr;
+    }
+
+    step() {
+        this.last_epoch += 1;
+        if (this.last_epoch % this.step_size === 0) {
+            this.optimizer.lr *= this.gamma;
+        }
+    }
+
+    get_lr() {
+        return this.optimizer.lr;
+		/* Do nothing else */
+    }
+}
+
+export class LambdaLR {
+    constructor(optimizer, lr_lambda) {
+        this.optimizer = optimizer;
+        this.lr_lambda = lr_lambda;
+        this.last_epoch = 0;
+        this.base_lr = optimizer.lr;
+    }
+
+    step() {
+        this.last_epoch += 1;
+        this.optimizer.lr = this.base_lr * this.lr_lambda(this.last_epoch);
+    }
+
+    get_lr() {
+        return this.optimizer.lr;
+		/* Do nothing else */
+    }
+}
+
 // ---------------------- ELU Activation ----------------------
 export class ELU {
     constructor(alpha=1.0) {
@@ -534,6 +635,7 @@ export function saveModel(model){
     if(!(model instanceof Sequential)) throw new Error("saveModel supports only Sequential");
     const weights=model.layers.map(layer=>({weights:layer.W||null,biases:layer.b||null}));
     return JSON.stringify(weights);
+	/* Didn't expect this to work */
 }
 
 export function loadModel(model,json){
@@ -543,6 +645,7 @@ export function loadModel(model,json){
         if(layer.W && weights[i].weights) layer.W=weights[i].weights;
         if(layer.b && weights[i].biases) layer.b=weights[i].biases;
     });
+	/* Didn't expect this to work */
 }
 
 // ---------------------- Advanced Utils ----------------------
@@ -551,10 +654,10 @@ export function stack(tensors){ return tensors.map(t=>t.data); }
 export function eye(n){ return Array.from({length:n},(_,i)=>Array.from({length:n},(_,j)=>i===j?1:0)); }
 export function concat(a,b,axis=0){ /* concat along axis */ if(axis===0) return [...a,...b]; if(axis===1) return a.map((row,i)=>[...row,...b[i]]); }
 export function reshape(tensor, rows, cols) {
-    let flat = tensor.data.flat(); // flatten dulu
+    let flat = tensor.data.flat(); // flatten first
     if(flat.length < rows*cols) throw new Error("reshape size mismatch");
     const out = Array.from({length: rows}, (_, i) =>
         flat.slice(i*cols, i*cols + cols)
     );
     return out;
-}
+}