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
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
|
from __future__ import annotations
import sys
import math
from bitstring import BitArray, Dtype, Array, options
import pytest
import gfloat
sys.path.insert(0, '..')
def test_creation_e3m2mxfp():
x = BitArray('0b000000')
assert x.e3m2mxfp == 0.0
x.e3m2mxfp = 0.0
assert x.e3m2mxfp == 0.0
assert len(x) == 6
def test_getting_e4m3mxfp_values():
assert BitArray('0b00000000').e4m3mxfp == 0.0
assert BitArray('0b01111110').e4m3mxfp == 448.0
assert BitArray('0b11111110').e4m3mxfp == -448.0
assert BitArray('0b00001000').e4m3mxfp == 2**-6
assert math.isnan(BitArray('0b01111111').e4m3mxfp)
assert math.isnan(BitArray('0b11111111').e4m3mxfp)
def test_setting_e4m3mxfp_values():
x = BitArray('0b00000000')
x.e4m3mxfp = 0.0
assert x == '0b00000000'
x.e4m3mxfp = -(2 ** -9)
assert x == '0b10000001'
x.e4m3mxfp = 99999
assert x.e4m3mxfp == 448.0
def test_getting_e5m2mxfp_values():
assert BitArray('0b00000000').e5m2mxfp == 0.0
assert BitArray('0b01111011').e5m2mxfp == 57344
for b in ['0b01111101', '0b11111101', '0b01111110', '0b11111110', '0b01111111', '0b11111111']:
assert math.isnan(BitArray(b).e5m2mxfp)
assert BitArray('0b01111100').e5m2mxfp == float('inf')
assert BitArray('0b11111100').e5m2mxfp == float('-inf')
assert BitArray('0b00000001').e5m2mxfp == 2 ** -16
assert BitArray('0b00000100').e5m2mxfp == 2 ** -14
def test_setting_e5m2mxfp_values():
x = BitArray('0b00000000')
x.e5m2mxfp = 0.0
assert x == '0b00000000'
x.e5m2mxfp = -(2 ** -16)
assert x == '0b10000001'
x.e5m2mxfp = 99999
assert x.e5m2mxfp == 57344.0
def test_getting_e3m2mxfp_values():
assert BitArray('0b000000').e3m2mxfp == 0.0
assert BitArray('0b000001').e3m2mxfp == 0.0625
assert BitArray('0b000011').e3m2mxfp == 0.1875
assert BitArray('0b000100').e3m2mxfp == 0.25
assert BitArray('0b011111').e3m2mxfp == 28.0
def test_setting_e3m2mxfp_values():
x = BitArray('0b000000')
x.e3m2mxfp = 0.0
assert x == '0b000000'
x.e3m2mxfp = -0.0625
assert x == '0b100001'
x.e3m2mxfp = -0.1875
assert x == '0b100011'
x.e3m2mxfp = -0.25
assert x == '0b100100'
x.e3m2mxfp = -28.0
assert x == '0b111111'
def test_getting_e2m3mxfp_values():
assert BitArray('0b000000').e2m3mxfp == 0.0
assert BitArray('0b000001').e2m3mxfp == 0.125
assert BitArray('0b000111').e2m3mxfp == 0.875
assert BitArray('0b001000').e2m3mxfp == 1.0
assert BitArray('0b011111').e2m3mxfp == 7.5
def test_setting_e2m3mxfp_values():
x = BitArray('0b000000')
x.e2m3mxfp = 0.0
assert x == '0b000000'
x.e2m3mxfp = -0.125
assert x == '0b100001'
x.e2m3mxfp = -0.875
assert x == '0b100111'
x.e2m3mxfp = -1.0
assert x == '0b101000'
x.e2m3mxfp = -7.5
assert x == '0b111111'
def test_getting_e2m1mxfp_values():
assert BitArray('0b0000').e2m1mxfp == 0.0
assert BitArray('0b0001').e2m1mxfp == 0.5
assert BitArray('0b0010').e2m1mxfp == 1.0
assert BitArray('0b0111').e2m1mxfp == 6.0
def test_setting_e2m1mxfp_values():
x = BitArray('0b0000')
x.e2m1mxfp = 0.0
assert x == '0b0000'
x.e2m1mxfp = -0.5
assert x == '0b1001'
x.e2m1mxfp = -1.0
assert x == '0b1010'
x.e2m1mxfp = -6.0
assert x == '0b1111'
def test_e8m0mxfp_value():
x = BitArray('0x00')
assert x.e8m0mxfp == 2.0 ** -127
x.uint = 127
assert x.e8m0mxfp == 1.0
x.uint = 254
assert x.e8m0mxfp == 2.0 ** 127
x.bin = '11111111'
assert math.isnan(x.e8m0mxfp)
def test_getting_mxint_values():
assert BitArray('0b00000000').mxint == 0.0
assert BitArray('0b00000001').mxint == 1 * 2 ** -6
assert BitArray('0b00000011').mxint == 3 * 2 ** -6
assert BitArray('0b01111111').mxint == 127 * 2 ** -6
assert BitArray('0b10000000').mxint == -2.0
assert BitArray('0b11111111').mxint == -1 * 2 ** -6
assert BitArray('0b11111110').mxint == -2 * 2 ** -6
assert BitArray('0b10000001').mxint == -127 * 2 ** -6
def test_setting_mxint_values():
x = BitArray('0b00000000')
x.mxint = 0.0
assert x == '0b00000000'
x.mxint = 1 * 2 ** -6
assert x == '0b00000001'
x.mxint = -1 * 2 ** -6
assert x == '0b11111111'
def test_scaled_array():
sa = Array(Dtype('uint8', scale=2),[100, 200, 300, 400, 500])
assert sa.dtype.scale == 2
assert sa[0] == 100
assert sa[:] == [100, 200, 300, 400, 500]
sa.dtype = Dtype('uint8', scale=4)
assert sa.dtype.scale == 4
assert sa[0] == 200
sa.dtype = Dtype('uint8', scale=0.25)
assert sa.tolist() == [12.5, 25.0, 37.5, 50.0, 62.5]
def test_setting_scaled_array():
sa = Array('e3m2mxfp')
sa.append(4.0)
assert sa[0] == 4.0
assert sa.dtype.scale is None
sa.dtype = Dtype('e3m2mxfp', scale = 0.5)
assert sa[0] == 2.0
sa.append(6.0)
assert sa[1] == 6.0
assert sa[:] == [2.0, 6.0]
sa *= 2
assert sa[:] == [4.0, 12.0]
sa[:] = [0.0, 0.5, 1.0]
assert sa[:] == [0.0, 0.5, 1.0]
sa.dtype = Dtype('e3m2mxfp', scale = 1)
assert sa[:] == [0.0, 1.0, 2.0]
def test_multiple_scaled_arrays():
d = bytes(b'hello_everyone!')
s1 = Array(Dtype('e2m1mxfp', scale=1), d)
s2 = Array(Dtype('e2m1mxfp', scale=2**10), d)
s3 = Array(Dtype('e2m1mxfp', scale=2**-10), d)
assert s1.dtype.scale == 1
assert s2.dtype.scale == 2**10
assert s3.dtype.scale == 2**-10
assert s1[0] * 2**10 == s2[0]
assert s1[0] * 2**-10 == s3[0]
def test_multiple_scaled_arrays2():
b = BitArray('0b011111')
assert b.e3m2mxfp == 28.0
s1 = Array('e3m2mxfp', [28])
assert s1[0] == 28.0
assert b.e3m2mxfp == 28.0
s2 = Array('e3m2mxfp', [28])
s2.dtype = Dtype('e3m2mxfp', scale=2**4)
assert s1[0] == 28.0
assert s2[0] == 28.0 * 2 ** 4
assert b.e3m2mxfp == 28.0
def test_setting_from_outside_range():
b = BitArray(e2m1mxfp=0.0)
b.e2m1mxfp = 6.0
assert b.e2m1mxfp == 6.0
b.e2m1mxfp = 7.0
assert b.e2m1mxfp == 6.0
b.e2m1mxfp = 10000000000.0
assert b.e2m1mxfp == 6.0
s = Array('e2m1mxfp', [-1000.0, 6.0, 7.0, 10000.0])
assert s.tolist() == [-6.0, 6.0, 6.0, 6.0]
s = Array(Dtype('e2m1mxfp', scale=2), [-1000.0, 6.0, 7.0, 10000000000.0])
x = s.tolist()
assert x == [-12.0, 6.0, 8.0, 12.0]
def test_ops():
s = Array(Dtype('e8m0mxfp', scale=2**2), [0.5, 1.0, 2.0, 4.0, 8.0])
t = s * 2
assert type(t) is Array
assert t.tolist() == [1.0, 2.0, 4.0, 8.0, 16.0]
assert t.dtype.scale == 2 ** 2
def test_auto_scaling():
f = [0.0, 100.0, 256.0, -150.0]
for dtype in ['e3m2mxfp', 'e2m3mxfp', 'e2m1mxfp', 'mxint8', 'p3binary', 'p4binary']:
d = Dtype(dtype, scale='auto')
a = Array(d, f)
assert a[2] == 256.0
def test_auto_scaling2():
some_floats = [-4, 100.0, -9999, 0.5, 42, 666]
a = Array(Dtype('float16', scale='auto'), some_floats)
assert a[2] == -10000.0
a = Array(Dtype('e2m1mxfp', scale='auto'), [1e200])
assert a.dtype.scale == 2 ** 127
a = Array(Dtype('e2m1mxfp', scale='auto'), [1e-200])
assert a.dtype.scale == 2 ** -127
a = Array(Dtype('e2m1mxfp', scale='auto'), [0, 0, 0, 0])
assert a.dtype.scale == 1
def test_auto_scaling_error():
a = Array(Dtype('e3m2mxfp', scale='auto'), [0.3])
expected_scale = 0.25 / 16.0
assert a.dtype.scale == expected_scale
b = Array(Dtype('e2m1mxfp', scale='auto'), [-0.9, 0.6, 0.0001])
expected_scale = 0.5 / 4.0
assert b.dtype.scale == expected_scale
def test_scaled_array_errors():
with pytest.raises(ValueError):
_ = Array(Dtype('bfloat', scale='auto'), [0.0, 100.0, 256.0, -150.0])
with pytest.raises(ValueError):
_ = Array(Dtype('uint9', scale='auto'), [0.0, 100.0, 256.0, -150.0])
with pytest.raises(ValueError):
_ = Dtype('e3m2mxfp', scale=0)
with pytest.raises(TypeError):
_ = Array(Dtype('e3m2mxfp', scale='auto'), b'hello')
with pytest.raises(TypeError):
_ = Array(Dtype('e3m2mxfp', scale='auto'), 100)
def test_changing_to_auto_scaled_array():
a = Array('int16', [0, 2003, -43, 104, 6, 1, 99])
with pytest.raises(ValueError):
a.dtype = Dtype('e3m2mxfp', scale='auto')
with pytest.raises(ValueError):
_ = Array(Dtype('e3m2mxfp', scale='auto'))
with pytest.raises(ValueError):
_ = Array(Dtype('e3m2mxfp', scale='auto'), [])
def test_conversion_to_e8m0():
x = BitArray(e8m0mxfp=1.0)
assert x.e8m0mxfp == 1.0
x = BitArray(e8m0mxfp=2**127)
assert x.e8m0mxfp == 2**127
x = BitArray(e8m0mxfp=2**-127)
assert x.e8m0mxfp == 2**-127
x = BitArray(e8m0mxfp=float('nan'))
assert math.isnan(x.e8m0mxfp)
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=2**128)
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=-2**128)
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=0.0)
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=1.1)
def test_rounding_to_even():
# When rounding to even, the value chosen when two are equidistant should end in a zero bit.
x = BitArray(e4m3mxfp=21.0)
assert x.e4m3mxfp == 20.0
a = BitArray(e4m3mxfp=20.0).bin
b = BitArray(e4m3mxfp=22.0).bin
assert a[:-1] == b[:-1]
assert a[-1] == '0'
assert b[-1] == '1'
x = BitArray(e4m3mxfp=22.0)
assert x.e4m3mxfp == 22.0
x = BitArray(e4m3mxfp=23.0)
assert x.e4m3mxfp == 24.0
x = BitArray(e4m3mxfp=24.0)
assert x.e4m3mxfp == 24.0
x = BitArray(e4m3mxfp=-50) # Midway between -48 and -52
assert x.e4m3mxfp == -48.0 # Rounds towards zero
assert x.bin[-1] == '0'
x = BitArray(e4m3mxfp=-54) # Midway between -52 and -56
assert x.e4m3mxfp == -56.0 # Rounds away from zero
assert x.bin[-1] == '0'
def test_rounding_consistent_to_gfloat():
for fi, dt in [[gfloat.formats.format_info_ocp_e4m3, Dtype('e4m3mxfp')],
[gfloat.formats.format_info_ocp_e5m2, Dtype('e5m2mxfp')]]:
for i in range(1 << 16):
f = BitArray(uint=i, length=16).float
mine = dt.parse(dt.build(f))
theirs = gfloat.round_float(fi, f, sat=True)
if math.isnan(mine):
assert math.isnan(theirs)
else:
assert mine == theirs
@pytest.mark.usefixtures('switch_to_overflow')
def test_rounding_consistent_to_gfloat_with_overflow():
assert options.mxfp_overflow == 'overflow'
for fi, dt in [[gfloat.formats.format_info_ocp_e4m3, Dtype('e4m3mxfp')],
[gfloat.formats.format_info_ocp_e5m2, Dtype('e5m2mxfp')]]:
for i in range(1 << 16):
f = BitArray(uint=i, length=16).float
mine = dt.parse(dt.build(f))
theirs = gfloat.round_float(fi, f, sat=False)
if math.isnan(mine):
assert math.isnan(theirs)
else:
if mine != theirs:
print(mine, theirs)
def test_conversion_from_nan():
x = BitArray(e4m3mxfp=float('nan'))
assert x == '0b11111111'
x = BitArray(e5m2mxfp=float('nan'))
assert x == '0b11111111'
with pytest.raises(ValueError):
_ = BitArray(e3m2mxfp=float('nan'))
with pytest.raises(ValueError):
_ = BitArray(e2m3mxfp=float('nan'))
with pytest.raises(ValueError):
_ = BitArray(e2m1mxfp=float('nan'))
with pytest.raises(ValueError):
_ = BitArray(mxint=float('nan'))
x = BitArray(e8m0mxfp=float('nan'))
assert x == '0b11111111'
def test_conversion_from_inf():
x = BitArray(e3m2mxfp=float('inf'))
assert x.e3m2mxfp == 28.0
x = BitArray(e3m2mxfp=float('-inf'))
assert x.e3m2mxfp == -28.0
x = BitArray(e2m3mxfp=float('inf'))
assert x.e2m3mxfp == 7.5
x = BitArray(e2m3mxfp=float('-inf'))
assert x.e2m3mxfp == -7.5
x = BitArray(e2m1mxfp=float('inf'))
assert x.e2m1mxfp == 6.0
x = BitArray(e2m1mxfp=float('-inf'))
assert x.e2m1mxfp == -6.0
x = BitArray(mxint=float('inf'))
assert x.mxint == 1.984375
x = BitArray(mxint=float('-inf'))
assert x.mxint == -2.0
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=float('inf'))
with pytest.raises(ValueError):
_ = BitArray(e8m0mxfp=float('-inf'))
def test_conversion_to_8bit_with_saturate():
assert options.mxfp_overflow == 'saturate'
x = BitArray(e5m2mxfp=float('inf'))
assert x.e5m2mxfp == 57344.0
x = BitArray(e5m2mxfp=float('-inf'))
assert x.e5m2mxfp == -57344.0
x = BitArray(e5m2mxfp=1e10)
assert x.e5m2mxfp == 57344.0
x = BitArray(e5m2mxfp=-1e10)
assert x.e5m2mxfp == -57344.0
x = BitArray(e4m3mxfp=float('inf'))
assert x.e4m3mxfp == 448.0
x = BitArray(e4m3mxfp=float('-inf'))
assert x.e4m3mxfp == -448.0
x = BitArray(e4m3mxfp=1e10)
assert x.e4m3mxfp == 448.0
x = BitArray(e4m3mxfp=-1e10)
assert x.e4m3mxfp == -448.0
@pytest.fixture
def switch_to_overflow():
options.mxfp_overflow = 'overflow'
yield
options.mxfp_overflow = 'saturate'
@pytest.mark.usefixtures('switch_to_overflow')
def test_conversion_to_8bit_with_overflow():
x = BitArray(e5m2mxfp=float('inf'))
assert x.e5m2mxfp == float('inf')
x = BitArray(e5m2mxfp=float('-inf'))
assert x.e5m2mxfp == float('-inf')
x = BitArray(e5m2mxfp=1e10)
assert x.e5m2mxfp == float('inf')
x = BitArray(e5m2mxfp=-1e10)
assert x.e5m2mxfp == float('-inf')
x = BitArray(e4m3mxfp=float('inf'))
assert math.isnan(x.e4m3mxfp)
x = BitArray(e4m3mxfp=float('-inf'))
assert math.isnan(x.e4m3mxfp)
x = BitArray(e4m3mxfp=1e10)
assert math.isnan(x.e4m3mxfp)
x = BitArray(e4m3mxfp=-1e10)
assert math.isnan(x.e4m3mxfp)
def test_mxint_rounding():
x = BitArray('mxint=0.0')
assert x == '0x00'
x.mxint = -2.0
assert x.mxint == -2.0
x.mxint = 1.0/64
assert x.mxint == 1.0/64
assert x == '0x01'
x.mxint = 1000
assert x.mxint == 1.0 + 63.0/64.0
x.mxint = 1.4 / 64.0
assert x.mxint == 1.0 / 64.0
x.mxint = 1.6 / 64.0
assert x.mxint == 2.0 / 64.0
x.mxint = 1.5 / 64.0
assert x.mxint == 2.0 / 64.0 # Round to even
x.mxint = 2.5 / 64.0
assert x.mxint == 2.0 / 64.0 # Round to even
x.mxint = -2.5
assert x.mxint == -2.0
x.mxint = -1.5 / 64.0
assert x.mxint == -2.0 / 64.0
x.mxint = -2.5 / 64.0
assert x.mxint == -2.0 / 64.0
x.mxint = -3.5 / 64.0
assert x.mxint == -4.0 / 64.0
@pytest.mark.usefixtures('switch_to_overflow')
@pytest.mark.parametrize("fmt", [Dtype(x) for x in ['e5m2mxfp', 'e4m3mxfp', 'e2m3mxfp', 'e3m2mxfp', 'e2m1mxfp', 'e8m0mxfp', 'mxint', 'p3binary', 'p4binary']])
def test_roundtrips(fmt):
# Note that e5m2mxfp in saturate mode will not pass this test, as inf -> inf -> max_value.
for i in range(1 << fmt.bitlength):
b = BitArray(u=i, length=fmt.bitlength)
v = fmt.parse(b)
b2 = fmt.build(v)
if math.isnan(fmt.parse(b)):
assert math.isnan(fmt.parse(b2))
else:
assert b == b2
|
