Skip to content

Commit 6c336cf

Browse files
authored
Update README.md
1 parent b37a9ce commit 6c336cf

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ const Float8_4 = Microfloat(1, 4, 3)
2323
const Float8_5 = Microfloat(1, 5, 2)
2424
```
2525

26-
### Microscaling (MX) Element Types
26+
### Microscaling (MX)
2727

2828
Microfloats implements the E4M3, E5M2, E2M3, E3M2, E2M1, and E8M0 types from the [Open Compute Project Microscaling Formats (MX) Specification](https://www.opencompute.org/documents/ocp-microscaling-formats-mx-v1-0-spec-final-pdf), with most of these using saturated arithmetic (no infinities), and different bit layouts for NaNs. These are exported as `MX_E4M3`, `MX_E5M2`, `MX_E2M3`, `MX_E3M2`, `MX_E2M1`, and `MX_E8M0`, respectively.
2929

@@ -32,6 +32,8 @@ For INT8, see `FixedPointNumbers.Q1f6`.
3232
> [!WARNING]
3333
> MX types may not yet be fully OCP compliant. See issues with the [![MX-compliance](https://img.shields.io/github/labels/MurrellGroup/Microfloats.jl/mx-compliance)](https://github.com/MurrellGroup/Microfloats.jl/labels/mx-compliance) label.
3434
35+
Since Microfloats.jl only implements the primitive types, microscaling itself may be done with [Microscaling.jl](https://github.com/MurrellGroup/Microscaling.jl), which includes quantization and bitpacking.
36+
3537
## Installation
3638

3739
```julia
@@ -42,7 +44,8 @@ Pkg.add("Microfloats")
4244

4345
## See also
4446

47+
- [Microscaling.jl](https://github.com/MurrellGroup/Microscaling.jl)
48+
- [FixedPointNumbers.jl](https://github.com/JuliaMath/FixedPointNumbers.jl)
4549
- [MicroFloatingPoints.jl](https://github.com/goualard-f/MicroFloatingPoints.jl)
4650
- [DLFP8Types.jl](https://github.com/chengchingwen/DLFP8Types.jl)
4751
- [Float8s.jl](https://github.com/JuliaMath/Float8s.jl)
48-
- [FixedPointNumbers.jl](https://github.com/JuliaMath/FixedPointNumbers.jl)

0 commit comments

Comments
 (0)