# kd.typing

[[[Source]]](https://github.com/google-research/kauldron/tree/main/kauldron/typing/__init__.py)

```{eval-rst}
.. automodule:: kauldron.typing
  :no-members:
```

## Symbols


### Class

|  |  |
--- | ---
[kd.typing.Any](Any) | 
[kd.typing.Array](Array) | 
[kd.typing.ArraySpec](ArraySpec) | Describes an array via it's dtype and shape.
[kd.typing.AxisName](AxisName) | 
[kd.typing.Bool](Bool) | 
[kd.typing.Complex](Complex) | 
[kd.typing.Complex64](Complex64) | 
[kd.typing.Float](Float) | 
[kd.typing.Float32](Float32) | 
[kd.typing.Hashable](Hashable) | 
[kd.typing.Int](Int) | 
[kd.typing.Integer](Integer) | 
[kd.typing.Memo](Memo) | Jaxtyping information about the shapes in the current scope.
[kd.typing.Num](Num) | 
[kd.typing.Sequence](Sequence) | All the operations on a read-only sequence.
[kd.typing.Shape](Shape) | Helper to construct concrete shape tuples from shape-specs.
[kd.typing.TfArray](TfArray) | 
[kd.typing.TfFloat](TfFloat) | 
[kd.typing.TfFloat32](TfFloat32) | 
[kd.typing.TfInt](TfInt) | 
[kd.typing.TfUInt8](TfUInt8) | 
[kd.typing.TypeCheckError](TypeCheckError) | Indicates a runtime typechecking error from the @typechecked decorator.
[kd.typing.UInt32](UInt32) | 
[kd.typing.UInt8](UInt8) | 
[kd.typing.XArray](XArray) | 

### Function

|  |  |
--- | ---
[kd.typing.Dim](Dim) | Helper to construct concrete Dim (for single-axis Shape).
[kd.typing.check_type](check_type) | Ensure that value matches expected_type, alias for typeguard.check_type.
[kd.typing.enable_kd_type_checking](enable_kd_type_checking) | Enable custom type checking for Kauldron types.
[kd.typing.set_shape](set_shape) | Validates the given shape and sets any previously unknown shapes.
[kd.typing.typechecked](typechecked) | Decorator to enable runtime type-checking and shape-checking.

### Attribute

|  |  |
--- | ---
[kd.typing.Union](Union) | 

### Typing

|  |  |
--- | ---
[kd.typing.Axes](Axes) | 
[kd.typing.Callable](Callable) | 
[kd.typing.DType](DType) | 
[kd.typing.ElementSpec](ElementSpec) | 
[kd.typing.Initializer](Initializer) | 
[kd.typing.PRNGKey](PRNGKey) | 
[kd.typing.PRNGKeyLike](PRNGKeyLike) | 
[kd.typing.PyTree](PyTree) | 
[kd.typing.Scalar](Scalar) | 
[kd.typing.ScalarFloat](ScalarFloat) | 
[kd.typing.ScalarInt](ScalarInt) | 
[kd.typing.Schedule](Schedule) | 

```{toctree}
:hidden:

Any
Array
ArraySpec
Axes
AxisName
Bool
Callable
Complex
Complex64
DType
Dim
ElementSpec
Float
Float32
Hashable
Initializer
Int
Integer
Memo
Num
PRNGKey
PRNGKeyLike
PyTree
Scalar
ScalarFloat
ScalarInt
Schedule
Sequence
Shape
TfArray
TfFloat
TfFloat32
TfInt
TfUInt8
TypeCheckError
UInt32
UInt8
Union
XArray
check_type
enable_kd_type_checking
set_shape
typechecked
```