https://github.com/yvt/amx-rs

Rust wrapper for Apple Matrix Coprocessor (AMX) instructions
https://github.com/yvt/amx-rs

amx apple-m1 apple-matrix-coprocessor dont-use-this-in-production mac matrix rust simd

Last synced: about 2 months ago
JSON representation

Rust wrapper for Apple Matrix Coprocessor (AMX) instructions

• Host: GitHub
• URL: https://github.com/yvt/amx-rs
• Owner: yvt
• License: apache-2.0
• Created: 2021-01-08T11:23:05.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2023-11-14T00:06:36.000Z (about 1 year ago)
• Last Synced: 2023-11-14T01:23:58.440Z (about 1 year ago)
• Topics: amx, apple-m1, apple-matrix-coprocessor, dont-use-this-in-production, mac, matrix, rust, simd
• Language: Rust
• Homepage:
• Size: 60.5 KB
• Stars: 38
• Watchers: 6
• Forks: 5
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE-APACHE

Awesome Lists containing this project

README

        
# `amx`

[](https://docs.rs/amx/)

Rust wrapper for Apple Matrix Coprocessor (AMX) instructions

This crate provides wrapper functions for the undocumented AMX instructions,

which are found in Apple Silicon processors.

## Resources

 - 

 - 

## Example

```rust

use amx::{Amx, XRow, YRow, XBytes, YBytes, ZRow};

let mut ctx = amx::AmxCtx::new().unwrap();

let x = [1,  2,  3,  4,  5,  6,  7,  8,  9,  10, 11, 12, 13, 14, 15, 16,

         17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32i16];

let y = [51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66,

         67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82i16];

unsafe { ctx.load512(x.as_ptr(), XRow(0)) };

unsafe { ctx.load512(y.as_ptr(), YRow(0)) };

ctx.outer_product_i16_xy_to_z(

    Some(XBytes(0)),    // input from X starting from byte offset 0

    Some(YBytes(0)),    // input from Y starting from byte offset 0

    ZRow(0),            // output to Z starting from row offset 0

    false,              // don't accumulate

);

let z: [[i16; 32]; 64] = unsafe { std::mem::transmute(ctx.read_z()) };

for (x_i, &x) in x.iter().enumerate() {

    for (y_i, &y) in y.iter().enumerate() {

        assert_eq!(z[y_i * 2][x_i], x * y);

    }

}

```

## Registers

```rust

struct AmxState {

    /// "8 64-byte registers"

    x: [[u8; 64]; 8],

    /// "8 64-byte registers"

    y: [[u8; 64]; 8],

    /// "64 64-byte registers in an M-by-N matrix"

    z: [[u8; 64]; 64],

}

```

License: MIT/Apache-2.0