Metadata-Version: 2.4
Name: mlbenchkit
Version: 0.1.0
Summary: Cross-platform ML benchmarking toolkit (CPU/GPU + system specs) for Windows and macOS.
Author: Muhammad Rashid
License: MIT License
        
        Copyright (c) 2025 Muhammad Rashid
        
        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: Homepage, https://github.com/rashidrao-pk/mlbenchkit
Project-URL: Repository, https://github.com/rashidrao-pk/mlbenchkit
Project-URL: Issues, https://github.com/rashidrao-pk/mlbenchkit/issues
Keywords: benchmark,machine-learning,pytorch,cuda,mps,performance,profiling
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: System :: Benchmark
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Operating System :: Microsoft :: Windows
Classifier: Operating System :: MacOS
Classifier: Operating System :: POSIX :: Linux
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: psutil>=5.9
Requires-Dist: py-cpuinfo>=9.0
Provides-Extra: torch
Requires-Dist: torch>=2.0; extra == "torch"
Provides-Extra: sklearn
Requires-Dist: scikit-learn>=1.2; extra == "sklearn"
Requires-Dist: numpy>=1.23; extra == "sklearn"
Dynamic: license-file

# MachineLearningBenchMarkingToolkit

Cross-platform machine-learning benchmarking toolkit to compare **Windows** PCs and **MacBook (Pro/Air)** machines.
It reports **system specs** (CPU cores/frequency, RAM) and runs **lightweight ML-style benchmarks** on:

- **CPU** (always)
- **NVIDIA CUDA GPU** (Windows/Linux, if available)
- **Apple Silicon GPU via MPS** (macOS, if available)

Outputs are saved as JSON files so you can easily compare multiple machines.

## Features

- ✅ Machine specs: hostname, OS, CPU model, cores, CPU freq, RAM totals/available
- ✅ Accelerator info:
  - CUDA: GPU name, total VRAM, compute capability
  - MPS: Apple Silicon (unified memory note)
- ✅ Benchmarks:
  - PyTorch matmul on CPU
  - PyTorch matmul on CUDA/MPS (if available)
  - Optional: scikit-learn RandomForest training benchmark

## Installation

### Minimal
```bash
pip install mlbenchkit
```

### With PyTorch benchmarks
```bash
# With PyTorch benchmarks
pip install "mlbenchkit[torch]"
```

## With scikit-learn benchmark
pip install "mlbenchkit[sklearn]"

## Everything
pip install "mlbenchkit[torch,sklearn]"

```

## How to use it?

```bash
mlbench specs
```

### Run benchmark suite (saves a JSON file):

```bash
mlbench run
# Run with sklearn benchmark:
mlbench run --with-sklearn
## Customize workload:
mlbench run --cpu-N 2048 --gpu-N 4096 --iters 50 --warmup 20 --gpu-dtype float16

```


