Skip to content

Commit 14923ea

Browse files
committed
Add to docs
1 parent 73dc596 commit 14923ea

File tree

3 files changed

+13
-4
lines changed

3 files changed

+13
-4
lines changed

docs/source/05-speed.ipynb renamed to docs/source/04-benchmark.ipynb

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -35,16 +35,18 @@
3535
"cell_type": "markdown",
3636
"metadata": {},
3737
"source": [
38-
"## Timing tests\n",
38+
"# Timing tests\n",
3939
"\n",
40-
"The `gfloat` library is designed for readability over performance, and the reference code for computations is the (slow) scalar code e.g. `round_float`. There are vectorized implementations (e.g. `round_ndarray`, and when combined with JAX, these can go reasonably fast).\n",
40+
"The `gfloat` library is designed for readability over performance, and the reference code for computations is the (slow) scalar code e.g. `round_float`.\n",
4141
"\n",
42-
"Let's try to convert some values to FP8:"
42+
"There are vectorized implementations (e.g. `round_ndarray`, and when combined with JAX, these can go reasonably fast).\n",
43+
"\n",
44+
"Let's see how long it takes to encoed some values to FP8..."
4345
]
4446
},
4547
{
4648
"cell_type": "code",
47-
"execution_count": 24,
49+
"execution_count": null,
4850
"metadata": {},
4951
"outputs": [
5052
{

docs/source/api.rst

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,12 @@ Scalar Functions
1212
.. autofunction:: round_float
1313
.. autofunction:: encode_float
1414

15+
Array Functions
16+
---------------
17+
18+
.. autofunction:: round_ndarray
19+
.. autofunction:: encode_ndarray
20+
1521
Block format functions
1622
----------------------
1723

docs/source/notebooks.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,4 @@ Some notebooks to illustrate uses of the library
1111
01-decode.ipynb
1212
02-value-stats.ipynb
1313
03-value-tables.ipynb
14+
04-benchmark.ipynb

0 commit comments

Comments
 (0)