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 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 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 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259
|
# Copyright (c) 2024 Graphcore Ltd. All rights reserved.
import ml_dtypes
import numpy as np
import pytest
from gfloat import FloatClass, decode_float
from gfloat.formats import *
def _isnegzero(x: float) -> bool:
return (x == 0) and (np.signbit(x) == 1)
def test_spot_check_ocp_e5m2() -> None:
fi = format_info_ocp_e5m2
dec = lambda code: decode_float(fi, code).fval
fclass = lambda code: decode_float(fi, code).fclass
assert dec(0x01) == 2.0**-16
assert dec(0x40) == 2.0
assert _isnegzero(dec(0x80))
assert dec(0x7B) == 57344.0
assert dec(0x7C) == np.inf
assert np.floor(np.log2(dec(0x7B))) == fi.emax
assert dec(0xFC) == -np.inf
assert np.isnan(dec(0x7F))
assert fclass(0x80) == FloatClass.ZERO
assert fclass(0x00) == FloatClass.ZERO
def test_spot_check_ocp_e4m3() -> None:
fi = format_info_ocp_e4m3
dec = lambda code: decode_float(fi, code).fval
assert dec(0x40) == 2.0
assert dec(0x01) == 2.0**-9
assert _isnegzero(dec(0x80))
assert np.isnan(dec(0x7F))
assert dec(0x7E) == 448.0
assert np.floor(np.log2(dec(0x7E))) == fi.emax
def test_spot_check_p3109_p3() -> None:
fi = format_info_p3109(3)
dec = lambda code: decode_float(fi, code).fval
assert dec(0x01) == 2.0**-17
assert dec(0x40) == 1.0
assert np.isnan(dec(0x80))
assert dec(0xFF) == -np.inf
assert np.floor(np.log2(dec(0x7E))) == fi.emax
def test_spot_check_p3109_p1() -> None:
fi = format_info_p3109(1)
dec = lambda code: decode_float(fi, code).fval
assert dec(0x01) == 2.0**-62
assert dec(0x40) == 2.0
assert np.isnan(dec(0x80))
assert dec(0xFF) == -np.inf
assert np.floor(np.log2(dec(0x7E))) == fi.emax
def test_spot_check_binary16() -> None:
fi = format_info_binary16
dec = lambda code: decode_float(fi, code).fval
assert dec(0x3C00) == 1.0
assert dec(0x3C01) == 1.0 + 2**-10
assert dec(0x4000) == 2.0
assert dec(0x0001) == 2**-24
assert dec(0x7BFF) == 65504.0
assert np.isinf(dec(0x7C00))
assert np.isnan(dec(0x7C01))
assert np.isnan(dec(0x7FFF))
def test_spot_check_bfloat16() -> None:
fi = format_info_bfloat16
dec = lambda code: decode_float(fi, code).fval
assert dec(0x3F80) == 1
assert dec(0x4000) == 2
assert dec(0x0001) == 2**-133
assert dec(0x4780) == 65536.0
assert np.isinf(dec(0x7F80))
assert np.isnan(dec(0x7F81))
assert np.isnan(dec(0x7FFF))
def test_spot_check_ocp_e2m3() -> None:
# Test against Table 4 in "OCP Microscaling Formats (MX) v1.0 Spec"
fi = format_info_ocp_e2m3
dec = lambda code: decode_float(fi, code).fval
assert fi.max == 7.5
assert fi.smallest_subnormal == 0.125
assert fi.smallest_normal == 1.0
assert not fi.has_infs
assert fi.num_nans == 0
assert fi.has_nz
assert dec(0b000000) == 0
assert dec(0b011111) == 7.5
assert _isnegzero(dec(0b100000))
def test_spot_check_ocp_e3m2() -> None:
# Test against Table 4 in "OCP Microscaling Formats (MX) v1.0 Spec"
fi = format_info_ocp_e3m2
dec = lambda code: decode_float(fi, code).fval
assert fi.max == 28.0
assert fi.smallest_subnormal == 0.0625
assert fi.smallest_normal == 0.25
assert not fi.has_infs
assert fi.num_nans == 0
assert fi.has_nz
assert dec(0b000000) == 0
assert dec(0b011111) == 28.0
assert _isnegzero(dec(0b100000))
def test_spot_check_ocp_e2m1() -> None:
# Test against Table 5 in "OCP Microscaling Formats (MX) v1.0 Spec"
fi = format_info_ocp_e2m1
dec = lambda code: decode_float(fi, code).fval
assert fi.max == 6.0
assert fi.smallest_subnormal == 0.5
assert fi.smallest_normal == 1.0
assert not fi.has_infs
assert fi.num_nans == 0
assert fi.has_nz
assert dec(0b0000) == 0
assert dec(0b0001) == 0.5
assert dec(0b0010) == 1.0
assert dec(0b0011) == 1.5
assert dec(0b0100) == 2.0
assert dec(0b0101) == 3.0
assert dec(0b0110) == 4.0
assert dec(0b0111) == 6.0
assert _isnegzero(dec(0b1000))
def test_spot_check_ocp_e8m0() -> None:
# Test against Table 7 in "OCP Microscaling Formats (MX) v1.0 Spec"
fi = format_info_ocp_e8m0
dec = lambda code: decode_float(fi, code).fval
fclass = lambda code: decode_float(fi, code).fclass
assert fi.expBias == 127
assert fi.max == 2.0**127
assert fi.smallest == 2.0**-127
assert not fi.has_infs
assert fi.num_nans == 1
assert dec(0x00) == 2.0**-127
assert dec(0x01) == 2.0**-126
assert dec(0x7F) == 1.0
assert np.isnan(dec(0xFF))
assert fclass(0x80) == FloatClass.NORMAL
assert fclass(0x00) == FloatClass.NORMAL
def test_spot_check_ocp_int8() -> None:
# Test against Table TODO in "OCP Microscaling Formats (MX) v1.0 Spec"
fi = format_info_ocp_int8
dec = lambda code: decode_float(fi, code).fval
assert fi.max == 1.0 + 63.0 / 64
assert fi.smallest == 2.0**-6
assert not fi.has_infs
assert fi.num_nans == 0
assert dec(0x00) == 0.0
assert dec(0x01) == fi.smallest
assert dec(0x7F) == fi.max
assert dec(0x80) == -2.0
assert dec(0x80) == fi.min
assert dec(0xFF) == -fi.smallest
@pytest.mark.parametrize("fi", p3109_formats)
def test_specials(fi: FormatInfo) -> None:
assert fi.code_of_nan == 0x80
assert fi.code_of_zero == 0x00
assert fi.code_of_posinf == 0x7F
assert fi.code_of_neginf == 0xFF
@pytest.mark.parametrize("fi", all_formats)
def test_specials_decode(fi: FormatInfo) -> None:
dec = lambda v: decode_float(fi, v).fval
if fi.has_zero:
assert dec(fi.code_of_zero) == 0
if fi.num_nans > 0:
assert np.isnan(dec(fi.code_of_nan))
if fi.has_infs:
assert dec(fi.code_of_posinf) == np.inf
assert dec(fi.code_of_neginf) == -np.inf
assert dec(fi.code_of_max) == fi.max
assert dec(fi.code_of_min) == fi.min
if fi.has_zero:
assert dec(1) == fi.smallest
else:
assert dec(0) == fi.smallest
@pytest.mark.parametrize(
"fmt,npfmt,int_dtype",
[
(format_info_binary16, np.float16, np.uint16),
(format_info_bfloat16, ml_dtypes.bfloat16, np.uint16),
(format_info_ocp_e4m3, ml_dtypes.float8_e4m3fn, np.uint8),
],
)
def test_consistent_decodes_all_values(
fmt: FormatInfo, npfmt: np.dtype, int_dtype: np.dtype
) -> None:
npivals = np.arange(
np.iinfo(int_dtype).min, int(np.iinfo(int_dtype).max) + 1, dtype=int_dtype
)
npfvals = npivals.view(dtype=npfmt)
for i, npfval in zip(npivals, npfvals):
val = decode_float(fmt, int(i))
np.testing.assert_equal(val.fval, npfval)
@pytest.mark.parametrize("v", [-1, 0x10000])
def test_except(v: int) -> None:
with pytest.raises(ValueError):
decode_float(format_info_binary16, v)
@pytest.mark.parametrize("fi", [fi for fi in all_formats if fi.bits <= 8])
def test_dense(fi: FormatInfo) -> None:
fvs = [decode_float(fi, i) for i in range(0, 2**fi.bits)]
vals = np.array([fv.fval for fv in fvs])
assert np.min(vals[np.isfinite(vals)]) == fi.min
assert np.max(vals[np.isfinite(vals)]) == fi.max
assert np.min(vals[np.isfinite(vals) & (vals > 0)]) == fi.smallest
if fi.has_subnormals:
vals_subnormal = np.array(
[fv.fval for fv in fvs if fv.fclass == FloatClass.SUBNORMAL and fv.fval > 0]
)
if len(vals_subnormal):
# In some formats, zero is the only "subnormal"
assert np.min(vals_subnormal) == fi.smallest_subnormal
|