Skip to content

Backend Configuration

Usually no direct interaction is required

Keep each system's defaults unless application-level profiling demonstrates that a different Warp block size is beneficial on the target hardware.

soromox.execution.config

User-facing configuration for optional system execution backends.

DEFAULT_GVS_BLOCK_DIM module-attribute

DEFAULT_GVS_BLOCK_DIM = 128

DEFAULT_GVS_LARGE_BLOCK_DIM module-attribute

DEFAULT_GVS_LARGE_BLOCK_DIM = 192

DEFAULT_PLANAR_PCS_BLOCK_DIM module-attribute

DEFAULT_PLANAR_PCS_BLOCK_DIM = 128

DEFAULT_PCS_BLOCK_DIM module-attribute

DEFAULT_PCS_BLOCK_DIM = 192

GVSBackendParams dataclass

GVSBackendParams(warp_block_dim: int)

Tune execution of the optional GVS Warp kernels.

Attributes:

Name Type Description
warp_block_dim int

CUDA threads per persistent dynamics and body-state recurrence block. It must be a multiple of 32 between 32 and 1024. Models with at most 64 active coordinates default to 128 threads; larger models default to 192.

__post_init__

__post_init__() -> None

Validate the immutable launch configuration.

Returns:

Type Description
None

None.

Raises:

Type Description
TypeError

If :attr:warp_block_dim is not an integer.

ValueError

If :attr:warp_block_dim is not a supported CUDA block dimension.

PCSBackendParams dataclass

PCSBackendParams(warp_block_dim: int)

Tune execution of the optional PlanarPCS and PCS Warp kernels.

Backend parameters are intentionally separate from the backend choice: backend selects "auto", "jax", or "warp", whereas this object configures the selected PCS implementation. Keeping the options in one typed object allows future tuning parameters to be added without expanding the system constructors with backend-specific keywords.

Attributes:

Name Type Description
warp_block_dim int

CUDA threads per persistent dynamics block. It must be a multiple of 32 between 32 and 1024. The recommended defaults are 128 for :class:~soromox.systems.pcs.PlanarPCS and 192 for :class:~soromox.systems.pcs.PCS.

__post_init__

__post_init__() -> None

Validate the immutable launch configuration.

Returns:

Type Description
None

None.

Raises:

Type Description
TypeError

If :attr:warp_block_dim is not an integer.

ValueError

If :attr:warp_block_dim is not a supported CUDA block dimension.