Metadata-Version: 2.5
Name: pytorchmlx
Version: 0.0.3
Summary: An educational PyTorch-shaped interface for MLX and PyTorch
Author: Priyanshu Jain
License: MIT License
        
        Copyright (c) 2026 Priyanshu Jain
        
        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.
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: mlx<0.33,>=0.32.2
Requires-Dist: numpy
Requires-Dist: torch<3,>=2.4
Description-Content-Type: text/markdown

# torchmlx

torchmlx is a pytorch-shaped compatibility layer that uses mlx on apple silicon and pytorch elsewhere. it is experimental and built first for educational use.

```bash
pip install pytorchmlx
```

```python
import torchmlx as torch
from torchmlx import nn, optim
```

see the [tinystories example](examples/tinystories-llm/train.py) and [compatibility details](docs/compatibility.md).

| backend | 5,000 steps + generation | effective steps/s |
| --- | ---: | ---: |
| torchmlx mlx, m3 pro | 170.27 s | 29.4 |
| pytorch mps, m3 pro | 184.42 s | 27.1 |
