Metadata-Version: 2.4
Name: kronyx
Version: 1.1.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/BillyMuthiani/Kronyx
Project-URL: Documentation, https://kronyx.github.io/kronyx
Project-URL: Repository, https://github.com/BillyMuthiani/Kronyx
Project-URL: Issues, https://github.com/BillyMuthiani/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

<p align="center">
  <a href="https://github.com/BillyMuthiani/Kronyx">
    <img src="kronyx/assets/logo.png" alt="Kronyx" width="650">
  </a>
</p>

<h1 align="center">Kronyx</h1>

<p align="center">
<b>Built from Scratch • NumPy Powered • Educational Deep Learning Framework</b>
</p>

<p align="center">
A lightweight deep learning framework that makes neural networks easy to learn, inspect, visualize, and build.
</p>

<p align="center">

[![PyPI](https://img.shields.io/pypi/v/kronyx?style=for-the-badge)](https://pypi.org/project/kronyx/)
[![Python](https://img.shields.io/pypi/pyversions/kronyx?style=for-the-badge)](https://pypi.org/project/kronyx/)
[![License](https://img.shields.io/github/license/BillyMuthiani/Kronyx?style=for-the-badge)](LICENSE)
[![Tests](https://img.shields.io/github/actions/workflow/status/BillyMuthiani/Kronyx/tests.yml?style=for-the-badge&label=Tests)](https://github.com/BillyMuthiani/Kronyx/actions)
[![Documentation](https://img.shields.io/badge/docs-online-blue?style=for-the-badge)](https://kronyx.github.io/kronyx)

</p>

---

## Why Kronyx?

Most deep learning frameworks are designed primarily for production.

**Kronyx is designed to help you understand deep learning.**

Whether you're learning neural networks, teaching machine learning, prototyping new ideas, or building lightweight AI applications, Kronyx provides a familiar Keras-like API with tools that make every layer transparent.

### What makes Kronyx different?

- Built entirely from **NumPy**
- Designed for **education first**
- 📈 Built-in training visualizations (`history.plot()`)
- Rich model inspection (`model.summary()`)
- Architecture visualization (`model.visualize()`)
- Native `.krx` model serialization
- ⚡ Lightweight with zero heavyweight ML dependencies
- Familiar Sequential API inspired by Keras
- 📦 Installable directly from PyPI

---

## 🚀 Installation

```bash
pip install kronyx
```

For development:

```bash
git clone https://github.com/BillyMuthiani/Kronyx.git

cd Kronyx

pip install -e ".[dev]"
```

For plotting support:

```bash
pip install kronyx[plotting]
```

For DataFrame support:

```bash
pip install kronyx[dataframe]
```

---

## ⚡ Quick Example

```python
import numpy as np
from kronyx import *

X = np.array([
    [0,0],
    [0,1],
    [1,0],
    [1,1]
])

y = 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(),
    metric=Accuracy()
)

history = model.fit(X,y,epochs=1000)

history.plot()

model.summary()

model.visualize()

model.save("xor.krx")
```

---

# Features

| Category | Features |
|:---------|:---------|
| **Core** | Pure NumPy backend, Keras-like Sequential API |
| **Education** | Built for learning neural networks, `model.summary()`, `model.visualize()` |
| **Visualization** | `history.plot()`, `plot_decision_boundary()`, `plot_confusion_matrix()`, `plot_dataset()`, `plot_predictions()`, `plot_feature_space()` |
| **Optimization** | SGD, Adam |
| **Losses** | BinaryCrossEntropy, CategoricalCrossEntropy, SoftmaxCategoricalCrossEntropy |
| **Metrics** | Accuracy, BinaryAccuracy, CategoricalAccuracy, Precision, Recall, F1Score, ConfusionMatrix, TopKAccuracy |
| **Callbacks** | EarlyStopping, CSVLogger, ModelCheckpoint, ReduceLROnPlateau |
| **Preprocessing** | StandardScaler, MinMaxScaler, RobustScaler, OneHotEncoder |
| **Datasets** | xor, spiral, circles, moons, blobs, iris |
| **Data Utilities** | train_test_split, BatchLoader, TensorDataset |
| **Serialization** | `.krx` format |
| **Quality** | mypy type checking, Ruff linting |
| **Distribution** | PyPI |

---

# 📚 Documentation

| Guide | Description |
|--------|-------------|
| [Getting Started](docs/getting_started.md) | Installation and first model |
| [Sequential API](docs/sequential.md) | Building models |
| [Layers](docs/layers.md) | Dense, Conv2D, Flatten, Dropout |
| [Callbacks](docs/callbacks.md) | EarlyStopping, CSVLogger |
| [Serialization](docs/serialization.md) | Saving and loading `.krx` models |
| [Examples](docs/examples.md) | Complete working examples |
| [Roadmap](ROADMAP.md) | Future development |
| [Changelog](CHANGELOG.md) | Release history |

# 🌟 Vision

Kronyx exists to make deep learning understandable.

Instead of treating neural networks as black boxes, Kronyx exposes every layer, every parameter, and every training step through intuitive visualization and inspection tools.

Our mission is to become the best framework for learning how deep learning works under the hood.

---

<p align="center">

Made with ❤️ using NumPy.

⭐ If Kronyx helps you learn or build, consider giving the repository a star.

</p>
