docs

Author: awf

docs/source/api.rst

@@ -5,15 +5,22 @@ API
 
 .. module:: gfloat
 
-Functions
----------
+Scalar Functions
+----------------
 
 .. autofunction:: decode_float
 .. autofunction:: round_float
 .. autofunction:: encode_float
 
+Block format functions
+----------------------
+
 .. autofunction:: decode_block
 .. autofunction:: encode_block
+.. autofunction:: quantize_block
+
+.. autofunction:: compute_scale_amax
+
 
 Classes
 -------

docs/source/conf.py

@@ -24,6 +24,16 @@
     "myst_nb",
 ]
 
+autodoc_typehints = "none"  # We have them in the parameter descriptors
+autodoc_typehints_format = "short"
+python_use_unqualified_type_names = True
+
+autodoc_type_aliases = {
+    "Iterable": "Iterable",
+    "npt.ArrayLike": "zArrayLike",
+    "npt.NDArray": "zNDArray",
+}
+
 autodoc_default_options = {
     "member-order": "bysource",
 }

docs/source/formats.rst

@@ -31,3 +31,14 @@ IEEE WG P3109 Formats
 ---------------------
 
 .. autofunction:: format_info_p3109
+
+Block Formats
+---------------------
+
+.. autodata:: format_info_mxfp8_e5m2
+.. autodata:: format_info_mxfp8_e4m3
+.. autodata:: format_info_mxfp6_e3m2
+.. autodata:: format_info_mxfp6_e2m3
+.. autodata:: format_info_mxfp4_e2m1
+.. autodata:: format_info_mxfp4_e2m1
+.. autodata:: format_info_mxint8

src/gfloat/block.py

@@ -95,7 +95,7 @@ def encode_block(
     The :paramref:`scale` is explicitly passed, and the :paramref:`vals` are
     assumed to already be multiplied by `1/scale`.
     That is, this is pure encoding, scaling is computed and applied elsewhere
-    (see e.g. :funcref:`quantize_block`).
+    (see e.g. :func:`quantize_block`).
 
     It is checked for overflow in the target format,
     and will raise an exception if it does.
@@ -137,7 +137,7 @@ def compute_scale_amax(etype_emax: float, vals: npt.ArrayLike) -> float:
 
     Args:
       etype_emax (float): Maximum exponent to appear in `vals * scale`
-      vals (numpy.array): Input block
+      vals (ArrayLike): Input block
 
     Returns:
       A float such that `vals * scale` has exponents less than or equal to `etype_emax`.
@@ -160,13 +160,14 @@ def quantize_block(
     round: RoundMode = RoundMode.TiesToEven,
 ) -> npt.NDArray[np.float64]:
     """
-    Encode and decode a block of :paramref:`vals` of bytes into block Format descibed by :paramref:`fi`
+    Encode and decode a block of :paramref:`vals` of bytes into
+    block format descibed by :paramref:`fi`
 
     Args:
       fi (BlockFormatInfo): Describes the target block format
       vals (numpy.array): Input block
-      compute_scale ((float, np.array) -> float):
-          Callable to compute the scale
+      compute_scale ((float, ArrayLike) -> float):
+          Callable to compute the scale, defaults to :func:`compute_scale_amax`
       round (RoundMode): Rounding mode to use, defaults to `TiesToEven`
 
     Returns: