MatmulEpilogPreferences#

class nvmath.linalg.advanced.MatmulEpilogPreferences( aux_type: int | None = None, aux_amax: bool = False, )[source]#

A data class for providing epilog options as part of preferences to the Matmul.plan() method and the wrapper function matmul().

aux_type#

The requested datatype of the epilog auxiliary output. If not specified, this type will be determined based on the input types. Non-default auxiliary output types are only supported for narrow-precision operations and certain epilogs. For more details on the supported combinations, see CUBLASLT_MATMUL_DESC_EPILOGUE_AUX_DATA_TYPE in cuBLAS documentation. If this option is set to a narrow-precision data type, an additional epilog input "aux_quantization_scale" needs to be specified.

Type:: nvmath.CudaDataType

aux_amax#

If set, the absolute maximum (amax) of the epilog auxiliary output will be returned in the auxiliary output tensor. Only supported when aux_type option is set to a narrow-precision data type.

Type:: bool