nanogemm 0.3.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (36) hide show
  1. nanogemm-0.3.0/LICENSE +21 -0
  2. nanogemm-0.3.0/MANIFEST.in +9 -0
  3. nanogemm-0.3.0/PKG-INFO +214 -0
  4. nanogemm-0.3.0/README.md +182 -0
  5. nanogemm-0.3.0/asm/README.md +86 -0
  6. nanogemm-0.3.0/asm/build.bat +73 -0
  7. nanogemm-0.3.0/asm/nanogemm32.asm +27 -0
  8. nanogemm-0.3.0/asm/nanogemm32.dll +0 -0
  9. nanogemm-0.3.0/asm/nanogemm32_kernel.inc +504 -0
  10. nanogemm-0.3.0/asm/nanogemm64.asm +34 -0
  11. nanogemm-0.3.0/asm/nanogemm64.dll +0 -0
  12. nanogemm-0.3.0/asm/nanogemm64_kernel.inc +584 -0
  13. nanogemm-0.3.0/asm/test_nanogemm32.asm +371 -0
  14. nanogemm-0.3.0/asm/test_nanogemm32.exe +0 -0
  15. nanogemm-0.3.0/asm/test_nanogemm64.asm +360 -0
  16. nanogemm-0.3.0/asm/test_nanogemm64.exe +0 -0
  17. nanogemm-0.3.0/benchmarks/bench_c.c +58 -0
  18. nanogemm-0.3.0/benchmarks/bench_vs_numpy.py +105 -0
  19. nanogemm-0.3.0/nanogemm/__init__.py +8 -0
  20. nanogemm-0.3.0/nanogemm/core.py +367 -0
  21. nanogemm-0.3.0/nanogemm/nanogemm.dll +0 -0
  22. nanogemm-0.3.0/nanogemm/nanogemm32.dll +0 -0
  23. nanogemm-0.3.0/nanogemm/nanogemm64.dll +0 -0
  24. nanogemm-0.3.0/nanogemm.egg-info/PKG-INFO +214 -0
  25. nanogemm-0.3.0/nanogemm.egg-info/SOURCES.txt +34 -0
  26. nanogemm-0.3.0/nanogemm.egg-info/dependency_links.txt +1 -0
  27. nanogemm-0.3.0/nanogemm.egg-info/requires.txt +6 -0
  28. nanogemm-0.3.0/nanogemm.egg-info/top_level.txt +1 -0
  29. nanogemm-0.3.0/pyproject.toml +51 -0
  30. nanogemm-0.3.0/setup.cfg +4 -0
  31. nanogemm-0.3.0/setup.py +29 -0
  32. nanogemm-0.3.0/src/nanogemm_kernel.c +222 -0
  33. nanogemm-0.3.0/src/nanogemm_kernel.h +44 -0
  34. nanogemm-0.3.0/src/nanogemm_pyext.c +151 -0
  35. nanogemm-0.3.0/tests/test_correctness.py +132 -0
  36. nanogemm-0.3.0/tests/test_fasm.py +253 -0
nanogemm-0.3.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 eminsk
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,9 @@
1
+ include LICENSE
2
+ include README.md
3
+ include pyproject.toml
4
+ include src/*.h
5
+ include src/*.c
6
+ recursive-include tests *.py
7
+ recursive-include benchmarks *.py *.c
8
+ recursive-include asm *.asm *.inc *.dll *.exe *.bat *.md
9
+ recursive-include nanogemm *.dll *.so *.dylib
@@ -0,0 +1,214 @@
1
+ Metadata-Version: 2.4
2
+ Name: nanogemm
3
+ Version: 0.3.0
4
+ Summary: Minimalist, bare-metal SIMD & Assembly GEMM engine for Python. Sub-microsecond CPU matrix multiplication for AI & scientific computing.
5
+ Author-email: eminsk <M_N_Nik@yahoo.com>
6
+ License: MIT
7
+ Project-URL: Homepage, https://github.com/eminsk/nanogemm
8
+ Project-URL: Repository, https://github.com/eminsk/nanogemm
9
+ Project-URL: Issues, https://github.com/eminsk/nanogemm/issues
10
+ Keywords: gemm,matrix-multiplication,simd,assembly,fasm,avx2,cpu-inference,deep-learning,high-performance-computing
11
+ Classifier: Development Status :: 4 - Beta
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: Science/Research
14
+ Classifier: Operating System :: OS Independent
15
+ Classifier: Programming Language :: Python :: 3
16
+ Classifier: Programming Language :: Python :: 3.9
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Programming Language :: Python :: 3.14
22
+ Classifier: Programming Language :: Python :: 3.15
23
+ Classifier: Programming Language :: C
24
+ Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
25
+ Classifier: Topic :: Scientific/Engineering :: Mathematics
26
+ Requires-Python: >=3.9
27
+ Description-Content-Type: text/markdown
28
+ License-File: LICENSE
29
+ Requires-Dist: numpy<2.3.0,>=1.20.0; python_version <= "3.13"
30
+ Requires-Dist: numpy>=2.3.0; python_version >= "3.14"
31
+ Dynamic: license-file
32
+
33
+ # NanoGEMM ⚡
34
+
35
+ [![PyPI](https://img.shields.io/pypi/v/nanogemm.svg?color=blue)](https://pypi.org/project/nanogemm/)
36
+ [![CI](https://github.com/eminsk/nanogemm/actions/workflows/ci.yml/badge.svg)](https://github.com/eminsk/nanogemm/actions)
37
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
38
+ [![Python](https://img.shields.io/badge/Python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14%20%7C%203.15-blue)](https://pypi.org/project/nanogemm/)
39
+ [![SIMD](https://img.shields.io/badge/SIMD-AVX2%20%2B%20FMA%20(256--bit)-brightgreen)](https://github.com/eminsk/nanogemm)
40
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/eminsk/nanogemm/blob/main/notebooks/benchmark.ipynb)
41
+ [![Footprint](https://img.shields.io/badge/Binary-~100_KB-orange)](https://github.com/eminsk/nanogemm)
42
+ [![Dev.to](https://img.shields.io/badge/Dev.to-Read%20Article-0a0a0a?logo=devdotto)](https://dev.to/eminsk/how-i-beat-numpy-matrix-multiplication-by-28x-with-a-100kb-c-microkernel-82k)
43
+
44
+ **NanoGEMM** is a minimalist, bare-metal General Matrix Multiplication (GEMM) engine designed for sub-microsecond CPU inference and high-performance computing in Python.
45
+
46
+ Built with direct **AVX2 / FMA (256-bit SIMD)** assembly-level register tiling and cache blocking, NanoGEMM eliminates the heavy function-call dispatch, thread-pool barriers, and memory-packing overhead of heavyweight BLAS libraries (OpenBLAS, MKL) for small-to-medium tensors.
47
+
48
+ ---
49
+
50
+ ## 🚀 Performance Benchmarks
51
+
52
+ Measured on **Intel/AMD x86-64 CPU (AVX2 + FMA)** against **NumPy 2.2.3** (single-precision `float32`):
53
+
54
+ | Matrix Dimension | NumPy 2.2.3 Latency | NanoGEMM Latency | Speedup Factor | NanoGEMM Throughput |
55
+ | :--- | :---: | :---: | :---: | :---: |
56
+ | **`16 x 16`** | `3.21 µs` | **`1.23 µs`** (C: `0.65 µs`) | 🚀 **2.83x FASTER** | `2.83 GFLOPS` |
57
+ | **`32 x 32`** | `5.75 µs` | **`2.74 µs`** (C: `2.18 µs`) | 🚀 **2.26x FASTER** | `15.13 GFLOPS` |
58
+ | **`64 x 64`** | `18.70 µs` | **`17.76 µs`** (C: `16.39 µs`) | 🚀 **1.10x FASTER** | `27.08 GFLOPS` |
59
+ | **`128 x 128`** | `114.07 µs` | `182.46 µs` | `0.60x` | `23.42 GFLOPS` |
60
+ | **`256 x 256`** | `426.24 µs` | `1501.24 µs` | `0.28x` | `22.35 GFLOPS` |
61
+
62
+ > 💡 **Why is NanoGEMM faster on small/medium matrices?**
63
+ > Traditional BLAS engines incur 3–10 µs of fixed overhead per invocation due to dynamic runtime dispatch, argument sanitization, thread synchronization, and packing buffers. NanoGEMM utilizes a zero-allocation, direct register-tiled microkernel that executes in **sub-microsecond time** immediately upon invocation.
64
+
65
+ ### ⚙️ Benchmark Environment & Test Configuration
66
+
67
+ | Parameter | Specification |
68
+ | :--- | :--- |
69
+ | **CPU Architecture** | x86-64 with AVX2 (256-bit SIMD) + FMA3 support |
70
+ | **Execution Model** | **Single-Core / Single-Threaded (1 Thread)** for NanoGEMM (zero thread-pool overhead) |
71
+ | **NumPy Baseline** | NumPy 2.2+ linked against OpenBLAS (standard runtime) |
72
+ | **C Compiler** | GCC (`-O3 -mavx2 -mfma`) / MSVC (`/O2 /arch:AVX2`) |
73
+ | **Methodology** | Median latency across 10,000 iterations per size with cache pre-warming |
74
+ | **Data Type** | IEEE-754 Single-Precision (`float32`), contiguous C-order layout |
75
+
76
+ > 📌 **Single-Thread Design Note:** NanoGEMM runs strictly on a single CPU core without thread pools, pthreads, or mutex barriers. For small matrices ($16 \times 16$ to $64 \times 64$), thread synchronization in OpenMP costs more cycles than the matrix multiply itself. NumPy/OpenBLAS incurs dispatch latency, whereas NanoGEMM enters CPU registers directly.
77
+
78
+ ---
79
+
80
+ ## 🛠 Architectural Design
81
+
82
+ ### 1. Register Tiling ($6 \times 16$ Microkernel)
83
+ * **Register allocation:** Utilizes 12 `ymm` registers (`ymm0` – `ymm11`) as 256-bit floating-point accumulators storing a $6 \times 16$ tile of matrix $C$.
84
+ * **Vector broadcast & FMA:** Two `ymm` registers load vectors from $B$, while individual scalar elements of $A$ are broadcast across `ymm` using `_mm256_set1_ps` and accumulated via fused multiply-add (`_mm256_fmadd_ps`).
85
+ * **Zero Spilling:** Fits completely inside the 16 available x86-64 YMM registers without stack eviction.
86
+
87
+ ### 2. Multi-Level Cache Blocking
88
+ * **$L_1$ / $L_2$ Cache Tiling:** Matrices are processed in cache blocks ($M_c = 64, N_c = 128, K_c = 128$) to maintain maximum L1/L2 data cache hit ratios and eliminate memory bus thrashing.
89
+ * **Vectorized Edge Handling:** Arbitrary matrix dimensions (non-multiples of 6 or 16) are processed using boundary SIMD edge loops without padding or buffer allocations.
90
+
91
+ ```
92
+ Matrix A (M x K) Matrix B (K x N)
93
+ [ . . . . . . . . ] [ . . . ymm0 . . . ]
94
+ [ . . . . . . . . ] [ . . . ymm1 . . . ]
95
+ [ a0 a1 a2 a3 . . ] x [ . . . . . . . . ]
96
+ [ . . . . . . . . ] [ . . . . . . . . ]
97
+ [ . . . . . . . . ]
98
+ │ │
99
+ └──────────────┬──────────────┘
100
+
101
+ Matrix C (6 x 16 Tile)
102
+ [ ymm0 ymm1 ] -> Row 0
103
+ [ ymm2 ymm3 ] -> Row 1
104
+ [ ymm4 ymm5 ] -> Row 2
105
+ [ ymm6 ymm7 ] -> Row 3
106
+ [ ymm8 ymm9 ] -> Row 4
107
+ [ ymm10 ymm11 ] -> Row 5
108
+ ```
109
+
110
+ ---
111
+
112
+ ## 📦 Installation & Quickstart
113
+
114
+ ### Installation via PyPI (Recommended)
115
+ ```bash
116
+ pip install nanogemm
117
+ # or with uv
118
+ uv add nanogemm
119
+ ```
120
+
121
+ > **Python Compatibility:** Fully tested and verified across **Python 3.9 through 3.15 (including 3.15.0rc2)**.
122
+ >
123
+ > ⚡ **No-GIL & Free-Threaded Ready (PEP 703):**
124
+ > * **Free-Threaded CPython:** Explicitly declares `Py_MOD_GIL_NOT_USED` to run safely without re-enabling the GIL under `python3.13t`, `3.14t`, and `3.15t`.
125
+ > * **GIL-Releasing Operations:** Automatically releases the GIL (`Py_BEGIN_ALLOW_THREADS`) during hardware SIMD execution, allowing Python threads (`threading.Thread`, `ThreadPoolExecutor`) to run matrix multiplications concurrently across multiple CPU cores without lock contention.
126
+
127
+ ### Build from Source
128
+ ```bash
129
+ git clone https://github.com/eminsk/nanogemm.git
130
+ cd nanogemm
131
+ pip install -e .
132
+ ```
133
+
134
+ ### Python Usage
135
+ ```python
136
+ import nanogemm as ng
137
+ import numpy as np
138
+
139
+ # Verify SIMD hardware acceleration
140
+ print("Active ISA:", ng.get_simd_isa())
141
+ # Output: Active ISA: AVX2+FMA (256-bit SIMD, 6x16 register tiling)
142
+
143
+ # Allocate input matrices
144
+ A = np.random.randn(32, 64).astype(np.float32)
145
+ B = np.random.randn(64, 128).astype(np.float32)
146
+
147
+ # Direct hardware-accelerated MatMul: C = A @ B
148
+ C = ng.matmul(A, B)
149
+
150
+ # Or with pre-allocated zero-copy output buffer for maximum performance:
151
+ out = np.empty((32, 128), dtype=np.float32)
152
+ ng.matmul(A, B, out=out)
153
+
154
+ # Standard BLAS SGEMM interface: C = alpha * (A @ B) + beta * C
155
+ res = ng.sgemm(A, B, alpha=2.0, beta=0.5, c=out)
156
+ ```
157
+
158
+ ---
159
+
160
+ ## 🧪 Testing & Verification
161
+
162
+ Run the comprehensive correctness test suite comparing NanoGEMM with NumPy reference outputs across random uniforms, normals, non-square dimensions, and prime shapes:
163
+
164
+ ```bash
165
+ python tests/test_correctness.py
166
+ ```
167
+
168
+ Run the official benchmark against your installed NumPy BLAS:
169
+
170
+ ```bash
171
+ python benchmarks/bench_vs_numpy.py
172
+ ```
173
+
174
+ ---
175
+
176
+ ## ⚡ Standalone Flat Assembler (FASM) 32-bit & 64-bit Engines
177
+
178
+ NanoGEMM includes native standalone assembly implementations written in **Flat Assembler (FASM)** for both 64-bit and 32-bit architectures in the [`asm/`](file:///C:/proekts/nanogemm/asm) directory:
179
+
180
+ * **x86-64 Engine (`asm/nanogemm64.dll`, `asm/test_nanogemm64.exe`)**:
181
+ * Microkernel with $4 \times 16$ and $4 \times 8$ register-tiled AVX2+FMA instructions (`vfmadd231ps`, `vbroadcastss`, `vmovups`).
182
+ * Complies strictly with the Microsoft x64 ABI (preserving non-volatile registers `RBX`, `RSI`, `RDI`, `R12`–`R15`, `XMM6`–`XMM15`).
183
+ * Peak throughput exceeding **38–40 GFLOPS** on a single CPU core.
184
+ * **x86 32-bit Engine (`asm/nanogemm32.dll`, `asm/test_nanogemm32.exe`)**:
185
+ * Vectorized $4 \times 4$ SSE2 microkernel (`movups`, `shufps`, `mulps`, `addps`) using `cdecl` calling convention.
186
+ * Compatible with all 32-bit x86 environments and 64-bit Windows via WoW64 with zero external dependencies.
187
+ * Delivers **13–15 GFLOPS** in pure 32-bit mode.
188
+
189
+ ### Building & Running FASM Tests
190
+ ```cmd
191
+ :: Build all 4 binaries and run native executable suites
192
+ cd asm
193
+ build.bat
194
+
195
+ :: Run Python verification and NumPy comparison suite
196
+ python tests/test_fasm.py
197
+ ```
198
+
199
+ ---
200
+
201
+ ## 🌐 High-Performance Systems Ecosystem
202
+
203
+ NanoGEMM is developed by [**@eminsk**](https://github.com/eminsk) as part of an engineering ecosystem focused on low-level hardware performance, assembly programming, and native desktop computing:
204
+
205
+ * 🎥 [**screenvideo**](https://github.com/eminsk/screenvideo) — Lightweight desktop screen recorder featuring WASAPI loopback audio and a standalone pure x64 Flat Assembler (FASM) native edition.
206
+ * 📊 [**xlsx_vievers**](https://github.com/eminsk/xlsx_vievers) — Desktop spreadsheet processor with 80+ formula functions, Chart Wizard, and hardware-accelerated SIMD SSE2 math engine.
207
+ * 📈 [**yfinance-ta-patterns**](https://github.com/eminsk/yfinance-ta-patterns) — Candlestick pattern scanner and AI ranking suite powered by TA-Lib and quantitative backtesting.
208
+ * 🔍 [**StackOverflowAPI**](https://github.com/eminsk/StackOverflowAPI) — Desktop client for Stack Overflow built with CustomTkinter and native FASM x64 search client.
209
+
210
+ ---
211
+
212
+ ## 📄 License
213
+
214
+ MIT License — Copyright (c) 2026 [eminsk](https://github.com/eminsk).
@@ -0,0 +1,182 @@
1
+ # NanoGEMM ⚡
2
+
3
+ [![PyPI](https://img.shields.io/pypi/v/nanogemm.svg?color=blue)](https://pypi.org/project/nanogemm/)
4
+ [![CI](https://github.com/eminsk/nanogemm/actions/workflows/ci.yml/badge.svg)](https://github.com/eminsk/nanogemm/actions)
5
+ [![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
6
+ [![Python](https://img.shields.io/badge/Python-3.10%20%7C%203.11%20%7C%203.12%20%7C%203.13%20%7C%203.14%20%7C%203.15-blue)](https://pypi.org/project/nanogemm/)
7
+ [![SIMD](https://img.shields.io/badge/SIMD-AVX2%20%2B%20FMA%20(256--bit)-brightgreen)](https://github.com/eminsk/nanogemm)
8
+ [![Open In Colab](https://colab.research.google.com/assets/colab-badge.svg)](https://colab.research.google.com/github/eminsk/nanogemm/blob/main/notebooks/benchmark.ipynb)
9
+ [![Footprint](https://img.shields.io/badge/Binary-~100_KB-orange)](https://github.com/eminsk/nanogemm)
10
+ [![Dev.to](https://img.shields.io/badge/Dev.to-Read%20Article-0a0a0a?logo=devdotto)](https://dev.to/eminsk/how-i-beat-numpy-matrix-multiplication-by-28x-with-a-100kb-c-microkernel-82k)
11
+
12
+ **NanoGEMM** is a minimalist, bare-metal General Matrix Multiplication (GEMM) engine designed for sub-microsecond CPU inference and high-performance computing in Python.
13
+
14
+ Built with direct **AVX2 / FMA (256-bit SIMD)** assembly-level register tiling and cache blocking, NanoGEMM eliminates the heavy function-call dispatch, thread-pool barriers, and memory-packing overhead of heavyweight BLAS libraries (OpenBLAS, MKL) for small-to-medium tensors.
15
+
16
+ ---
17
+
18
+ ## 🚀 Performance Benchmarks
19
+
20
+ Measured on **Intel/AMD x86-64 CPU (AVX2 + FMA)** against **NumPy 2.2.3** (single-precision `float32`):
21
+
22
+ | Matrix Dimension | NumPy 2.2.3 Latency | NanoGEMM Latency | Speedup Factor | NanoGEMM Throughput |
23
+ | :--- | :---: | :---: | :---: | :---: |
24
+ | **`16 x 16`** | `3.21 µs` | **`1.23 µs`** (C: `0.65 µs`) | 🚀 **2.83x FASTER** | `2.83 GFLOPS` |
25
+ | **`32 x 32`** | `5.75 µs` | **`2.74 µs`** (C: `2.18 µs`) | 🚀 **2.26x FASTER** | `15.13 GFLOPS` |
26
+ | **`64 x 64`** | `18.70 µs` | **`17.76 µs`** (C: `16.39 µs`) | 🚀 **1.10x FASTER** | `27.08 GFLOPS` |
27
+ | **`128 x 128`** | `114.07 µs` | `182.46 µs` | `0.60x` | `23.42 GFLOPS` |
28
+ | **`256 x 256`** | `426.24 µs` | `1501.24 µs` | `0.28x` | `22.35 GFLOPS` |
29
+
30
+ > 💡 **Why is NanoGEMM faster on small/medium matrices?**
31
+ > Traditional BLAS engines incur 3–10 µs of fixed overhead per invocation due to dynamic runtime dispatch, argument sanitization, thread synchronization, and packing buffers. NanoGEMM utilizes a zero-allocation, direct register-tiled microkernel that executes in **sub-microsecond time** immediately upon invocation.
32
+
33
+ ### ⚙️ Benchmark Environment & Test Configuration
34
+
35
+ | Parameter | Specification |
36
+ | :--- | :--- |
37
+ | **CPU Architecture** | x86-64 with AVX2 (256-bit SIMD) + FMA3 support |
38
+ | **Execution Model** | **Single-Core / Single-Threaded (1 Thread)** for NanoGEMM (zero thread-pool overhead) |
39
+ | **NumPy Baseline** | NumPy 2.2+ linked against OpenBLAS (standard runtime) |
40
+ | **C Compiler** | GCC (`-O3 -mavx2 -mfma`) / MSVC (`/O2 /arch:AVX2`) |
41
+ | **Methodology** | Median latency across 10,000 iterations per size with cache pre-warming |
42
+ | **Data Type** | IEEE-754 Single-Precision (`float32`), contiguous C-order layout |
43
+
44
+ > 📌 **Single-Thread Design Note:** NanoGEMM runs strictly on a single CPU core without thread pools, pthreads, or mutex barriers. For small matrices ($16 \times 16$ to $64 \times 64$), thread synchronization in OpenMP costs more cycles than the matrix multiply itself. NumPy/OpenBLAS incurs dispatch latency, whereas NanoGEMM enters CPU registers directly.
45
+
46
+ ---
47
+
48
+ ## 🛠 Architectural Design
49
+
50
+ ### 1. Register Tiling ($6 \times 16$ Microkernel)
51
+ * **Register allocation:** Utilizes 12 `ymm` registers (`ymm0` – `ymm11`) as 256-bit floating-point accumulators storing a $6 \times 16$ tile of matrix $C$.
52
+ * **Vector broadcast & FMA:** Two `ymm` registers load vectors from $B$, while individual scalar elements of $A$ are broadcast across `ymm` using `_mm256_set1_ps` and accumulated via fused multiply-add (`_mm256_fmadd_ps`).
53
+ * **Zero Spilling:** Fits completely inside the 16 available x86-64 YMM registers without stack eviction.
54
+
55
+ ### 2. Multi-Level Cache Blocking
56
+ * **$L_1$ / $L_2$ Cache Tiling:** Matrices are processed in cache blocks ($M_c = 64, N_c = 128, K_c = 128$) to maintain maximum L1/L2 data cache hit ratios and eliminate memory bus thrashing.
57
+ * **Vectorized Edge Handling:** Arbitrary matrix dimensions (non-multiples of 6 or 16) are processed using boundary SIMD edge loops without padding or buffer allocations.
58
+
59
+ ```
60
+ Matrix A (M x K) Matrix B (K x N)
61
+ [ . . . . . . . . ] [ . . . ymm0 . . . ]
62
+ [ . . . . . . . . ] [ . . . ymm1 . . . ]
63
+ [ a0 a1 a2 a3 . . ] x [ . . . . . . . . ]
64
+ [ . . . . . . . . ] [ . . . . . . . . ]
65
+ [ . . . . . . . . ]
66
+ │ │
67
+ └──────────────┬──────────────┘
68
+
69
+ Matrix C (6 x 16 Tile)
70
+ [ ymm0 ymm1 ] -> Row 0
71
+ [ ymm2 ymm3 ] -> Row 1
72
+ [ ymm4 ymm5 ] -> Row 2
73
+ [ ymm6 ymm7 ] -> Row 3
74
+ [ ymm8 ymm9 ] -> Row 4
75
+ [ ymm10 ymm11 ] -> Row 5
76
+ ```
77
+
78
+ ---
79
+
80
+ ## 📦 Installation & Quickstart
81
+
82
+ ### Installation via PyPI (Recommended)
83
+ ```bash
84
+ pip install nanogemm
85
+ # or with uv
86
+ uv add nanogemm
87
+ ```
88
+
89
+ > **Python Compatibility:** Fully tested and verified across **Python 3.9 through 3.15 (including 3.15.0rc2)**.
90
+ >
91
+ > ⚡ **No-GIL & Free-Threaded Ready (PEP 703):**
92
+ > * **Free-Threaded CPython:** Explicitly declares `Py_MOD_GIL_NOT_USED` to run safely without re-enabling the GIL under `python3.13t`, `3.14t`, and `3.15t`.
93
+ > * **GIL-Releasing Operations:** Automatically releases the GIL (`Py_BEGIN_ALLOW_THREADS`) during hardware SIMD execution, allowing Python threads (`threading.Thread`, `ThreadPoolExecutor`) to run matrix multiplications concurrently across multiple CPU cores without lock contention.
94
+
95
+ ### Build from Source
96
+ ```bash
97
+ git clone https://github.com/eminsk/nanogemm.git
98
+ cd nanogemm
99
+ pip install -e .
100
+ ```
101
+
102
+ ### Python Usage
103
+ ```python
104
+ import nanogemm as ng
105
+ import numpy as np
106
+
107
+ # Verify SIMD hardware acceleration
108
+ print("Active ISA:", ng.get_simd_isa())
109
+ # Output: Active ISA: AVX2+FMA (256-bit SIMD, 6x16 register tiling)
110
+
111
+ # Allocate input matrices
112
+ A = np.random.randn(32, 64).astype(np.float32)
113
+ B = np.random.randn(64, 128).astype(np.float32)
114
+
115
+ # Direct hardware-accelerated MatMul: C = A @ B
116
+ C = ng.matmul(A, B)
117
+
118
+ # Or with pre-allocated zero-copy output buffer for maximum performance:
119
+ out = np.empty((32, 128), dtype=np.float32)
120
+ ng.matmul(A, B, out=out)
121
+
122
+ # Standard BLAS SGEMM interface: C = alpha * (A @ B) + beta * C
123
+ res = ng.sgemm(A, B, alpha=2.0, beta=0.5, c=out)
124
+ ```
125
+
126
+ ---
127
+
128
+ ## 🧪 Testing & Verification
129
+
130
+ Run the comprehensive correctness test suite comparing NanoGEMM with NumPy reference outputs across random uniforms, normals, non-square dimensions, and prime shapes:
131
+
132
+ ```bash
133
+ python tests/test_correctness.py
134
+ ```
135
+
136
+ Run the official benchmark against your installed NumPy BLAS:
137
+
138
+ ```bash
139
+ python benchmarks/bench_vs_numpy.py
140
+ ```
141
+
142
+ ---
143
+
144
+ ## ⚡ Standalone Flat Assembler (FASM) 32-bit & 64-bit Engines
145
+
146
+ NanoGEMM includes native standalone assembly implementations written in **Flat Assembler (FASM)** for both 64-bit and 32-bit architectures in the [`asm/`](file:///C:/proekts/nanogemm/asm) directory:
147
+
148
+ * **x86-64 Engine (`asm/nanogemm64.dll`, `asm/test_nanogemm64.exe`)**:
149
+ * Microkernel with $4 \times 16$ and $4 \times 8$ register-tiled AVX2+FMA instructions (`vfmadd231ps`, `vbroadcastss`, `vmovups`).
150
+ * Complies strictly with the Microsoft x64 ABI (preserving non-volatile registers `RBX`, `RSI`, `RDI`, `R12`–`R15`, `XMM6`–`XMM15`).
151
+ * Peak throughput exceeding **38–40 GFLOPS** on a single CPU core.
152
+ * **x86 32-bit Engine (`asm/nanogemm32.dll`, `asm/test_nanogemm32.exe`)**:
153
+ * Vectorized $4 \times 4$ SSE2 microkernel (`movups`, `shufps`, `mulps`, `addps`) using `cdecl` calling convention.
154
+ * Compatible with all 32-bit x86 environments and 64-bit Windows via WoW64 with zero external dependencies.
155
+ * Delivers **13–15 GFLOPS** in pure 32-bit mode.
156
+
157
+ ### Building & Running FASM Tests
158
+ ```cmd
159
+ :: Build all 4 binaries and run native executable suites
160
+ cd asm
161
+ build.bat
162
+
163
+ :: Run Python verification and NumPy comparison suite
164
+ python tests/test_fasm.py
165
+ ```
166
+
167
+ ---
168
+
169
+ ## 🌐 High-Performance Systems Ecosystem
170
+
171
+ NanoGEMM is developed by [**@eminsk**](https://github.com/eminsk) as part of an engineering ecosystem focused on low-level hardware performance, assembly programming, and native desktop computing:
172
+
173
+ * 🎥 [**screenvideo**](https://github.com/eminsk/screenvideo) — Lightweight desktop screen recorder featuring WASAPI loopback audio and a standalone pure x64 Flat Assembler (FASM) native edition.
174
+ * 📊 [**xlsx_vievers**](https://github.com/eminsk/xlsx_vievers) — Desktop spreadsheet processor with 80+ formula functions, Chart Wizard, and hardware-accelerated SIMD SSE2 math engine.
175
+ * 📈 [**yfinance-ta-patterns**](https://github.com/eminsk/yfinance-ta-patterns) — Candlestick pattern scanner and AI ranking suite powered by TA-Lib and quantitative backtesting.
176
+ * 🔍 [**StackOverflowAPI**](https://github.com/eminsk/StackOverflowAPI) — Desktop client for Stack Overflow built with CustomTkinter and native FASM x64 search client.
177
+
178
+ ---
179
+
180
+ ## 📄 License
181
+
182
+ MIT License — Copyright (c) 2026 [eminsk](https://github.com/eminsk).
@@ -0,0 +1,86 @@
1
+ # NanoGEMM � Native Flat Assembler (FASM) Acceleration Suite ?
2
+
3
+ Direct hardware assembly implementation of single-precision matrix multiplication (SGEMM) for both **x86-64 (64-bit AVX2+FMA)** and **x86 (32-bit SSE2)** architectures, written with [Flat Assembler (FASM)](https://flatassembler.net/).
4
+
5
+ ---
6
+
7
+ ## ?? Architecture & Components
8
+
9
+ ```
10
+ asm/
11
+ +-- nanogemm64_kernel.inc # 64-bit AVX2+FMA register-tiled (4x16, 4x8) microkernels & SGEMM driver
12
+ +-- nanogemm64.asm # PE64 DLL source exporting nanogemm_matmul, nanogemm_sgemm
13
+ +-- nanogemm64.dll # Compiled 64-bit Windows DLL (callable from C, C++, Python ctypes)
14
+ +-- test_nanogemm64.asm # Standalone PE64 console benchmark & self-test suite
15
+ +-- test_nanogemm64.exe # Compiled 64-bit native executable (zero runtime dependencies)
16
+ +-- nanogemm32_kernel.inc # 32-bit SSE2 register-tiled (4x4) microkernels & SGEMM driver
17
+ +-- nanogemm32.asm # PE32 DLL source exporting nanogemm_matmul, nanogemm_sgemm
18
+ +-- nanogemm32.dll # Compiled 32-bit Windows DLL (cdecl calling convention)
19
+ +-- test_nanogemm32.asm # Standalone PE32 console benchmark & self-test suite (runs via WoW64)
20
+ +-- test_nanogemm32.exe # Compiled 32-bit native executable (zero runtime dependencies)
21
+ L-- build.bat # Automated build & verification script
22
+ ```
23
+
24
+ ---
25
+
26
+ ## ?? Key Features
27
+
28
+ ### 1. 64-bit Engine (`nanogemm64.dll`, `test_nanogemm64.exe`)
29
+ - **ISA Target:** x86-64 with AVX2 (256-bit SIMD) and FMA3 (`vfmadd231ps`, `vbroadcastss`, `vmovups`).
30
+ - **Microkernel:** $4 \times 16$ and $4 \times 8$ register-tiled loop using 8 YMM accumulators (`ymm4`�`ymm11`).
31
+ - **Edge Kernel:** Handles arbitrary, odd, or prime matrix dimensions ($M, N, K$) with zero memory padding or buffer copying.
32
+ - **Calling Convention:** Complies strictly with the **Microsoft x64 ABI**, preserving all non-volatile registers (`RBX`, `RSI`, `RDI`, `R12`�`R15`, `XMM6`�`XMM15`).
33
+ - **Throughput:** Exceeds **38�40 GFLOPS** on a single CPU core.
34
+
35
+ ### 2. 32-bit Engine (`nanogemm32.dll`, `test_nanogemm32.exe`)
36
+ - **ISA Target:** x86 32-bit with SSE2 (128-bit SIMD, `movups`, `shufps`, `mulps`, `addps`).
37
+ - **Microkernel:** $4 \times 4$ register-tiled loop using 4 XMM accumulators (`xmm4`�`xmm7`).
38
+ - **Compatibility:** Runs on any 32-bit x86 OS or 64-bit Windows via WoW64 with zero external dependencies.
39
+ - **Calling Convention:** Standard `cdecl` calling convention.
40
+ - **Throughput:** Delivers **13�15 GFLOPS** in pure 32-bit mode.
41
+
42
+ ---
43
+
44
+ ## ?? Building from Source
45
+
46
+ To assemble all targets and run the native verification suites, run:
47
+
48
+ ```cmd
49
+ cd asm
50
+ build.bat
51
+ ```
52
+
53
+ Or assemble manually using `FASM.EXE`:
54
+
55
+ ```cmd
56
+ :: 64-bit targets
57
+ fasm nanogemm64.asm nanogemm64.dll
58
+ fasm test_nanogemm64.asm test_nanogemm64.exe
59
+
60
+ :: 32-bit targets
61
+ fasm nanogemm32.asm nanogemm32.dll
62
+ fasm test_nanogemm32.asm test_nanogemm32.exe
63
+ ```
64
+
65
+ ---
66
+
67
+ ## ?? Running Tests
68
+
69
+ ### 1. Native Executable Tests
70
+ ```cmd
71
+ :: Run 64-bit native test suite
72
+ test_nanogemm64.exe
73
+
74
+ :: Run 32-bit native test suite (WoW64)
75
+ test_nanogemm32.exe
76
+ ```
77
+
78
+ ### 2. Python Automated Verification vs NumPy
79
+ ```bash
80
+ python tests/test_fasm.py
81
+ ```
82
+ Tests numerical accuracy across:
83
+ - Square shapes from $1 \times 1$ to $256 \times 256$
84
+ - Rectangular and prime shapes: $(7, 13, 19)$, $(37, 59, 41)$, $(65, 129, 65)$, $(127, 255, 127)$
85
+ - Full BLAS SGEMM with $\alpha$ and $\beta$ scaling
86
+ - Reports relative and absolute diffs (`np.allclose(atol=1e-4)`) and GFLOPS.
@@ -0,0 +1,73 @@
1
+ @echo off
2
+ setlocal enabledelayedexpansion
3
+
4
+ echo =====================================================================
5
+ echo NanoGEMM - Building Native FASM 32-bit and 64-bit Engines
6
+ echo =====================================================================
7
+
8
+ cd /d "%~dp0"
9
+
10
+ set FASM=
11
+ if exist "C:\proekts\FASM\FASM.EXE" set FASM=C:\proekts\FASM\FASM.EXE
12
+ if not defined FASM if exist "C:\asm\hdd\FASM.EXE" set FASM=C:\asm\hdd\FASM.EXE
13
+ if not defined FASM (
14
+ echo [ERROR] FASM.EXE not found in C:\proekts\FASM or C:\asm\hdd
15
+ exit /b 1
16
+ )
17
+
18
+ echo Using Flat Assembler: %FASM%
19
+ echo.
20
+
21
+ echo [1/4] Assembling nanogemm64.dll (x86-64 AVX2+FMA DLL) ...
22
+ "%FASM%" nanogemm64.asm nanogemm64.dll
23
+ if %ERRORLEVEL% neq 0 (
24
+ echo [FAIL] Assembly failed for nanogemm64.asm
25
+ exit /b %ERRORLEVEL%
26
+ )
27
+
28
+ echo.
29
+ echo [2/4] Assembling test_nanogemm64.exe (x86-64 Standalone Test Suite) ...
30
+ "%FASM%" test_nanogemm64.asm test_nanogemm64.exe
31
+ if %ERRORLEVEL% neq 0 (
32
+ echo [FAIL] Assembly failed for test_nanogemm64.asm
33
+ exit /b %ERRORLEVEL%
34
+ )
35
+
36
+ echo.
37
+ echo [3/4] Assembling nanogemm32.dll (x86 32-bit SSE2 DLL) ...
38
+ "%FASM%" nanogemm32.asm nanogemm32.dll
39
+ if %ERRORLEVEL% neq 0 (
40
+ echo [FAIL] Assembly failed for nanogemm32.asm
41
+ exit /b %ERRORLEVEL%
42
+ )
43
+
44
+ echo.
45
+ echo [4/4] Assembling test_nanogemm32.exe (x86 32-bit Standalone Test Suite) ...
46
+ "%FASM%" test_nanogemm32.asm test_nanogemm32.exe
47
+ if %ERRORLEVEL% neq 0 (
48
+ echo [FAIL] Assembly failed for test_nanogemm32.asm
49
+ exit /b %ERRORLEVEL%
50
+ )
51
+
52
+ echo.
53
+ echo =====================================================================
54
+ echo All 4 Targets Built Successfully!
55
+ echo =====================================================================
56
+ echo.
57
+ echo --- Executing 64-bit Test Suite ---
58
+ test_nanogemm64.exe
59
+ if %ERRORLEVEL% neq 0 (
60
+ echo [ERROR] test_nanogemm64.exe failed with code %ERRORLEVEL%
61
+ exit /b %ERRORLEVEL%
62
+ )
63
+
64
+ echo.
65
+ echo --- Executing 32-bit Test Suite ---
66
+ test_nanogemm32.exe
67
+ if %ERRORLEVEL% neq 0 (
68
+ echo [ERROR] test_nanogemm32.exe failed with code %ERRORLEVEL%
69
+ exit /b %ERRORLEVEL%
70
+ )
71
+
72
+ echo.
73
+ echo [SUCCESS] Both 32-bit and 64-bit FASM Test Suites Passed Cleanly!
@@ -0,0 +1,27 @@
1
+ ; =============================================================================
2
+ ; NanoGEMM � High-Performance 32-bit SSE2 Matrix Multiplication DLL (x86 FASM)
3
+ ; =============================================================================
4
+
5
+ format PE GUI 4.0 DLL
6
+ entry DllEntryPoint
7
+
8
+ include 'C:\proekts\FASM\INCLUDE\WIN32A.INC'
9
+
10
+ section '.text' code readable executable
11
+
12
+ proc DllEntryPoint hinstDLL, fdwReason, lpvReserved
13
+ mov eax, 1
14
+ ret
15
+ endp
16
+
17
+ ; Include matrix multiplication routines
18
+ include 'nanogemm32_kernel.inc'
19
+
20
+ section '.data' data readable
21
+ isa_str db 'SSE2 (FASM x86 32-bit, 128-bit SIMD)', 0
22
+
23
+ section '.edata' export data readable
24
+ export 'nanogemm32.dll',\
25
+ nanogemm_matmul, 'nanogemm_matmul',\
26
+ nanogemm_sgemm, 'nanogemm_sgemm',\
27
+ nanogemm_simd_isa, 'nanogemm_simd_isa'
Binary file