Metadata-Version: 2.4
Name: neuralfabric
Version: 0.7.1
Summary: A from-scratch machine learning and deep learning framework, from tensors to transformers.
Author-email: Aryan Patel <aryanpatel2906.ap@gmail.com>
License: MIT License
        
        Copyright (c) 2026 NeuralFabric 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.
        
Project-URL: Repository, https://github.com/aryanap07/neuralfabric
Project-URL: Issues, https://github.com/aryanap07/neuralfabric/issues
Keywords: machine-learning,deep-learning,transformer,neural-network,autograd
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: numpy>=1.23
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: pytest-cov; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: ruff; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Requires-Dist: pre-commit; extra == "dev"
Requires-Dist: build; extra == "dev"
Requires-Dist: twine; extra == "dev"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-rtd-theme; extra == "docs"
Provides-Extra: viz
Requires-Dist: matplotlib; extra == "viz"
Dynamic: license-file

# NeuralFabric

A from-scratch machine learning and deep learning framework, from tensors to transformers.

## Features

* Tensor engine built on NumPy
* Automatic differentiation (Autograd)
* Linear Regression
* Logistic Regression
* Train-test split utility
* Modern Python packaging
* Type-safe codebase with MyPy
* Ruff, Black, Pytest, and GitHub Actions integration

## Installation

```bash
pip install -U neuralfabric
```

For development:

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

## Quick Start

```python
from neuralfabric.linear_model import LinearRegression
from neuralfabric.model_selection import train_test_split

X_train, X_test, y_train, y_test = train_test_split(
    X,
    y,
    test_size=0.2,
)

model = LinearRegression()
model.fit(X_train, y_train)

predictions = model.predict(X_test)
```

## Project Structure

```text
src/neuralfabric/
├── core/               # Tensor + autograd engine
├── linear_model/       # Linear Regression, Logistic Regression
├── model_selection/    # train_test_split
└── utils/              # Utility functions
```

## Roadmap

### Completed

* [x] Tensor implementation
* [x] Automatic differentiation engine
* [x] Linear Regression
* [x] Logistic Regression
* [x] Train-test split utility
* [x] Unit testing
* [x] CI/CD workflows
* [x] PyPI publishing

### Upcoming

* [ ] Ridge Regression
* [ ] Lasso Regression
* [ ] Elastic Net
* [ ] Decision Trees
* [ ] Random Forests
* [ ] Support Vector Machines
* [ ] K-Means Clustering
* [ ] PCA
* [ ] Neural Network API
* [ ] Optimizers (SGD, Adam)
* [ ] Transformer Architecture
* [ ] Documentation Website

## Development

```bash
make dev
make test
make lint
make format
make build
make publish
```

## License

MIT License. See LICENSE for details.
