UAIX.LmRuntime / Package guide

UAIX.LmRuntime.Backends.Metal

Metal backend registration, declared compatibility metadata, runtime identifiers, and fail-closed local probe diagnostics.

Required For Metal backend registration and fail-closed Metal diagnostics

UAIX.LmRuntime.Backends.Metal

Metal backend registration, declared compatibility metadata, runtime identifiers, and fail-closed local probe diagnostics.

Open on NuGet Package family

Overview

Backends.Metal registers the UAIX Metal backend family with Acceleration. It declares the intended Metal capability surface and package runtime identifiers (osx-arm64, osx-x64), then probes unavailable until a host-supplied native adapter proves assets, runtime libraries, drivers, and a device. The managed package performs no hidden native inference.

Who should use it Hosts building an explicit Metal compatibility lane, diagnostics UI, deployment validation, or future native adapter integration for Apple GPU hosts.

Install

.NET CLI

dotnet add package UAIX.LmRuntime.Backends.Metal

Project file

<PackageReference Include="UAIX.LmRuntime.Backends.Metal" />

Version policy: The documentation deliberately omits UAIX.LmRuntime package version numbers. Resolve and pin versions through your normal dependency-management and lock-file process.

Review the current package metadata, frameworks, dependencies, and downloads on NuGet ↗

Direct package dependencies

UAIX.LmRuntime.AccelerationNuGet ↗

Package role and boundaries

Required For Metal backend registration and fail-closed Metal diagnostics

You need the stable Metal backend ID and registry extension.
You need package-visible Metal runtime-identifier and capability declarations.
You need fail-closed probe diagnostics before Metal execution is proven.

Boundary

Installing or registering this package does not prove Metal execution.
The supplied managed backend does not load native inference libraries or enumerate a real device.
Do not report GPU availability unless a host adapter returns an available probe with concrete device evidence.

Registration is not execution

AddUaixMetalBackend adds metadata and probe behavior to the registry; it does not start a Metal engine.

Compatibility fails closed

The default diagnostic probe returns unavailable and states which native evidence has not been supplied.

Runtime identifiers are declared

The package declares osx-arm64, osx-x64; the current process and deployment still require independent validation.

Key types

These are the main entry points for this package. The generated reference below includes every documented type and member represented by public package XML documentation.

MetalRuntimeBackend RuntimeBackendRegistryExtensions

Coding examples

Examples use public package signatures documented on LMRuntime.com. Model paths, hashes, byte counts, prompts, and host-specific identifiers remain application inputs.

Register the Metal backend

Add the package-visible Metal backend to an explicit Acceleration registry.

RegisterMetalExample.cs

using UAIX.LmRuntime.Acceleration;
using UAIX.LmRuntime.Backends.Metal;

var registry = new RuntimeBackendRegistry();
registry.AddUaixMetalBackend();

IRuntimeBackend backend = registry.FindById(MetalRuntimeBackend.BackendId)
    ?? throw new InvalidOperationException("Metal backend registration failed.");

Console.WriteLine($"{backend.Id} / {backend.Kind}");

Boundary: Registration exposes Metal diagnostics. It does not prove a native runtime or device.

Probe the Metal package boundary

Inspect declared capabilities and the independent availability result.

ProbeMetalExample.cs

using UAIX.LmRuntime.Acceleration;
using UAIX.LmRuntime.Backends.Metal;

var backend = new MetalRuntimeBackend();
RuntimeBackendProbeResult probe = await backend.ProbeAsync(
    new RuntimeBackendOptions
    {
        RequestedRuntimeIdentifier =
            System.Runtime.InteropServices.RuntimeInformation.RuntimeIdentifier,
        RequireNativeAssets = true
    });

Console.WriteLine($"Declared API: {probe.Capabilities.BackendApiName}");
Console.WriteLine($"Native state: {probe.Capabilities.NativeAssetState}");
Console.WriteLine($"Available: {probe.IsAvailable}");
foreach (string diagnostic in probe.Diagnostics)
{
    Console.WriteLine(diagnostic);
}

Boundary: The default probe is expected to remain unavailable until a production adapter proves Metal assets, runtime libraries, and a device.

Require the Metal backend by ID

Reject CPU substitution when the workload contract specifically requires Metal.

RequireMetalExample.cs

using UAIX.LmRuntime.Acceleration;
using UAIX.LmRuntime.Backends.Metal;

var registry = new RuntimeBackendRegistry();
registry.AddUaixMetalBackend();

var selector = new RuntimeBackendSelector(registry);
RuntimeSelectionResult result = await selector.SelectAsync(
    new RuntimeBackendOptions
    {
        Policy = RuntimeSelectionPolicy.RequireBackendId,
        PreferredBackendId = MetalRuntimeBackend.BackendId,
        AllowCpuFallback = false,
        RequireNativeAssets = true
    });

if (!result.Succeeded)
{
    Console.Error.WriteLine(result.FailureReason);
}

Boundary: RequireBackendId fails instead of relabeling another backend as Metal.

List the Metal package runtime identifiers

Use declared identifiers as deployment metadata, not as proof that the current machine is ready.

MetalRuntimeIdentifiersExample.cs

using UAIX.LmRuntime.Backends.Metal;

var backend = new MetalRuntimeBackend();
foreach (string runtimeIdentifier in backend.Capabilities.RuntimeIdentifiers)
{
    Console.WriteLine(runtimeIdentifier);
}

Boundary: The declared identifiers are osx-arm64, osx-x64. Probe evidence remains required for a usable Metal execution path.

Open this package on NuGet Compare the full package family →

Generated API reference

Expand a type to review its documented fields, properties, constructors, methods, parameter descriptions, and return descriptions. Browser Find also works across the closed detail elements.

MetalRuntimeBackendUAIX.LmRuntime.Backends.Metal 2 members

Reports Metal backend compatibility and diagnostics to the acceleration registry.

Metal support is declared for Apple GPU systems. This package does not contain hidden Metal inference binaries and reports unavailable until runtime and device evidence exists.

Field BackendId

The stable backend identifier used by selection policies.

Method MetalRuntimeBackend

Initializes a new instance of the UAIX.LmRuntime.Backends.Metal.MetalRuntimeBackend class.

RuntimeBackendRegistryExtensionsUAIX.LmRuntime.Backends.Metal 1 member

Provides registration helpers for the Metal backend.

Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.

Method AddUaixMetalBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)

Adds the UAIX Metal backend to a registry.

registry: The registry to update.

Returns: The same registry instance for fluent configuration.

Frequently asked questions

Does this package execute through Metal today?

The managed registration package reports unavailable until a host-supplied native adapter proves Metal assets, runtime libraries, drivers, and a device.

Why does SupportsGpuExecution read true when IsAvailable is false?

Capabilities describe the backend family. IsAvailable describes the current proven host state.

Does registration contact the network?

No. Registration and the supplied diagnostic probe perform no downloads, provider calls, subprocess execution, or remote inference.