kronyx 1.0.0__tar.gz

kronyx-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Kronyx Contributors
+
+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.

kronyx-1.0.0/PKG-INFO

@@ -0,0 +1,275 @@
+Metadata-Version: 2.4
+Name: kronyx
+Version: 1.0.0
+Summary: A lightweight deep learning framework built from scratch using NumPy
+Author: Kronyx Contributors
+Maintainer: Kronyx Contributors
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Kronyx/kronyx
+Project-URL: Documentation, https://kronyx.github.io/kronyx
+Project-URL: Repository, https://github.com/Kronyx/kronyx
+Project-URL: Issues, https://github.com/Kronyx/kronyx/issues
+Keywords: deep-learning,neural-network,numpy,machine-learning,framework,education
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Education
+Classifier: Intended Audience :: Science/Research
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Classifier: Topic :: Education
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy<3.0,>=1.26
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
+Requires-Dist: ruff>=0.8; extra == "dev"
+Requires-Dist: mypy>=1.11.2; extra == "dev"
+Provides-Extra: plotting
+Requires-Dist: matplotlib>=3.8; extra == "plotting"
+Provides-Extra: dataframe
+Requires-Dist: pandas>=2.2; extra == "dataframe"
+Dynamic: license-file
+
+# Kronyx
+
+A lightweight deep learning framework built from first principles using NumPy. Designed for education, research, and production use with a clean Keras-like API.
+
+[![PyPI](https://img.shields.io/badge/PyPI-kronyx-blue.svg)](https://pypi.org/project/kronyx/)
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg)](https://kronyx.github.io/kronyx)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://github.com/Kronyx/kronyx/actions/workflows/tests.yml/badge.svg)](https://github.com/Kronyx/kronyx/actions/workflows/tests.yml)
+[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+[![mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://mypy-lang.org/)
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Pure NumPy** | No external ML dependencies, just NumPy |
+| **Clean API** | Keras-like Sequential model interface |
+| **Educational** | Built for learning with visualization and inspection tools |
+| **Layers** | Dense, Conv2D, Flatten, Dropout, BatchNormalization |
+| **Activations** | ReLU, Sigmoid, Tanh, Softmax |
+| **Optimizers** | SGD, Adam with full state management |
+| **Callbacks** | EarlyStopping, ModelCheckpoint, CSVLogger, ReduceLROnPlateau |
+| **Serialization** | Save/load models with .krx format |
+| **Visualization** | `history.plot()`, `model.visualize()`, `model.summary()` |
+
+## Installation
+
+```bash
+pip install kronyx
+```
+
+For development:
+
+```bash
+git clone https://github.com/Kronyx/kronyx.git
+cd kronyx
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, Sigmoid, BinaryCrossEntropy, Adam, Accuracy
+
+# XOR problem - binary classification
+X = np.array([[0, 0], [0, 1], [1, 0], [1, 1]])
+y = np.array([[0], [1], [1], [0]])
+
+model = Sequential()
+model.add(Dense(2, 8))  # input_size=2, output_size=8
+model.add(ReLU())
+model.add(Dense(8, 1))
+model.add(Sigmoid())
+
+model.compile(
+    loss=BinaryCrossEntropy(),
+    optimizer=Adam(learning_rate=0.1),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=1000)
+predictions = model.predict(X)
+print(f"Accuracy: {(predictions.round() == y).mean():.2%}")
+```
+
+## Binary Classification Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, Sigmoid, BinaryCrossEntropy, Adam, Accuracy
+
+X_train = np.array([[0, 0], [0, 1], [1, 0], [1, 1]])
+y_train = np.array([[0], [1], [1], [0]])
+
+model = Sequential()
+model.add(Dense(2, 16))
+model.add(ReLU())
+model.add(Dense(16, 1))
+model.add(Sigmoid())
+
+model.compile(
+    loss=BinaryCrossEntropy(),
+    optimizer=Adam(learning_rate=0.1),
+    metric=Accuracy()
+)
+
+history = model.fit(X_train, y_train, epochs=500)
+model.summary()
+```
+
+## Multi-class Classification Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, SoftmaxCategoricalCrossEntropy, Adam, Accuracy
+
+# One-hot encoded labels
+X = np.random.randn(100, 4)
+y = np.eye(3)[np.random.randint(0, 3, 100)]
+
+model = Sequential()
+model.add(Dense(4, 32))
+model.add(ReLU())
+model.add(Dense(32, 3))
+model.add(Softmax())
+
+model.compile(
+    loss=SoftmaxCategoricalCrossEntropy(),
+    optimizer=Adam(learning_rate=0.01),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=100)
+```
+
+## Convolutional Neural Network Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Conv2D, ReLU, Flatten, Dense, Softmax
+
+# Simple image input (batch, height, width, channels)
+X = np.random.randn(10, 8, 8, 1)
+y = np.eye(2)[np.random.randint(0, 2, 10)]
+
+model = Sequential()
+model.add(Conv2D(filters=8, kernel_size=3, padding='same'))
+model.add(ReLU())
+model.add(Flatten())
+model.add(Dense(64, 2))
+model.add(Softmax())
+
+model.compile(
+    loss=SoftmaxCategoricalCrossEntropy(),
+    optimizer=Adam(learning_rate=0.01),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=10)
+```
+
+## Saving and Loading Models
+
+```python
+# Save complete model with architecture, weights, and configuration
+model.save('model.krx')
+
+# Load complete model
+loaded = load_model('model.krx')
+
+# Continue training or make predictions
+loaded.predict(X_test)
+```
+
+## Saving and Loading Weights
+
+```python
+# Save only trainable weights
+model.save_weights('weights.npz')
+
+# Create a new model with matching architecture
+new_model = Sequential()
+new_model.add(Dense(2, 8))
+new_model.add(ReLU())
+new_model.add(Dense(8, 1))
+new_model.add(Sigmoid())
+
+# Load weights into the new model
+new_model.load_weights('weights.npz')
+```
+
+## Exporting JSON Architecture
+
+```python
+# Export architecture to JSON string
+json_str = model.to_json()
+
+# Create model from JSON (weights initialized randomly)
+model = Sequential.from_json(json_str)
+```
+
+## .krx Archive Format
+
+The `.krx` format is a zip archive containing:
+
+```
+model.krx
+├── metadata.json      # Framework version, Python/numpy versions, timestamp
+├── architecture.json  # Layer configuration, loss, optimizer settings
+├── weights.npz        # Trainable weights and biases (numpy archive)
+└── optimizer.npz      # Optional: optimizer state for resumable training
+```
+
+## Examples
+
+- `examples/xor.py` - XOR problem with binary classification
+- `examples/iris_classification.py` - Iris dataset multi-class classification
+- `examples/iris_dropout.py` - Dropout regularization example
+- `examples/iris_l2.py` - L2 weight regularization
+- `examples/batchnorm_iris.py` - Batch normalization demonstration
+- `examples/flatten_demo.py` - Multi-dimensional input handling
+- `examples/conv2d_demo.py` - Convolutional neural network example
+- `examples/mnist_classifier.py` - MNIST digit classification
+
+## Documentation
+
+```
+kronyx/
+├── activations.py    # ReLU, Sigmoid, Tanh, Softmax
+├── layers.py         # Dense, Conv2D, Flatten, Dropout, BatchNormalization
+├── model.py          # Sequential, History
+├── optimizers.py     # SGD, Adam
+├── losses.py         # BinaryCrossEntropy, CategoricalCrossEntropy
+├── metrics.py        # Accuracy
+├── callbacks.py      # Callback base, EarlyStopping, etc.
+├── regularizers.py   # L2
+├── initializers.py   # he_normal, xavier_uniform, lecun_normal
+├── serialization.py  # Save/load model (.krx format)
+├── utils.py          # Utility functions
+└── exceptions.py     # Error types
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for planned features.
+
+## License
+
+MIT License - see [LICENSE](LICENSE)

kronyx-1.0.0/README.md

@@ -0,0 +1,235 @@
+# Kronyx
+
+A lightweight deep learning framework built from first principles using NumPy. Designed for education, research, and production use with a clean Keras-like API.
+
+[![PyPI](https://img.shields.io/badge/PyPI-kronyx-blue.svg)](https://pypi.org/project/kronyx/)
+[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg)](https://kronyx.github.io/kronyx)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Tests](https://github.com/Kronyx/kronyx/actions/workflows/tests.yml/badge.svg)](https://github.com/Kronyx/kronyx/actions/workflows/tests.yml)
+[![Ruff](https://img.shields.io/badge/code%20style-ruff-000000.svg)](https://docs.astral.sh/ruff/)
+[![mypy](https://img.shields.io/badge/types-mypy-blue.svg)](https://mypy-lang.org/)
+
+## Features
+
+| Feature | Description |
+|---------|-------------|
+| **Pure NumPy** | No external ML dependencies, just NumPy |
+| **Clean API** | Keras-like Sequential model interface |
+| **Educational** | Built for learning with visualization and inspection tools |
+| **Layers** | Dense, Conv2D, Flatten, Dropout, BatchNormalization |
+| **Activations** | ReLU, Sigmoid, Tanh, Softmax |
+| **Optimizers** | SGD, Adam with full state management |
+| **Callbacks** | EarlyStopping, ModelCheckpoint, CSVLogger, ReduceLROnPlateau |
+| **Serialization** | Save/load models with .krx format |
+| **Visualization** | `history.plot()`, `model.visualize()`, `model.summary()` |
+
+## Installation
+
+```bash
+pip install kronyx
+```
+
+For development:
+
+```bash
+git clone https://github.com/Kronyx/kronyx.git
+cd kronyx
+pip install -e ".[dev]"
+```
+
+## Quick Start
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, Sigmoid, BinaryCrossEntropy, Adam, Accuracy
+
+# XOR problem - binary classification
+X = np.array([[0, 0], [0, 1], [1, 0], [1, 1]])
+y = np.array([[0], [1], [1], [0]])
+
+model = Sequential()
+model.add(Dense(2, 8))  # input_size=2, output_size=8
+model.add(ReLU())
+model.add(Dense(8, 1))
+model.add(Sigmoid())
+
+model.compile(
+    loss=BinaryCrossEntropy(),
+    optimizer=Adam(learning_rate=0.1),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=1000)
+predictions = model.predict(X)
+print(f"Accuracy: {(predictions.round() == y).mean():.2%}")
+```
+
+## Binary Classification Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, Sigmoid, BinaryCrossEntropy, Adam, Accuracy
+
+X_train = np.array([[0, 0], [0, 1], [1, 0], [1, 1]])
+y_train = np.array([[0], [1], [1], [0]])
+
+model = Sequential()
+model.add(Dense(2, 16))
+model.add(ReLU())
+model.add(Dense(16, 1))
+model.add(Sigmoid())
+
+model.compile(
+    loss=BinaryCrossEntropy(),
+    optimizer=Adam(learning_rate=0.1),
+    metric=Accuracy()
+)
+
+history = model.fit(X_train, y_train, epochs=500)
+model.summary()
+```
+
+## Multi-class Classification Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Dense, ReLU, SoftmaxCategoricalCrossEntropy, Adam, Accuracy
+
+# One-hot encoded labels
+X = np.random.randn(100, 4)
+y = np.eye(3)[np.random.randint(0, 3, 100)]
+
+model = Sequential()
+model.add(Dense(4, 32))
+model.add(ReLU())
+model.add(Dense(32, 3))
+model.add(Softmax())
+
+model.compile(
+    loss=SoftmaxCategoricalCrossEntropy(),
+    optimizer=Adam(learning_rate=0.01),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=100)
+```
+
+## Convolutional Neural Network Example
+
+```python
+import numpy as np
+from kronyx import Sequential, Conv2D, ReLU, Flatten, Dense, Softmax
+
+# Simple image input (batch, height, width, channels)
+X = np.random.randn(10, 8, 8, 1)
+y = np.eye(2)[np.random.randint(0, 2, 10)]
+
+model = Sequential()
+model.add(Conv2D(filters=8, kernel_size=3, padding='same'))
+model.add(ReLU())
+model.add(Flatten())
+model.add(Dense(64, 2))
+model.add(Softmax())
+
+model.compile(
+    loss=SoftmaxCategoricalCrossEntropy(),
+    optimizer=Adam(learning_rate=0.01),
+    metric=Accuracy()
+)
+
+model.fit(X, y, epochs=10)
+```
+
+## Saving and Loading Models
+
+```python
+# Save complete model with architecture, weights, and configuration
+model.save('model.krx')
+
+# Load complete model
+loaded = load_model('model.krx')
+
+# Continue training or make predictions
+loaded.predict(X_test)
+```
+
+## Saving and Loading Weights
+
+```python
+# Save only trainable weights
+model.save_weights('weights.npz')
+
+# Create a new model with matching architecture
+new_model = Sequential()
+new_model.add(Dense(2, 8))
+new_model.add(ReLU())
+new_model.add(Dense(8, 1))
+new_model.add(Sigmoid())
+
+# Load weights into the new model
+new_model.load_weights('weights.npz')
+```
+
+## Exporting JSON Architecture
+
+```python
+# Export architecture to JSON string
+json_str = model.to_json()
+
+# Create model from JSON (weights initialized randomly)
+model = Sequential.from_json(json_str)
+```
+
+## .krx Archive Format
+
+The `.krx` format is a zip archive containing:
+
+```
+model.krx
+├── metadata.json      # Framework version, Python/numpy versions, timestamp
+├── architecture.json  # Layer configuration, loss, optimizer settings
+├── weights.npz        # Trainable weights and biases (numpy archive)
+└── optimizer.npz      # Optional: optimizer state for resumable training
+```
+
+## Examples
+
+- `examples/xor.py` - XOR problem with binary classification
+- `examples/iris_classification.py` - Iris dataset multi-class classification
+- `examples/iris_dropout.py` - Dropout regularization example
+- `examples/iris_l2.py` - L2 weight regularization
+- `examples/batchnorm_iris.py` - Batch normalization demonstration
+- `examples/flatten_demo.py` - Multi-dimensional input handling
+- `examples/conv2d_demo.py` - Convolutional neural network example
+- `examples/mnist_classifier.py` - MNIST digit classification
+
+## Documentation
+
+```
+kronyx/
+├── activations.py    # ReLU, Sigmoid, Tanh, Softmax
+├── layers.py         # Dense, Conv2D, Flatten, Dropout, BatchNormalization
+├── model.py          # Sequential, History
+├── optimizers.py     # SGD, Adam
+├── losses.py         # BinaryCrossEntropy, CategoricalCrossEntropy
+├── metrics.py        # Accuracy
+├── callbacks.py      # Callback base, EarlyStopping, etc.
+├── regularizers.py   # L2
+├── initializers.py   # he_normal, xavier_uniform, lecun_normal
+├── serialization.py  # Save/load model (.krx format)
+├── utils.py          # Utility functions
+└── exceptions.py     # Error types
+```
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for development guidelines.
+
+## Roadmap
+
+See [ROADMAP.md](ROADMAP.md) for planned features.
+
+## License
+
+MIT License - see [LICENSE](LICENSE)

kronyx-1.0.0/kronyx/__init__.py

@@ -0,0 +1,68 @@
+from kronyx.activations import ReLU, Sigmoid, Softmax, Tanh
+from kronyx.callbacks import (
+    Callback,
+    CSVLogger,
+    EarlyStopping,
+    ModelCheckpoint,
+    ReduceLROnPlateau,
+)
+from kronyx.exceptions import (
+    ConfigurationError,
+    NeuralnetError,
+    NotCompiledError,
+    OptimizerError,
+    ShapeError,
+)
+from kronyx.initializers import he_normal, lecun_normal, xavier_uniform
+from kronyx.layers import BatchNormalization, Conv2D, Dense, Dropout, Flatten
+from kronyx.losses import (
+    BinaryCrossEntropy,
+    CategoricalCrossEntropy,
+    SoftmaxCategoricalCrossEntropy,
+)
+from kronyx.metrics import Accuracy
+from kronyx.model import History, Sequential
+from kronyx.optimizers import SGD, Adam
+from kronyx.regularizers import L2
+from kronyx.serialization import SerializationError, from_json, load_model
+from kronyx.utils import set_seed
+from kronyx.version import __version__
+
+__all__ = [
+    "Dense",
+    "Dropout",
+    "BatchNormalization",
+    "Flatten",
+    "Conv2D",
+    "ReLU",
+    "Sigmoid",
+    "Tanh",
+    "Softmax",
+    "BinaryCrossEntropy",
+    "SoftmaxCategoricalCrossEntropy",
+    "CategoricalCrossEntropy",
+    "SGD",
+    "Adam",
+    "Accuracy",
+    "Sequential",
+    "History",
+    "NeuralnetError",
+    "ConfigurationError",
+    "NotCompiledError",
+    "ShapeError",
+    "OptimizerError",
+    "he_normal",
+    "xavier_uniform",
+    "lecun_normal",
+    "Callback",
+    "EarlyStopping",
+    "ModelCheckpoint",
+    "CSVLogger",
+    "ReduceLROnPlateau",
+    "L2",
+    "set_seed",
+    "load_model",
+    "from_json",
+    "SerializationError",
+    "__version__",
+]