Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mariosieg/magnetron

(WIP) A small but powerful, homemade PyTorch from scratch.
https://github.com/mariosieg/magnetron

artificial-intelligence cpp cuda high-performance-computing machine-learning neuronal-network python pytorch research-project tensorflow tiny

Last synced: about 16 hours ago
JSON representation

(WIP) A small but powerful, homemade PyTorch from scratch.

Host: GitHub
URL: https://github.com/mariosieg/magnetron
Owner: MarioSieg
License: apache-2.0
Created: 2025-01-02T21:25:56.000Z (12 days ago)
Default Branch: master
Last Pushed: 2025-01-11T15:22:09.000Z (3 days ago)
Last Synced: 2025-01-11T16:30:52.339Z (3 days ago)
Topics: artificial-intelligence, cpp, cuda, high-performance-computing, machine-learning, neuronal-network, python, pytorch, research-project, tensorflow, tiny
Language: C++
Homepage:
Size: 19.5 MB
Stars: 473
Watchers: 4
Forks: 19
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        [![Contributors][contributors-shield]][contributors-url]

[![Forks][forks-shield]][forks-url]

[![Stargazers][stars-shield]][stars-url]

[![Issues][issues-shield]][issues-url]

![GitHub Actions Workflow Status](https://img.shields.io/github/actions/workflow/status/MarioSieg/magnetron/cmake-multi-platform.yml?style=for-the-badge)






  

    

  

magnetron

  

    Minimalistic homemade PyTorch alternative, written in C99 and Python.

    


    Explore the docs »

    


    


    View Demo

    |

    Report Bug

    |

    Request Feature

  



  Table of Contents

  


    

      About The Project

    

    

      Getting Started

      

        Prerequisites

        Installation

      

    

    Usage

    Roadmap

    Contributing

    License

  


## About

![ScreenShot](media/xor.png)

This project started as a learning experience and a way to understand the inner workings of PyTorch and other deep learning frameworks.


The goal is to create a minimalistic but still powerful deep learning framework that can be used for research and production.


The framework is written in C99 and Python and is designed to be easy to understand and modify.


### Work in Progress

* The project is still in its early stages and many features are missing.

* Developed by a single person in their free time.

* The project is not yet fully optimized for performance.

## Getting Started

To get a local copy up and running follow these simple steps.


Magnetron itself has **no** Python dependencies except for CFFI to call the C library from Python.


Some examples use matplotlib and numpy for plotting and data generation, but these are not required to use the framework.

### Prerequisites

* Linux, MacOS or Windows

* A C99 compiler (gcc, clang, msvc)

* Python 3.6 or higher

### Installation

*A pip installable package will be provided, as soon as all core features are implemented.*

1. Clone the repo

2. `cd magnetron/python` (VENV recommended).

3. `pip install -r requirements.txt` Install dependencies for examples.

4. `cd magnetron_framework && bash install_wheel_local.sh && cd ../` Install the Magnetron wheel locally, a pip installable package will be provided in the future.

5. `python examples/simple/xor.py` Run the XOR example.

## Usage

See the [Examples](python/examples) directory for examples on how to use the framework.

For usage in C and C++ see the [Unit Tests](test) directory in the root of the project.

## Roadmap

The goal is to implement training and inference for LLMs and other state of the art models, while providing a simple and small codebase that is easy to understand and modify.

- [X] 6 Dimensional, Linearized Tensors

- [X] Dynamic Computation Graph

- [X] Static Computation Graph

- [X] Modern Python API

- [X] High level neural network building blocks

- [X] CPU Compute and optimization

- [X] SIMD Optimized operators (SSE4, AVX2, AVX512, ARM NEON)

- [X] Compressed tensor file format

- [X] Validation and friendly error messages

- [X] Fast, custom memory allocators for CPU and GPU

- [X] Modern PRNGs: Mersenne Twister and PCG

- [X] Automatic differentiation

- [ ] Compute on GPU (Cuda)

- [ ] Other Datatypes (f16, bf16, int8)

- [ ] Multithreaded CPU Compute

- [ ] Distributed Training and Inference

- [ ] CPU and GPU kernel JIT compilation

- [ ] Better examples with real world models (LLMs and state of the art models)

## Contributing

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

## License

Distributed under the Apache 2 License. See `LICENSE.txt` for more information.

## Similar Projects

* [GGML](https://github.com/ggerganov/ggml)

* [TINYGRAD](https://github.com/tinygrad/tinygrad)

* [MICROGRAD](https://github.com/karpathy/micrograd)

(back to top)


[contributors-shield]: https://img.shields.io/github/contributors/MarioSieg/magnetron.svg?style=for-the-badge

[contributors-url]: https://github.com/MarioSieg/magnetron/graphs/contributors

[forks-shield]: https://img.shields.io/github/forks/MarioSieg/magnetron.svg?style=for-the-badge

[forks-url]: https://github.com/MarioSieg/magnetron/network/members

[stars-shield]: https://img.shields.io/github/stars/MarioSieg/magnetron.svg?style=for-the-badge

[stars-url]: https://github.com/MarioSieg/magnetron/stargazers

[issues-shield]: https://img.shields.io/github/issues/MarioSieg/magnetron.svg?style=for-the-badge

[issues-url]: https://github.com/MarioSieg/magnetron/issues

[license-shield]: https://img.shields.io/github/license/MarioSieg/magnetron.svg?style=for-the-badge

[license-url]: https://github.com/MarioSieg/magnetron/blob/master/LICENSE.txt