runtime
Runtime probes for the local MLX environment.
import mlx_atomistic.runtime
Classes
Section titled “Classes”PlatformBoundaryReport
Section titled “PlatformBoundaryReport”class PlatformBoundaryReport def __init__(product_runtime: str, runtime: RuntimeInfo, reference_engine_policy: dict[str, str], sections: tuple[PlatformBoundarySection, ...])Traceable summary of the local mini-platform boundary.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
product_runtime | str | ||
runtime | RuntimeInfo | ||
reference_engine_policy | dict[str, str] | ||
sections | tuple[PlatformBoundarySection, ...] |
Methods
to_dict
Section titled “to_dict”def to_dict() -> dict[str, Any]Return a JSON-safe platform-boundary report.
Returns
dict[str, Any]
PlatformBoundarySection
Section titled “PlatformBoundarySection”class PlatformBoundarySection def __init__(name: str, status: str, local_concepts: tuple[str, ...], responsibility: str, vendor_references: tuple[str, ...] = ())One local platform-boundary concept group.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
name | str | ||
status | str | ||
local_concepts | tuple[str, ...] | ||
responsibility | str | ||
vendor_references | tuple[str, ...] | () |
Methods
to_dict
Section titled “to_dict”def to_dict() -> dict[str, Any]Return a JSON-safe section summary.
Returns
dict[str, Any]
ReadinessReport
Section titled “ReadinessReport”class ReadinessReport def __init__(name: str, status: str, blockers: tuple[str, ...] = (), warnings: tuple[str, ...] = (), metadata: dict[str, Any] | None = None)JSON-safe readiness status shared by platform gates.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
name | str | ||
status | str | ||
blockers | tuple[str, ...] | () | |
warnings | tuple[str, ...] | () | |
metadata | dict[str, Any] | None | None |
Methods
to_dict
Section titled “to_dict”def to_dict() -> dict[str, Any]Return a JSON-safe readiness report.
Returns
dict[str, Any]
RuntimeInfo
Section titled “RuntimeInfo”class RuntimeInfo def __init__(mlx_version: str, default_device: str, metal_available: bool)Small, display-friendly summary of the active MLX runtime.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
mlx_version | str | ||
default_device | str | ||
metal_available | bool |
Methods
to_dict
Section titled “to_dict”def to_dict() -> dict[str, Any]Return a JSON-safe runtime summary.
Returns
dict[str, Any]
Functions
Section titled “Functions”get_platform_boundary_report
Section titled “get_platform_boundary_report”def get_platform_boundary_report(*, runtime_info: RuntimeInfo | None = None) -> PlatformBoundaryReportReturn the local platform-boundary contract without importing reference engines.
Parameters
| Name | Type | Default | Description |
|---|---|---|---|
runtime_info | RuntimeInfo | None | None |
Returns
PlatformBoundaryReport
get_runtime_info
Section titled “get_runtime_info”def get_runtime_info() -> RuntimeInfoReturn basic information about MLX and the default device.
Returns
RuntimeInfo