kd.typing

kd.typing#

[[Source]]

Common Typing Annotations.

Symbols#

Class#

kd.typing.Any

kd.typing.Array

kd.typing.ArraySpec

Describes an array via it’s dtype and shape.

kd.typing.AxisName

kd.typing.Bool

kd.typing.Complex

kd.typing.Complex64

kd.typing.Float

kd.typing.Float32

kd.typing.Hashable

kd.typing.Int

kd.typing.Integer

kd.typing.Memo

Jaxtyping information about the shapes in the current scope.

kd.typing.Num

kd.typing.Sequence

All the operations on a read-only sequence.

kd.typing.Shape

Helper to construct concrete shape tuples from shape-specs.

kd.typing.TfArray

kd.typing.TfFloat

kd.typing.TfFloat32

kd.typing.TfInt

kd.typing.TfUInt8

kd.typing.TypeCheckError

Indicates a runtime typechecking error from the @typechecked decorator.

kd.typing.UInt32

kd.typing.UInt8

kd.typing.XArray

Function#

kd.typing.Dim

Helper to construct concrete Dim (for single-axis Shape).

kd.typing.check_type

Ensure that value matches expected_type, alias for typeguard.check_type.

kd.typing.enable_kd_type_checking

Enable custom type checking for Kauldron types.

kd.typing.set_shape

Validates the given shape and sets any previously unknown shapes.

kd.typing.typechecked

Decorator to enable runtime type-checking and shape-checking.

Attribute#

Typing#