{ "schema": "lmruntime.api-reference.v3", "provenance": "Generated from the public CLR metadata and XML documentation included with the supplied UAIX.LmRuntime package source/build outputs. Version numbers are intentionally omitted from public documentation.", "packages": [ { "id": "UAIX.LmRuntime.Abstractions", "types": [ { "name": "IClaimBoundaryPolicy", "full_name": "UAIX.LmRuntime.Abstractions.IClaimBoundaryPolicy", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates generated text against bounded claim-boundary rules.", "remarks": "", "members": [ { "kind": "method", "name": "EvaluateAsync(string,System.Collections.Generic.IReadOnlyList,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IClaimBoundaryPolicy.EvaluateAsync(System.String,System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.Governance.ClaimBoundaryRule},System.Threading.CancellationToken)", "summary": "Evaluates the async against the supplied policy and bounded observation state.", "remarks": "Implementations of IClaimBoundaryPolicy validate the supplied text, the supplied rules, and the supplied cancellation token before completing EvaluateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "rules": "The claim-boundary rules. Implementations may use defaults when this collection is empty.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IClaimBoundaryPolicy.EvaluateAsync: Evaluates the async against the supplied policy and bounded observation state. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IClaimLifecyclePolicy", "full_name": "UAIX.LmRuntime.Abstractions.IClaimLifecyclePolicy", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Enforces explicit evidence, boundary, and human-authority transitions for runtime claims.", "remarks": "", "members": [ { "kind": "method", "name": "Evaluate(UAIX.LmRuntime.Governance.ClaimTransitionRequest)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IClaimLifecyclePolicy.Evaluate(UAIX.LmRuntime.Governance.ClaimTransitionRequest)", "summary": "Evaluates the supplied request against the supplied policy and bounded observation state.", "remarks": "Implementations must reject promotion by proximity, must not infer human approval, and must not skip the reviewed and bounded stages when advancing a raw claim toward a promoted publication state.", "parameters": { "request": "The requested transition and its bounded evidence signals." }, "returns": "The ClaimTransitionDecision result produced by IClaimLifecyclePolicy.Evaluate for this contract: Evaluates the supplied request against the supplied policy and bounded observation state. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "IConstraintClosureAnalyzer", "full_name": "UAIX.LmRuntime.Abstractions.IConstraintClosureAnalyzer", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Analyzes a bounded work-constraint registry for closed maintenance cycles and retirement candidates.", "remarks": "", "members": [ { "kind": "method", "name": "Analyze(UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IConstraintClosureAnalyzer.Analyze(UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot)", "summary": "Computes deterministic graph closure information for the supplied registry snapshot.", "remarks": "Retired nodes are retained for auditability but excluded from active closure. A singleton component is considered closed only when it has an explicit self-loop; ordinary acyclic singleton nodes remain open.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases." }, "returns": "The closure report, including validation diagnostics and retirement candidates." } ] }, { "name": "IConstraintPolicy", "full_name": "UAIX.LmRuntime.Abstractions.IConstraintPolicy", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates request-side constraints before budgeted execution is allowed.", "remarks": "", "members": [ { "kind": "method", "name": "EvaluateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Collections.Generic.IReadOnlyList,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IConstraintPolicy.EvaluateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.Governance.ConstraintRule},System.Threading.CancellationToken)", "summary": "Evaluates the request against configured constraint rules.", "remarks": "Implementations of IConstraintPolicy validate the supplied request, the supplied rules, and the supplied cancellation token before completing EvaluateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for EvaluateAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "rules": "The rules sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IConstraintPolicy.EvaluateAsync: Evaluates the request against configured constraint rules. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IEvidenceLedger", "full_name": "UAIX.LmRuntime.Abstractions.IEvidenceLedger", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Appends immutable governance evidence receipts.", "remarks": "", "members": [ { "kind": "method", "name": "AppendAsync(UAIX.LmRuntime.Governance.GovernanceDecisionReceipt,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IEvidenceLedger.AppendAsync(UAIX.LmRuntime.Governance.GovernanceDecisionReceipt,System.Threading.CancellationToken)", "summary": "Appends the async to the current IEvidenceLedger state after validating capacity, ordering, and ownership constraints.", "remarks": "Implementations of IEvidenceLedger validate the supplied receipt and the supplied cancellation token before completing AppendAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "receipt": "The immutable governance decision receipt appended to the caller-owned evidence ledger in the supplied order.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "A task that represents completion of the asynchronous operation." } ] }, { "name": "IInferenceRuntime", "full_name": "UAIX.LmRuntime.Abstractions.IInferenceRuntime", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Defines the public runtime orchestration API.", "remarks": "", "members": [ { "kind": "method", "name": "GenerateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IInferenceRuntime.GenerateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "summary": "Generates the async through the deterministic execution path owned by IInferenceRuntime.", "remarks": "Implementations of IInferenceRuntime validate the supplied request and the supplied cancellation token before completing GenerateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for GenerateAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous Task that completes with the result of IInferenceRuntime.GenerateAsync: Generates the async through the deterministic execution path owned by IInferenceRuntime. Fault and cancellation states are propagated without a successful partial result." }, { "kind": "method", "name": "StreamAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IInferenceRuntime.StreamAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "summary": "Streams the async in observable sequence order while honoring caller cancellation.", "remarks": "Implementations of IInferenceRuntime validate the supplied request and the supplied cancellation token before completing StreamAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for StreamAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The normalized streaming events, enumerated in source order with caller cancellation and failure propagation governed by StreamAsync." } ] }, { "name": "IInferenceSession", "full_name": "UAIX.LmRuntime.Abstractions.IInferenceSession", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Defines a stateful inference session with explicit prefill and decode phases.", "remarks": "", "members": [ { "kind": "property", "name": "SessionId", "xml_id": "P:UAIX.LmRuntime.Abstractions.IInferenceSession.SessionId", "summary": "Gets the session identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "DecodeNextAsync(System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IInferenceSession.DecodeNextAsync(System.Threading.CancellationToken)", "summary": "Decodes the next token or text chunk from the session.", "remarks": "Implementations of IInferenceSession validate the supplied cancellation token before completing DecodeNextAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IInferenceSession.DecodeNextAsync: Decodes the next token or text chunk from the session. Fault and cancellation states are propagated without a successful partial result." }, { "kind": "method", "name": "PrefillAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IInferenceSession.PrefillAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "summary": "Prefills the async into the current model state after validating token and cache bounds.", "remarks": "Implementations of IInferenceSession validate the supplied request and the supplied cancellation token before completing PrefillAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for PrefillAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The number of prompt tokens accepted by the session." } ] }, { "name": "IMemoryFirewall", "full_name": "UAIX.LmRuntime.Abstractions.IMemoryFirewall", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates source-routed memory packets before they can enter an active retrieval tier.", "remarks": "", "members": [ { "kind": "method", "name": "Evaluate(UAIX.LmRuntime.Governance.MemoryFirewallRequest)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IMemoryFirewall.Evaluate(UAIX.LmRuntime.Governance.MemoryFirewallRequest)", "summary": "Evaluates packet provenance, integrity, freshness, entropy, trust, contradiction, evidence, and review state.", "remarks": "Raw memory content is intentionally outside this contract; callers provide bounded digests and provenance metadata.", "parameters": { "request": "The MemoryFirewallRequest containing the complete caller-owned inputs for Evaluate; required fields are validated and mutable collections are snapshotted before state changes or large allocations." }, "returns": "The memory region containing the supplied request, bounded to the validated range owned by the result." } ] }, { "name": "IModelAdapter", "full_name": "UAIX.LmRuntime.Abstractions.IModelAdapter", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Defines the execution boundary for provider-hosted or local models.", "remarks": "", "members": [ { "kind": "property", "name": "ProviderName", "xml_id": "P:UAIX.LmRuntime.Abstractions.IModelAdapter.ProviderName", "summary": "Gets the provider or backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GenerateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IModelAdapter.GenerateAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "summary": "Generates the async through the deterministic execution path owned by IModelAdapter.", "remarks": "Implementations of IModelAdapter validate the supplied request and the supplied cancellation token before completing GenerateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for GenerateAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous Task that completes with the result of IModelAdapter.GenerateAsync: Generates the async through the deterministic execution path owned by IModelAdapter. Fault and cancellation states are propagated without a successful partial result." }, { "kind": "method", "name": "GetModelAsync(string,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IModelAdapter.GetModelAsync(System.String,System.Threading.CancellationToken)", "summary": "Gets model metadata for the requested model.", "remarks": "Implementations of IModelAdapter validate the supplied model and the supplied cancellation token before completing GetModelAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "model": "The model whose validated metadata, tensors, or runtime state are consumed by this operation.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IModelAdapter.GetModelAsync: Gets model metadata for the requested model. Fault and cancellation states are propagated without a successful partial result." }, { "kind": "method", "name": "StreamAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IModelAdapter.StreamAsync(UAIX.LmRuntime.Contracts.InferenceRequest,System.Threading.CancellationToken)", "summary": "Streams the async in observable sequence order while honoring caller cancellation.", "remarks": "Implementations of IModelAdapter validate the supplied request and the supplied cancellation token before completing StreamAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The InferenceRequest containing the complete caller-owned inputs for StreamAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The normalized streaming event sequence, enumerated in source order with caller cancellation and failure propagation governed by StreamAsync." } ] }, { "name": "IQuarantineLedger", "full_name": "UAIX.LmRuntime.Abstractions.IQuarantineLedger", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Writes append-only records for generated or unreviewed artifacts that require quarantine.", "remarks": "", "members": [ { "kind": "method", "name": "AppendAsync(UAIX.LmRuntime.Governance.QuarantineRecord,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IQuarantineLedger.AppendAsync(UAIX.LmRuntime.Governance.QuarantineRecord,System.Threading.CancellationToken)", "summary": "Appends the async to the current IQuarantineLedger state after validating capacity, ordering, and ownership constraints.", "remarks": "Implementations of IQuarantineLedger validate the supplied record and the supplied cancellation token before completing AppendAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "record": "The immutable quarantine record appended to the caller-owned ledger without altering its evidence fields.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "A task that represents completion of the asynchronous operation." } ] }, { "name": "IResourceEconomyEngine", "full_name": "UAIX.LmRuntime.Abstractions.IResourceEconomyEngine", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Advances the structural-control resource economy using explicit gain and cost inputs.", "remarks": "", "members": [ { "kind": "method", "name": "Evaluate(UAIX.LmRuntime.Governance.ResourceEconomyState,UAIX.LmRuntime.Governance.ResourceEconomyInput,UAIX.LmRuntime.Governance.ResourceEconomyPolicy)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IResourceEconomyEngine.Evaluate(UAIX.LmRuntime.Governance.ResourceEconomyState,UAIX.LmRuntime.Governance.ResourceEconomyInput,UAIX.LmRuntime.Governance.ResourceEconomyPolicy)", "summary": "Evaluates the supplied state against the supplied policy and bounded observation state.", "remarks": "Implementations must not mutate the supplied state and must reject non-finite or negative economic inputs. The returned transition is an evaluation artifact; callers decide whether an approved state is committed.", "parameters": { "state": "The immutable state observed before the candidate action.", "input": "The gain and burden estimates for the candidate action.", "policy": "The policy that define validation limits and execution behavior; required values are checked before use." }, "returns": "The ResourceEconomyTransition result produced by IResourceEconomyEngine.Evaluate for this contract: Evaluates the supplied state against the supplied policy and bounded observation state. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "IReviewGatePolicy", "full_name": "UAIX.LmRuntime.Abstractions.IReviewGatePolicy", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates slow-loop review gates before consequential runtime work proceeds.", "remarks": "", "members": [ { "kind": "method", "name": "EvaluateAsync(UAIX.LmRuntime.Governance.ReviewGateRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IReviewGatePolicy.EvaluateAsync(UAIX.LmRuntime.Governance.ReviewGateRequest,System.Threading.CancellationToken)", "summary": "Evaluates whether a request can continue in the automatic lane.", "remarks": "Implementations of IReviewGatePolicy validate the supplied request and the supplied cancellation token before completing EvaluateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The ReviewGateRequest containing the complete caller-owned inputs for EvaluateAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IReviewGatePolicy.EvaluateAsync: Evaluates whether a request can continue in the automatic lane. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IRuntimeBudgetGovernor", "full_name": "UAIX.LmRuntime.Abstractions.IRuntimeBudgetGovernor", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates whether runtime work can proceed under the configured resource economy.", "remarks": "", "members": [ { "kind": "method", "name": "EvaluateAsync(UAIX.LmRuntime.Governance.RuntimeBudgetRequest,UAIX.LmRuntime.Governance.RuntimeBudget,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IRuntimeBudgetGovernor.EvaluateAsync(UAIX.LmRuntime.Governance.RuntimeBudgetRequest,UAIX.LmRuntime.Governance.RuntimeBudget,System.Threading.CancellationToken)", "summary": "Evaluates the requested runtime work against a resource budget.", "remarks": "Implementations of IRuntimeBudgetGovernor validate the supplied request, the supplied budget, and the supplied cancellation token before completing EvaluateAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The RuntimeBudgetRequest containing the complete caller-owned inputs for EvaluateAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "budget": "The immutable runtime budget whose quantitative limits constrain the evaluated operation or proposal.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IRuntimeBudgetGovernor.EvaluateAsync: Evaluates the requested runtime work against a resource budget. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IStructuralChangePlanner", "full_name": "UAIX.LmRuntime.Abstractions.IStructuralChangePlanner", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Evaluates proposed structural mutations through budget, no-op, evidence, and review gates.", "remarks": "", "members": [ { "kind": "method", "name": "PlanAsync(UAIX.LmRuntime.Governance.StructuralChangeRequest,UAIX.LmRuntime.Governance.RuntimeBudget,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IStructuralChangePlanner.PlanAsync(UAIX.LmRuntime.Governance.StructuralChangeRequest,UAIX.LmRuntime.Governance.RuntimeBudget,System.Threading.CancellationToken)", "summary": "Plans the disposition for a proposed structural change.", "remarks": "Implementations of IStructuralChangePlanner validate the supplied request, the supplied budget, and the supplied cancellation token before completing PlanAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "request": "The StructuralChangeRequest containing the complete caller-owned inputs for PlanAsync; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "budget": "The immutable runtime budget whose quantitative limits constrain the evaluated operation or proposal.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IStructuralChangePlanner.PlanAsync: Plans the disposition for a proposed structural change. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IStructuralOperatorEngine", "full_name": "UAIX.LmRuntime.Abstractions.IStructuralOperatorEngine", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Converts resource and claim-boundary decisions into an auditable structural operator receipt.", "remarks": "", "members": [ { "kind": "method", "name": "DecideAsync(UAIX.LmRuntime.Governance.RuntimeBudgetDecision,UAIX.LmRuntime.Governance.ClaimBoundaryDecision,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IStructuralOperatorEngine.DecideAsync(UAIX.LmRuntime.Governance.RuntimeBudgetDecision,UAIX.LmRuntime.Governance.ClaimBoundaryDecision,System.Threading.CancellationToken)", "summary": "Selects the structural operator for the current decision context.", "remarks": "Implementations of IStructuralOperatorEngine validate the supplied budget decision, the supplied claim boundary decision, and the supplied cancellation token before completing DecideAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "budgetDecision": "The prior budget decision that must authorize the structural operation before any proposal can advance.", "claimBoundaryDecision": "The claim-boundary decision used to constrain the resulting action, or null when no claim evaluation applies.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of IStructuralOperatorEngine.DecideAsync: Selects the structural operator for the current decision context. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IStructuralPhaseDetector", "full_name": "UAIX.LmRuntime.Abstractions.IStructuralPhaseDetector", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Classifies the current structural regime from bounded fast-loop measurements.", "remarks": "", "members": [ { "kind": "method", "name": "Detect(UAIX.LmRuntime.Governance.StructuralObservationWindow,UAIX.LmRuntime.Governance.StructuralPhasePolicy)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IStructuralPhaseDetector.Detect(UAIX.LmRuntime.Governance.StructuralObservationWindow,UAIX.LmRuntime.Governance.StructuralPhasePolicy)", "summary": "Classifies one observation window using deterministic threshold precedence.", "remarks": "Drift and resource exhaustion take precedence over growth classifications. Invalid or undersized windows return StructuralPhase.Unknown rather than manufacturing a confident phase label.", "parameters": { "window": "The immutable observation window whose ordered measurements are evaluated to determine the structural phase.", "policy": "The policy that define validation limits and execution behavior; required values are checked before use." }, "returns": "The StructuralPhaseAssessment result produced by IStructuralPhaseDetector.Detect for this contract: Classifies one observation window using deterministic threshold precedence. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "ITeleodynamicControlPlane", "full_name": "UAIX.LmRuntime.Abstractions.ITeleodynamicControlPlane", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Coordinates the resource, proposal, closure, phase, claim, and trace components on a slow timescale.", "remarks": "", "members": [ { "kind": "method", "name": "Evaluate(UAIX.LmRuntime.Governance.TeleodynamicControlRequest)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITeleodynamicControlPlane.Evaluate(UAIX.LmRuntime.Governance.TeleodynamicControlRequest)", "summary": "Evaluates one complete control cycle without mutating model weights, tokenizer state, or generated output.", "remarks": "The result is an auditable recommendation. Applying a structural mutation remains an explicit reviewed actuator step.", "parameters": { "request": "The TeleodynamicControlRequest containing the complete caller-owned inputs for Evaluate; required fields are validated and mutable collections are snapshotted before state changes or large allocations." }, "returns": "The phase, closure, structural decision, claim decision when present, and tamper-evident trace entry." } ] }, { "name": "ITeleodynamicDecisionEngine", "full_name": "UAIX.LmRuntime.Abstractions.ITeleodynamicDecisionEngine", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Selects a bounded structural proposal or explicit no-op using resource and evidence constraints.", "remarks": "", "members": [ { "kind": "method", "name": "Decide(string,System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Governance.ResourceEconomyState,UAIX.LmRuntime.Governance.ResourceEconomyPolicy,UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy,System.DateTimeOffset)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITeleodynamicDecisionEngine.Decide(System.String,System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.Governance.StructuralProposal},UAIX.LmRuntime.Governance.ResourceEconomyState,UAIX.LmRuntime.Governance.ResourceEconomyPolicy,UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy,System.DateTimeOffset)", "summary": "Evaluates the proposal set and returns one deterministic, no-op-aware decision.", "remarks": "Proposal order must not affect the result. Implementations must prefer no-op on objective ties and must expose every rejected alternative so an operator can audit why a structural mutation was not selected.", "parameters": { "decisionId": "The stable identifier assigned by the caller to the decision cycle.", "proposals": "The proposals sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "state": "The validated state value consumed by the operation; mutations, when applicable, are limited to the explicitly documented state owner.", "resourcePolicy": "The immutable resource-economy policy that defines allowed transitions and quantitative thresholds for the decision.", "decisionPolicy": "The immutable decision policy that constrains proposal selection, no-op behavior, and review requirements.", "createdUtc": "The caller-supplied UTC timestamp recorded in the deterministic decision receipt; non-UTC offsets must be normalized by the caller." }, "returns": "The TeleodynamicDecision result produced by ITeleodynamicDecisionEngine.Decide for this contract: Evaluates the proposal set and returns one deterministic, no-op-aware decision. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "ITeleodynamicTraceChain", "full_name": "UAIX.LmRuntime.Abstractions.ITeleodynamicTraceChain", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Maintains an append-only, SHA-256-linked trace of bounded structural-control decisions.", "remarks": "", "members": [ { "kind": "method", "name": "Append(UAIX.LmRuntime.Governance.TeleodynamicTraceRequest)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITeleodynamicTraceChain.Append(UAIX.LmRuntime.Governance.TeleodynamicTraceRequest)", "summary": "Appends one canonical event to the trace.", "remarks": "Implementations must assign sequence numbers atomically and must include the prior entry hash in the new content hash so omission, reordering, or mutation can be detected by Verify.", "parameters": { "request": "The TeleodynamicTraceRequest containing the complete caller-owned inputs for Append; required fields are validated and mutable collections are snapshotted before state changes or large allocations." }, "returns": "The immutable trace entry assigned to the event." }, { "kind": "method", "name": "Snapshot", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITeleodynamicTraceChain.Snapshot", "summary": "Gets an immutable snapshot of the current trace entries.", "remarks": "The returned collection must not expose the mutable backing store used by the implementation.", "parameters": {}, "returns": "The current trace entries in ascending sequence order." }, { "kind": "method", "name": "Verify(System.Collections.Generic.IReadOnlyList)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITeleodynamicTraceChain.Verify(System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.Governance.TeleodynamicTraceEntry})", "summary": "Verifies an arbitrary trace snapshot without mutating the current chain.", "remarks": "Verification must recompute every canonical content hash and validate sequence continuity plus prior-hash linkage so omission, reordering, and post-append mutation remain observable.", "parameters": { "entries": "The entries to verify in their supplied order." }, "returns": "The first detected chain error or a valid result." } ] }, { "name": "ITokenizer", "full_name": "UAIX.LmRuntime.Abstractions.ITokenizer", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Defines tokenization behavior for runtime token budgeting and model parity work.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Abstractions.ITokenizer.Name", "summary": "Gets the tokenizer name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITokenizer.CountTokens(System.String)", "summary": "Counts tokens in a single text value.", "remarks": "Implementations of ITokenizer validate the supplied text before completing CountTokens and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "The int value computed by ITokenizer.CountTokens for this contract: Counts tokens in a single text value. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts tokens across a set of model messages.", "remarks": "Implementations of ITokenizer validate the supplied messages before completing CountTokens and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by ITokenizer.CountTokens for this contract: Counts tokens across a set of model messages. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes token identifiers into text when the tokenizer has a vocabulary.", "remarks": "Implementations of ITokenizer validate the supplied token identifiers before completing Decode and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes text into token identifiers when the tokenizer has a vocabulary.", "remarks": "Implementations of ITokenizer validate the supplied text, the supplied add BOS, and the supplied add EOS before completing Encode and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Abstractions.ITokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "Implementations of ITokenizer validate the supplied text before completing Tokenize and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] }, { "name": "IUaiMemoryStore", "full_name": "UAIX.LmRuntime.Abstractions.IUaiMemoryStore", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Defines append and query behavior for.uai-backed runtime memory.", "remarks": "", "members": [ { "kind": "method", "name": "AppendAsync(UAIX.LmRuntime.Contracts.UaiMemoryEntry,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IUaiMemoryStore.AppendAsync(UAIX.LmRuntime.Contracts.UaiMemoryEntry,System.Threading.CancellationToken)", "summary": "Appends the async to the current IUaiMemoryStore state after validating capacity, ordering, and ownership constraints.", "remarks": "Implementations of IUaiMemoryStore validate the supplied entry and the supplied cancellation token before completing AppendAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "entry": "The entry examined or transformed by this operation; it must satisfy the declared type and range constraints.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "A task that completes when the entry has been written." }, { "kind": "method", "name": "ReadAsync(UAIX.LmRuntime.Contracts.MemoryQuery,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Abstractions.IUaiMemoryStore.ReadAsync(UAIX.LmRuntime.Contracts.MemoryQuery,System.Threading.CancellationToken)", "summary": "Reads the async from the current IUaiMemoryStore state using the component's validated representation.", "remarks": "Implementations of IUaiMemoryStore validate the supplied query and the supplied cancellation token before completing ReadAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "query": "The bounded memory query defining the caller-authorized selection criteria and result ceiling.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask> that completes with the result of IUaiMemoryStore.ReadAsync: Reads the async from the current IUaiMemoryStore state using the component's validated representation. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "RuntimePackageVersion", "full_name": "UAIX.LmRuntime.Abstractions.RuntimePackageVersion", "namespace": "UAIX.LmRuntime.Abstractions", "summary": "Provides the runtime package version emitted by the centrally configured assembly metadata.", "remarks": "Package projects obtain their version from Directory.Build.props. Runtime components should use this type instead of repeating a version literal, which keeps evidence, session, CLI, and governance records aligned with the assembly that produced them.", "members": [ { "kind": "property", "name": "Current", "xml_id": "P:UAIX.LmRuntime.Abstractions.RuntimePackageVersion.Current", "summary": "Gets the normalized three-part package version of the active runtime distribution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Resolve(System.Reflection.Assembly)", "xml_id": "M:UAIX.LmRuntime.Abstractions.RuntimePackageVersion.Resolve(System.Reflection.Assembly)", "summary": "Resolves a normalized three-part package version from an assembly identity.", "remarks": "The method intentionally reads AssemblyName.Version rather than informational metadata so build labels and source-revision suffixes cannot leak into persisted compatibility fields.", "parameters": { "assembly": "The assembly whose centrally generated version metadata is authoritative." }, "returns": "A major.minor.build version string, or 0.0.0 when the assembly has no version metadata." } ] }, { "name": "AdapterStatus", "full_name": "UAIX.LmRuntime.Contracts.AdapterStatus", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents normalized adapter status information.", "remarks": "", "members": [ { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Contracts.AdapterStatus.Message", "summary": "Gets a normalized warning or diagnostic message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequestId", "xml_id": "P:UAIX.LmRuntime.Contracts.AdapterStatus.RequestId", "summary": "Gets the provider request identifier, if supplied by the backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StatusCode", "xml_id": "P:UAIX.LmRuntime.Contracts.AdapterStatus.StatusCode", "summary": "Gets the provider status code, if applicable.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "FinishReason", "full_name": "UAIX.LmRuntime.Contracts.FinishReason", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Identifies why an inference response stopped.", "remarks": "", "members": [ { "kind": "field", "name": "Cancelled", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.Cancelled", "summary": "The request was cancelled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ContentFilter", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.ContentFilter", "summary": "The runtime stopped generation because content was filtered.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Error", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.Error", "summary": "The backend reported an execution error.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Length", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.Length", "summary": "The model hit the configured maximum output token budget.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PolicyDenied", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.PolicyDenied", "summary": "The runtime selected no-op because policy, budget, or claim-boundary rules blocked automatic execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Stop", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.Stop", "summary": "The model naturally stopped.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ToolCall", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.ToolCall", "summary": "The model emitted or requested a tool call.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Contracts.FinishReason.Unknown", "summary": "The provider or backend did not return a reason.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "InferenceRequest", "full_name": "UAIX.LmRuntime.Contracts.InferenceRequest", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a provider-neutral inference request.", "remarks": "", "members": [ { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.ConversationId", "summary": "Gets the conversation identifier when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxOutputTokens", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.MaxOutputTokens", "summary": "Gets the maximum output token budget.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Messages", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Messages", "summary": "Gets the message sequence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Metadata", "summary": "Gets caller-supplied metadata propagated to adapters and diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Model", "summary": "Gets the requested model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResponseFormat", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.ResponseFormat", "summary": "Gets the requested response format.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Seed", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Seed", "summary": "Gets the deterministic sampler seed when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopSequences", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.StopSequences", "summary": "Gets stop sequences used to terminate generation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Temperature", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Temperature", "summary": "Gets the sampling temperature.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolChoice", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.ToolChoice", "summary": "Gets tool selection guidance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tools", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.Tools", "summary": "Gets tool definitions available to the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TopK", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.TopK", "summary": "Gets the top-k sampling cutoff when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TopP", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.TopP", "summary": "Gets the nucleus sampling probability cutoff.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UseMemory", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceRequest.UseMemory", "summary": "Gets a value indicating whether.uai memory should be injected before execution.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "InferenceResponse", "full_name": "UAIX.LmRuntime.Contracts.InferenceResponse", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a normalized inference response.", "remarks": "", "members": [ { "kind": "property", "name": "AdapterStatus", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.AdapterStatus", "summary": "Gets normalized adapter status information.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.ConversationId", "summary": "Gets the conversation identifier when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.CreatedUtc", "summary": "Gets the UTC creation timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FinishReason", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.FinishReason", "summary": "Gets the legacy textual finish reason.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FinishReasonKind", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.FinishReasonKind", "summary": "Gets the strongly typed finish reason.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GovernanceReceipt", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.GovernanceReceipt", "summary": "Gets the governance receipt emitted by budget or claim-boundary policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.Model", "summary": "Gets the resolved model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputText", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.OutputText", "summary": "Gets the output text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Provider", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.Provider", "summary": "Gets the provider or backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResponseId", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.ResponseId", "summary": "Gets the response identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Usage", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceResponse.Usage", "summary": "Gets normalized usage data.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "InferenceUsage", "full_name": "UAIX.LmRuntime.Contracts.InferenceUsage", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents normalized model usage data.", "remarks": "", "members": [ { "kind": "property", "name": "CachedInputTokens", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceUsage.CachedInputTokens", "summary": "Gets the provider-cached input token count when available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedCostMicros", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceUsage.EstimatedCostMicros", "summary": "Gets the estimated cost in one-millionth currency units, if known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "InputTokens", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceUsage.InputTokens", "summary": "Gets the input token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputTokens", "xml_id": "P:UAIX.LmRuntime.Contracts.InferenceUsage.OutputTokens", "summary": "Gets the output token count.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlmMessage", "full_name": "UAIX.LmRuntime.Contracts.LlmMessage", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a canonical chat or completion message.", "remarks": "", "members": [ { "kind": "property", "name": "Content", "xml_id": "P:UAIX.LmRuntime.Contracts.LlmMessage.Content", "summary": "Gets the text content for the message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.Contracts.LlmMessage.Role", "summary": "Gets the message role.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolCallId", "xml_id": "P:UAIX.LmRuntime.Contracts.LlmMessage.ToolCallId", "summary": "Gets the tool call identifier associated with a tool message when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Assistant(string)", "xml_id": "M:UAIX.LmRuntime.Contracts.LlmMessage.Assistant(System.String)", "summary": "Creates an immutable assistant-role LLM message from caller-supplied content.", "remarks": "A null content reference is normalized to an empty string. The factory allocates a new message, assigns no tool-call identifier, and does not retain mutable caller-owned state.", "parameters": { "content": "The content processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "A new assistant-role message whose content is never null." }, { "kind": "method", "name": "Developer(string)", "xml_id": "M:UAIX.LmRuntime.Contracts.LlmMessage.Developer(System.String)", "summary": "Creates an immutable developer-role LLM message from caller-supplied content.", "remarks": "A null content reference is normalized to an empty string. The factory allocates a new message, assigns no tool-call identifier, and does not retain mutable caller-owned state.", "parameters": { "content": "The content processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "A new developer-role message whose content is never null." }, { "kind": "method", "name": "System(string)", "xml_id": "M:UAIX.LmRuntime.Contracts.LlmMessage.System(System.String)", "summary": "Creates an immutable system-role LLM message from caller-supplied content.", "remarks": "A null content reference is normalized to an empty string. The factory allocates a new message, assigns no tool-call identifier, and does not retain mutable caller-owned state.", "parameters": { "content": "The content processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "A new system-role message whose content is never null." }, { "kind": "method", "name": "Tool(string,string)", "xml_id": "M:UAIX.LmRuntime.Contracts.LlmMessage.Tool(System.String,System.String)", "summary": "Creates an immutable tool-role LLM message correlated to the supplied tool call.", "remarks": "A null content reference is normalized to an empty string. The caller-owned correlation identifier is copied by reference as immutable string state; this factory does not validate tool availability or grant execution authority.", "parameters": { "toolCallId": "The caller-owned tool call id used for deterministic correlation by Tool; it must satisfy the documented range and grammar and grants no additional authority.", "content": "The content processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "A new tool-role message containing the supplied correlation identifier and non-null content." }, { "kind": "method", "name": "User(string)", "xml_id": "M:UAIX.LmRuntime.Contracts.LlmMessage.User(System.String)", "summary": "Creates an immutable user-role LLM message from caller-supplied content.", "remarks": "A null content reference is normalized to an empty string. The factory allocates a new message, assigns no tool-call identifier, and does not retain mutable caller-owned state.", "parameters": { "content": "The content processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract." }, "returns": "A new user-role message whose content is never null." } ] }, { "name": "LlmRole", "full_name": "UAIX.LmRuntime.Contracts.LlmRole", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Identifies the role of a message in a canonical inference request.", "remarks": "", "members": [ { "kind": "field", "name": "Assistant", "xml_id": "F:UAIX.LmRuntime.Contracts.LlmRole.Assistant", "summary": "Assistant message content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Developer", "xml_id": "F:UAIX.LmRuntime.Contracts.LlmRole.Developer", "summary": "Developer-level instruction context.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "System", "xml_id": "F:UAIX.LmRuntime.Contracts.LlmRole.System", "summary": "System-level instruction context.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Tool", "xml_id": "F:UAIX.LmRuntime.Contracts.LlmRole.Tool", "summary": "Tool input or output content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "User", "xml_id": "F:UAIX.LmRuntime.Contracts.LlmRole.User", "summary": "End-user message content.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryQuery", "full_name": "UAIX.LmRuntime.Contracts.MemoryQuery", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a query against.uai memory entries.", "remarks": "", "members": [ { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Contracts.MemoryQuery.ConversationId", "summary": "Gets the conversation identifier filter when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxEntries", "xml_id": "P:UAIX.LmRuntime.Contracts.MemoryQuery.MaxEntries", "summary": "Gets the maximum number of entries to return.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Text", "xml_id": "P:UAIX.LmRuntime.Contracts.MemoryQuery.Text", "summary": "Gets full-text query text when one is present.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ModelDescriptor", "full_name": "UAIX.LmRuntime.Contracts.ModelDescriptor", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Describes a model visible to the runtime.", "remarks": "", "members": [ { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.Capabilities", "summary": "Gets capability names exposed by the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.ContextLength", "summary": "Gets the maximum context length in tokens.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsLocal", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.IsLocal", "summary": "Gets a value indicating whether the model executes locally.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelId", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.ModelId", "summary": "Gets the model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Provider", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.Provider", "summary": "Gets the provider or backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsStreaming", "xml_id": "P:UAIX.LmRuntime.Contracts.ModelDescriptor.SupportsStreaming", "summary": "Gets a value indicating whether streaming is supported.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ProviderError", "full_name": "UAIX.LmRuntime.Contracts.ProviderError", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a normalized adapter or provider error.", "remarks": "", "members": [ { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Contracts.ProviderError.Code", "summary": "Gets the normalized error code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Contracts.ProviderError.Message", "summary": "Gets the error message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Retriable", "xml_id": "P:UAIX.LmRuntime.Contracts.ProviderError.Retriable", "summary": "Gets a value indicating whether retry may be safe.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RetryAfter", "xml_id": "P:UAIX.LmRuntime.Contracts.ProviderError.RetryAfter", "summary": "Gets the suggested retry delay when available.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResponseFormat", "full_name": "UAIX.LmRuntime.Contracts.ResponseFormat", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Describes structured output requirements for a response.", "remarks": "", "members": [ { "kind": "property", "name": "JsonSchema", "xml_id": "P:UAIX.LmRuntime.Contracts.ResponseFormat.JsonSchema", "summary": "Gets the JSON schema document used when UAIX.LmRuntime.Contracts.ResponseFormat.Kind is UAIX.LmRuntime.Contracts.ResponseFormatKind.JsonSchema.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Contracts.ResponseFormat.Kind", "summary": "Gets the response format kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Strict", "xml_id": "P:UAIX.LmRuntime.Contracts.ResponseFormat.Strict", "summary": "Gets a value indicating whether the backend should enforce strict schema adherence when supported.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResponseFormatKind", "full_name": "UAIX.LmRuntime.Contracts.ResponseFormatKind", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Identifies the canonical output format mode.", "remarks": "", "members": [ { "kind": "field", "name": "JsonObject", "xml_id": "F:UAIX.LmRuntime.Contracts.ResponseFormatKind.JsonObject", "summary": "JSON object response.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "JsonSchema", "xml_id": "F:UAIX.LmRuntime.Contracts.ResponseFormatKind.JsonSchema", "summary": "JSON schema-constrained response.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Text", "xml_id": "F:UAIX.LmRuntime.Contracts.ResponseFormatKind.Text", "summary": "Free-form text response.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeOptions", "full_name": "UAIX.LmRuntime.Contracts.RuntimeOptions", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Defines runtime orchestration settings.", "remarks": "", "members": [ { "kind": "property", "name": "AvailableResourceBudget", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.AvailableResourceBudget", "summary": "Gets the available resource budget used by the default governor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimBoundaryRules", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ClaimBoundaryRules", "summary": "Gets additional claim-boundary rules used by the default claim policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConstraintRules", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ConstraintRules", "summary": "Gets additional request-side constraint rules used by the default constraint policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DefaultModel", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.DefaultModel", "summary": "Gets the default model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnableClaimBoundaryPolicy", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.EnableClaimBoundaryPolicy", "summary": "Gets a value indicating whether generated text is evaluated against claim-boundary rules.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnableConstraintPolicy", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.EnableConstraintPolicy", "summary": "Gets a value indicating whether request-side constraint rules are evaluated before adapter execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnableReviewGatePolicy", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.EnableReviewGatePolicy", "summary": "Gets a value indicating whether slow-loop review gates are evaluated before execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnableTeleodynamicGovernance", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.EnableTeleodynamicGovernance", "summary": "Gets a value indicating whether Teleodynamic governance gates are evaluated before execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FailOnEvidenceLedgerError", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.FailOnEvidenceLedgerError", "summary": "Gets a value indicating whether ledger append errors should fail inference.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxContextTokens", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MaxContextTokens", "summary": "Gets the maximum context tokens accepted by the orchestrator before adapter execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxMemoryCharacters", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MaxMemoryCharacters", "summary": "Gets the maximum memory characters injected into the system context.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxMemoryEntries", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MaxMemoryEntries", "summary": "Gets the maximum number of memory entries injected into a request.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxToolDefinitions", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MaxToolDefinitions", "summary": "Gets the maximum number of tool definitions exposed to a request.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxUncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MaxUncertaintyScore", "summary": "Gets the maximum uncertainty score accepted in the automatic lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryEntryCost", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.MemoryEntryCost", "summary": "Gets the resource weight assigned to each injected memory entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "QuarantineGeneratedNeedsHumanReview", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.QuarantineGeneratedNeedsHumanReview", "summary": "Gets a value indicating whether generated items needing human review are written to the quarantine ledger.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReturnNoOpResponseOnClaimBoundaryViolation", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ReturnNoOpResponseOnClaimBoundaryViolation", "summary": "Gets a value indicating whether claim-boundary violations return a no-op response.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReturnNoOpResponseOnGovernanceDenial", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ReturnNoOpResponseOnGovernanceDenial", "summary": "Gets a value indicating whether budget-denied requests return a no-op response instead of throwing.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReturnNoOpResponseOnReviewGateRequired", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ReturnNoOpResponseOnReviewGateRequired", "summary": "Gets a value indicating whether review-gated requests return a no-op response instead of throwing.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewMinuteCost", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ReviewMinuteCost", "summary": "Gets the resource weight assigned to each declared review minute.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenCostWeight", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.TokenCostWeight", "summary": "Gets the resource weight assigned to each token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolDefinitionCost", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ToolDefinitionCost", "summary": "Gets the resource weight assigned to each exposed tool definition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyCost", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.UncertaintyCost", "summary": "Gets the resource weight assigned to normalized uncertainty.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Contracts.RuntimeOptions.ViabilityFloor", "summary": "Gets the minimum resource reserve below which automatic actions are blocked.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StreamingDelta", "full_name": "UAIX.LmRuntime.Contracts.StreamingDelta", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a normalized streaming inference event.", "remarks": "", "members": [ { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.CreatedUtc", "summary": "Gets the UTC event timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Error", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.Error", "summary": "Gets an error message for error events.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResponseId", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.ResponseId", "summary": "Gets the response identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Text", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.Text", "summary": "Gets the text delta for text events.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolArgumentsDelta", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.ToolArgumentsDelta", "summary": "Gets a tool-call argument delta.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolCallId", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.ToolCallId", "summary": "Gets the tool-call identifier for tool deltas.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Type", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.Type", "summary": "Gets the event type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Usage", "xml_id": "P:UAIX.LmRuntime.Contracts.StreamingDelta.Usage", "summary": "Gets the usage payload when available.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StreamingEventType", "full_name": "UAIX.LmRuntime.Contracts.StreamingEventType", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Identifies the type of a streaming inference event.", "remarks": "", "members": [ { "kind": "field", "name": "Completed", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.Completed", "summary": "The stream completed successfully.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Delta", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.Delta", "summary": "The event contains text delta content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Error", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.Error", "summary": "The stream completed with an error.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Start", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.Start", "summary": "The stream has started.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ToolCallDelta", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.ToolCallDelta", "summary": "The event contains a tool-call delta.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Usage", "xml_id": "F:UAIX.LmRuntime.Contracts.StreamingEventType.Usage", "summary": "The event contains usage information.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TokenCountResult", "full_name": "UAIX.LmRuntime.Contracts.TokenCountResult", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents tokenizer count output.", "remarks": "", "members": [ { "kind": "property", "name": "TokenCount", "xml_id": "P:UAIX.LmRuntime.Contracts.TokenCountResult.TokenCount", "summary": "Gets the token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokenizer", "xml_id": "P:UAIX.LmRuntime.Contracts.TokenCountResult.Tokenizer", "summary": "Gets the tokenizer name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ToolChoice", "full_name": "UAIX.LmRuntime.Contracts.ToolChoice", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Defines runtime guidance for model tool selection.", "remarks": "", "members": [ { "kind": "property", "name": "Automatic", "xml_id": "P:UAIX.LmRuntime.Contracts.ToolChoice.Automatic", "summary": "Gets a value indicating whether tool selection is automatic.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequiredToolName", "xml_id": "P:UAIX.LmRuntime.Contracts.ToolChoice.RequiredToolName", "summary": "Gets a required tool name when a specific tool must be used.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ToolDefinition", "full_name": "UAIX.LmRuntime.Contracts.ToolDefinition", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Defines a callable tool exposed through the canonical inference contract.", "remarks": "", "members": [ { "kind": "property", "name": "Description", "xml_id": "P:UAIX.LmRuntime.Contracts.ToolDefinition.Description", "summary": "Gets the tool description.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "JsonSchema", "xml_id": "P:UAIX.LmRuntime.Contracts.ToolDefinition.JsonSchema", "summary": "Gets the JSON schema document used to validate tool arguments.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Contracts.ToolDefinition.Name", "summary": "Gets the tool name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "UaiFileMemoryOptions", "full_name": "UAIX.LmRuntime.Contracts.UaiFileMemoryOptions", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Defines settings for the.uai file memory store.", "remarks": "", "members": [ { "kind": "property", "name": "IncludeShortTermMemoryFiles", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.IncludeShortTermMemoryFiles", "summary": "Gets a value indicating whether short-term.sui memory files are included when reading memory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryFileName", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.MemoryFileName", "summary": "Gets the memory file name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RootDirectory", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.RootDirectory", "summary": "Gets the root directory for.uai memory files.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ShortTermMemoryDirectoryName", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.ShortTermMemoryDirectoryName", "summary": "Gets the directory name under the.uai root that contains short-term.sui memory files.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ShortTermMemoryFilePattern", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.ShortTermMemoryFilePattern", "summary": "Gets the file search pattern used to discover short-term memory units.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SkipInvalidEntries", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiFileMemoryOptions.SkipInvalidEntries", "summary": "Gets a value indicating whether invalid entries should be skipped instead of throwing.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "UaiMemoryEntry", "full_name": "UAIX.LmRuntime.Contracts.UaiMemoryEntry", "namespace": "UAIX.LmRuntime.Contracts", "summary": "Represents a persisted.uai memory entry.", "remarks": "", "members": [ { "kind": "property", "name": "Content", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.Content", "summary": "Gets the persisted memory content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContentSha256", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.ContentSha256", "summary": "Gets the SHA-256 hash of normalized content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.ConversationId", "summary": "Gets the associated conversation identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.CreatedUtc", "summary": "Gets the UTC creation timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EntryId", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.EntryId", "summary": "Gets the memory entry identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.Contracts.UaiMemoryEntry.Role", "summary": "Gets the memory role.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeTelemetryNames", "full_name": "UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames", "namespace": "UAIX.LmRuntime.Diagnostics", "summary": "Defines stable telemetry names emitted by the runtime core.", "remarks": "", "members": [ { "kind": "field", "name": "BlockedActionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.BlockedActionCounter", "summary": "Teleodynamic blocked action counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "BudgetDecisionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.BudgetDecisionCounter", "summary": "Teleodynamic budget decision counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ClaimBoundaryViolationCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.ClaimBoundaryViolationCounter", "summary": "Claim-boundary violation counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ConstraintDecisionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.ConstraintDecisionCounter", "summary": "Request-side constraint decision counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ConstraintViolationCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.ConstraintViolationCounter", "summary": "Request-side constraint violation counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "EvidenceReceiptCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.EvidenceReceiptCounter", "summary": "Evidence receipt counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "FailureCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.FailureCounter", "summary": "Failure counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MemoryFirewallDecisionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.MemoryFirewallDecisionCounter", "summary": "Memory-firewall decision counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MemoryQuarantineCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.MemoryQuarantineCounter", "summary": "Memory-firewall quarantine counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "QuarantineRecordCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.QuarantineRecordCounter", "summary": "Quarantine record counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequestCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.RequestCounter", "summary": "Request counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequestDurationMs", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.RequestDurationMs", "summary": "Request duration histogram metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewGateDecisionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.ReviewGateDecisionCounter", "summary": "Slow-loop review-gate decision counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "SourceName", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.SourceName", "summary": "The ActivitySource and Meter name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TeleodynamicControlDecisionCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.TeleodynamicControlDecisionCounter", "summary": "Explicit teleodynamic control-cycle decision counter metric name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TeleodynamicNoOpCounter", "xml_id": "F:UAIX.LmRuntime.Diagnostics.RuntimeTelemetryNames.TeleodynamicNoOpCounter", "summary": "Explicit teleodynamic control-cycle no-op counter metric name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "BudgetDecisionStatus", "full_name": "UAIX.LmRuntime.Governance.BudgetDecisionStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the outcome of a runtime budget evaluation.", "remarks": "", "members": [ { "kind": "field", "name": "Approved", "xml_id": "F:UAIX.LmRuntime.Governance.BudgetDecisionStatus.Approved", "summary": "The requested action is affordable under the configured viability budget.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Blocked", "xml_id": "F:UAIX.LmRuntime.Governance.BudgetDecisionStatus.Blocked", "summary": "The requested action is blocked and should not execute automatically.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NoOpSelected", "xml_id": "F:UAIX.LmRuntime.Governance.BudgetDecisionStatus.NoOpSelected", "summary": "No-op was selected as the dominant safe action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.BudgetDecisionStatus.Unknown", "summary": "The decision has not been evaluated.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimBoundaryDecision", "full_name": "UAIX.LmRuntime.Governance.ClaimBoundaryDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents the result of applying claim-boundary rules to text.", "remarks": "", "members": [ { "kind": "property", "name": "Allowed", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.Allowed", "summary": "Gets a value indicating whether the text stayed within claim boundaries.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.CreatedUtc", "summary": "Gets the UTC decision timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.Message", "summary": "Gets a bounded decision message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.NoOpReason", "summary": "Gets the selected no-op reason when the decision blocks output.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SafeReplacementText", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.SafeReplacementText", "summary": "Gets a replacement text that can be emitted in automatic lanes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViolatedRuleIds", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryDecision.ViolatedRuleIds", "summary": "Gets violated rule identifiers.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimBoundaryRule", "full_name": "UAIX.LmRuntime.Governance.ClaimBoundaryRule", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines a bounded claim-boundary rule applied to generated text or runtime claims.", "remarks": "", "members": [ { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryRule.Message", "summary": "Gets the human-readable rule message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryRule.NoOpReason", "summary": "Gets the no-op reason associated with this rule.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Pattern", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryRule.Pattern", "summary": "Gets the case-insensitive text pattern that triggers the rule.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuleId", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryRule.RuleId", "summary": "Gets the stable rule identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Severity", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimBoundaryRule.Severity", "summary": "Gets the rule severity.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimBoundarySeverity", "full_name": "UAIX.LmRuntime.Governance.ClaimBoundarySeverity", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies how strongly a claim-boundary rule should affect runtime behavior.", "remarks": "", "members": [ { "kind": "field", "name": "Advisory", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimBoundarySeverity.Advisory", "summary": "The rule adds advisory context only.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Block", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimBoundarySeverity.Block", "summary": "The rule should block or replace output in automatic lanes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Warning", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimBoundarySeverity.Warning", "summary": "The rule should be logged and surfaced for review.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimLifecycleStatus", "full_name": "UAIX.LmRuntime.Governance.ClaimLifecycleStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the bounded evidence lifecycle assigned to a runtime or release claim.", "remarks": "", "members": [ { "kind": "field", "name": "Bounded", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Bounded", "summary": "The claim is constrained to an explicit domain, digest, environment, and evidence scope.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Promoted", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Promoted", "summary": "The bounded claim has received explicit human approval for its intended publication lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Raw", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Raw", "summary": "The claim has been captured but has not received an evidence review.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Rejected", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Rejected", "summary": "The claim has been rejected and cannot be promoted without a new evidence cycle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Restricted", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Restricted", "summary": "The claim remains usable only under narrower restrictions than originally requested.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Reviewed", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimLifecycleStatus.Reviewed", "summary": "The claim and cited evidence have received an initial review.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimStatus", "full_name": "UAIX.LmRuntime.Governance.ClaimStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the evidence status assigned to a claim, generated artifact, or externally visible output.", "remarks": "", "members": [ { "kind": "field", "name": "ApprovedPublicOutcome", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.ApprovedPublicOutcome", "summary": "The artifact is an approved public outcome with reviewed evidence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "GeneratedNeedsHumanReview", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.GeneratedNeedsHumanReview", "summary": "The artifact was generated or transformed by automation and requires human review before promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MachineReadableEvidence", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.MachineReadableEvidence", "summary": "The artifact is a machine-readable evidence payload intended for agents and due-diligence workflows.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PublicReadyTemplate", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.PublicReadyTemplate", "summary": "The artifact is a buyer-safe methodology template and does not claim a specific client outcome.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Quarantined", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.Quarantined", "summary": "The artifact is quarantined and cannot be promoted automatically.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.ClaimStatus.Unknown", "summary": "No claim status was supplied.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimTransitionDecision", "full_name": "UAIX.LmRuntime.Governance.ClaimTransitionDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports whether a requested claim-lifecycle transition is permitted by evidence and authority rules.", "remarks": "", "members": [ { "kind": "property", "name": "Allowed", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionDecision.Allowed", "summary": "Gets a value indicating whether the requested transition is allowed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimId", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionDecision.ClaimId", "summary": "Gets the stable claim identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EffectiveStatus", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionDecision.EffectiveStatus", "summary": "Gets the status that remains effective after policy evaluation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionDecision.Message", "summary": "Gets the bounded policy explanation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionDecision.NoOpReason", "summary": "Gets the no-op reason when the requested transition is denied.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ClaimTransitionRequest", "full_name": "UAIX.LmRuntime.Governance.ClaimTransitionRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes one requested transition in the explicit claim-evidence lifecycle.", "remarks": "", "members": [ { "kind": "property", "name": "AuditTracePresent", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.AuditTracePresent", "summary": "Gets a value indicating whether an auditable decision trace supports the claim.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BoundaryViolation", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.BoundaryViolation", "summary": "Gets a value indicating whether a claim-boundary violation was identified.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimId", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.ClaimId", "summary": "Gets the stable claim identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CurrentStatus", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.CurrentStatus", "summary": "Gets the currently recorded claim lifecycle status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DomainBounded", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.DomainBounded", "summary": "Gets a value indicating whether the claim has an explicit domain and applicability boundary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HumanApproved", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.HumanApproved", "summary": "Gets a value indicating whether an authorized human reviewer approved the requested promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IndependentEvidenceCount", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.IndependentEvidenceCount", "summary": "Gets the number of independent evidence references attached to the claim.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProximityOnlyEvidence", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.ProximityOnlyEvidence", "summary": "Gets a value indicating whether the transition is justified only by association with a nearby approved claim.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Rationale", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.Rationale", "summary": "Gets the bounded reviewer rationale attached to restrictive or terminal transitions.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequestedStatus", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.RequestedStatus", "summary": "Gets the requested claim lifecycle status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourceTracePresent", "xml_id": "P:UAIX.LmRuntime.Governance.ClaimTransitionRequest.ResourceTracePresent", "summary": "Gets a value indicating whether a candidate-bound resource trace supports the claim.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintClosureReport", "full_name": "UAIX.LmRuntime.Governance.ConstraintClosureReport", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports whether active work and constraint nodes participate in closed maintenance cycles.", "remarks": "", "members": [ { "kind": "property", "name": "Closed", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.Closed", "summary": "Gets a value indicating whether every active work and constraint node participates in a closed cycle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.Diagnostics", "summary": "Gets validation diagnostics for duplicate identifiers, missing endpoints, or invalid values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OpenNodeIds", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.OpenNodeIds", "summary": "Gets active node identifiers that do not participate in a closed directed cycle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RegistryId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.RegistryId", "summary": "Gets the analyzed registry identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RetirementCandidateIds", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.RetirementCandidateIds", "summary": "Gets active nodes marked for bounded retirement because maintenance burden exceeds evidence strength.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StronglyConnectedComponents", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintClosureReport.StronglyConnectedComponents", "summary": "Gets strongly connected components in deterministic node-identifier order.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintDecision", "full_name": "UAIX.LmRuntime.Governance.ConstraintDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents the result of request-side constraint evaluation.", "remarks": "", "members": [ { "kind": "property", "name": "Allowed", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.Allowed", "summary": "Gets a value indicating whether automatic execution may proceed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.CreatedUtc", "summary": "Gets the UTC decision timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.EvidenceReferences", "summary": "Gets evidence references associated with this decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MatchedRuleIds", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.MatchedRuleIds", "summary": "Gets matched rule identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.Message", "summary": "Gets a bounded explanation suitable for logs and receipts.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.NoOpReason", "summary": "Gets the selected no-op reason when automatic execution is blocked.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequiresReview", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.RequiresReview", "summary": "Gets a value indicating whether the resulting artifact requires review before promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SafeReplacementText", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintDecision.SafeReplacementText", "summary": "Gets the safe replacement text when no-op is selected.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintEdge", "full_name": "UAIX.LmRuntime.Governance.ConstraintEdge", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines one directed maintenance or channeling relationship in a work-constraint graph.", "remarks": "", "members": [ { "kind": "property", "name": "Relationship", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintEdge.Relationship", "summary": "Gets the bounded relationship label, such as maintains, channels, depends-on, or verifies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SourceNodeId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintEdge.SourceNodeId", "summary": "Gets the source node identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Strength", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintEdge.Strength", "summary": "Gets the normalized relationship strength in the inclusive range from zero through one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TargetNodeId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintEdge.TargetNodeId", "summary": "Gets the target node identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintNode", "full_name": "UAIX.LmRuntime.Governance.ConstraintNode", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines one bounded node in the work-constraint closure graph.", "remarks": "", "members": [ { "kind": "property", "name": "EvidenceStrength", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.EvidenceStrength", "summary": "Gets the non-negative evidence strength associated with the node.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.Kind", "summary": "Gets the semantic role of the node.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenanceBurden", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.MaintenanceBurden", "summary": "Gets the non-negative recurring maintenance burden attributed to the node.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.Metadata", "summary": "Gets bounded metadata attached to the node.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NodeId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.NodeId", "summary": "Gets the stable node identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Status", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintNode.Status", "summary": "Gets the lifecycle state of the node.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintNodeKind", "full_name": "UAIX.LmRuntime.Governance.ConstraintNodeKind", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the role a node plays in a work-constraint registry.", "remarks": "", "members": [ { "kind": "field", "name": "Constraint", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeKind.Constraint", "summary": "The node represents a constraint that channels or limits work.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Evidence", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeKind.Evidence", "summary": "The node represents evidence that supports a work or constraint decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeKind.Unknown", "summary": "No node role was supplied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Work", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeKind.Work", "summary": "The node represents work that consumes resources and maintains constraints.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintNodeStatus", "full_name": "UAIX.LmRuntime.Governance.ConstraintNodeStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the current lifecycle state of a work-constraint registry node.", "remarks": "", "members": [ { "kind": "field", "name": "Active", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeStatus.Active", "summary": "The node is active and participates in closure analysis.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Frozen", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeStatus.Frozen", "summary": "The node is frozen and remains auditable but cannot be expanded automatically.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Retired", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintNodeStatus.Retired", "summary": "The node is retired and excluded from active closure analysis.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintRegistrySnapshot", "full_name": "UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot", "namespace": "UAIX.LmRuntime.Governance", "summary": "Captures one immutable work-constraint graph supplied to closure analysis.", "remarks": "", "members": [ { "kind": "property", "name": "CapturedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot.CapturedUtc", "summary": "Gets the UTC time at which the registry snapshot was captured.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Edges", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot.Edges", "summary": "Gets the directed graph edges.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Nodes", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot.Nodes", "summary": "Gets the graph nodes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RegistryId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRegistrySnapshot.RegistryId", "summary": "Gets the stable registry identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintRule", "full_name": "UAIX.LmRuntime.Governance.ConstraintRule", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines an evidence-bounded runtime constraint rule.", "remarks": "", "members": [ { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRule.Message", "summary": "Gets the bounded explanation for the decision receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Pattern", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRule.Pattern", "summary": "Gets the case-insensitive substring pattern matched by the default policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuleId", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRule.RuleId", "summary": "Gets the stable rule identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scope", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRule.Scope", "summary": "Gets the inspected request surface.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Severity", "xml_id": "P:UAIX.LmRuntime.Governance.ConstraintRule.Severity", "summary": "Gets the severity applied when the pattern is matched.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintScope", "full_name": "UAIX.LmRuntime.Governance.ConstraintScope", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the request surface inspected by a constraint rule.", "remarks": "", "members": [ { "kind": "field", "name": "All", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintScope.All", "summary": "Inspect all supported request surfaces.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Messages", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintScope.Messages", "summary": "Inspect message content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Metadata", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintScope.Metadata", "summary": "Inspect metadata keys and values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ResponseFormat", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintScope.ResponseFormat", "summary": "Inspect response-format hints and schemas.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Tools", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintScope.Tools", "summary": "Inspect tool names, descriptions, and schemas.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ConstraintSeverity", "full_name": "UAIX.LmRuntime.Governance.ConstraintSeverity", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies how strongly a runtime constraint rule affects automatic execution.", "remarks": "", "members": [ { "kind": "field", "name": "Block", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintSeverity.Block", "summary": "The rule blocks automatic execution and selects no-op.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Information", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintSeverity.Information", "summary": "The rule only records an informational observation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewRequired", "xml_id": "F:UAIX.LmRuntime.Governance.ConstraintSeverity.ReviewRequired", "summary": "The rule permits execution but marks the artifact as needing review before promotion.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "EvidenceReference", "full_name": "UAIX.LmRuntime.Governance.EvidenceReference", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies a source used to justify a governance decision.", "remarks": "", "members": [ { "kind": "property", "name": "Note", "xml_id": "P:UAIX.LmRuntime.Governance.EvidenceReference.Note", "summary": "Gets a bounded note describing why the evidence is relevant.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Path", "xml_id": "P:UAIX.LmRuntime.Governance.EvidenceReference.Path", "summary": "Gets the evidence path or stable identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Sha256", "xml_id": "P:UAIX.LmRuntime.Governance.EvidenceReference.Sha256", "summary": "Gets the SHA-256 hash when the evidence is file-backed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Source", "xml_id": "P:UAIX.LmRuntime.Governance.EvidenceReference.Source", "summary": "Gets the evidence source name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Span", "xml_id": "P:UAIX.LmRuntime.Governance.EvidenceReference.Span", "summary": "Gets the line, byte, or section span when one is present.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GovernanceActionKind", "full_name": "UAIX.LmRuntime.Governance.GovernanceActionKind", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies a Teleodynamic structural operator selected by the runtime control plane.", "remarks": "", "members": [ { "kind": "field", "name": "Add", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Add", "summary": "Add a bounded structure such as a tool, memory edge, adapter, or prompt template.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Freeze", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Freeze", "summary": "Freeze a structure so it remains auditable while automatic expansion and promotion are disabled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Merge", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Merge", "summary": "Merge overlapping structures after evidence shows lower maintenance burden.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NoOp", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.NoOp", "summary": "Select no mutation because evidence, budget, or claim boundaries do not justify action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Reactivate", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Reactivate", "summary": "Reactivate a previously frozen structure after fresh evidence repays its maintenance burden.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Retire", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Retire", "summary": "Retire a structure whose maintenance burden is no longer justified.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Split", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Split", "summary": "Split a structure into narrower lanes when evidence shows ambiguous or overloaded behavior.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.GovernanceActionKind.Unknown", "summary": "No operator was specified.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GovernanceDecisionReceipt", "full_name": "UAIX.LmRuntime.Governance.GovernanceDecisionReceipt", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents an immutable evidence-bearing receipt for a runtime governance decision.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.Action", "summary": "Gets the selected structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BudgetDecision", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.BudgetDecision", "summary": "Gets the budget decision that contributed to the receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimBoundaryDecision", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.ClaimBoundaryDecision", "summary": "Gets the claim-boundary decision that contributed to the receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConstraintDecision", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.ConstraintDecision", "summary": "Gets the request-side constraint decision that contributed to the receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.ConversationId", "summary": "Gets the conversation identifier when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.CreatedUtc", "summary": "Gets the UTC receipt timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.EvidenceReferences", "summary": "Gets evidence references associated with the receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.Metadata", "summary": "Gets bounded metadata for downstream audit and telemetry correlation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.Model", "summary": "Gets the associated model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.NoOpReason", "summary": "Gets the selected no-op reason when applicable.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.PackageVersion", "summary": "Gets the package version that emitted the receipt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "QuarantineRecord", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.QuarantineRecord", "summary": "Gets the quarantine record emitted for the receipt, when one was written.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReceiptId", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.ReceiptId", "summary": "Gets the stable receipt identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewGateDecision", "xml_id": "P:UAIX.LmRuntime.Governance.GovernanceDecisionReceipt.ReviewGateDecision", "summary": "Gets the slow-loop review-gate decision that contributed to the receipt.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryFirewallDecision", "full_name": "UAIX.LmRuntime.Governance.MemoryFirewallDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents the memory-firewall disposition for one packet.", "remarks": "", "members": [ { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.CreatedUtc", "summary": "Gets the UTC time at which the firewall decision was produced.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.Message", "summary": "Gets a bounded explanation of the disposition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PacketId", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.PacketId", "summary": "Gets the packet identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromotionAllowed", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.PromotionAllowed", "summary": "Gets a value indicating whether the requested promotion was approved.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Reason", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.Reason", "summary": "Gets the primary firewall reason.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Status", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.Status", "summary": "Gets the resulting firewall status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TargetTier", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallDecision.TargetTier", "summary": "Gets the target memory tier when promotion is allowed.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryFirewallPolicy", "full_name": "UAIX.LmRuntime.Governance.MemoryFirewallPolicy", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines source, freshness, contradiction, entropy, and review boundaries for memory promotion.", "remarks": "", "members": [ { "kind": "property", "name": "MaximumEntropyScore", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MaximumEntropyScore", "summary": "Gets the maximum entropy accepted in the automatic memory lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumLongTermAge", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MaximumLongTermAge", "summary": "Gets the maximum age of long-term packets before re-review is required.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumMediumTermAge", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MaximumMediumTermAge", "summary": "Gets the maximum age of medium-term packets before retirement.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumShortTermAge", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MaximumShortTermAge", "summary": "Gets the maximum age of short-term packets before retirement.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumLongTermEvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MinimumLongTermEvidenceReferences", "summary": "Gets the minimum evidence count required for durable long-term promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumTrustScore", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.MinimumTrustScore", "summary": "Gets the minimum source trust accepted in the automatic memory lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequireHumanReviewForLongTerm", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.RequireHumanReviewForLongTerm", "summary": "Gets a value indicating whether long-term promotion requires explicit human review.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewContradictions", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallPolicy.ReviewContradictions", "summary": "Gets a value indicating whether contradiction always routes a packet to review.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryFirewallReason", "full_name": "UAIX.LmRuntime.Governance.MemoryFirewallReason", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the primary reason for a memory-firewall disposition.", "remarks": "", "members": [ { "kind": "field", "name": "Contradiction", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.Contradiction", "summary": "The packet conflicts with one or more active memory references.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "CorruptPacket", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.CorruptPacket", "summary": "The packet was explicitly marked corrupt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "DigestMismatch", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.DigestMismatch", "summary": "The observed content digest does not match the packet declaration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "EvidenceRequired", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.EvidenceRequired", "summary": "The requested promotion does not carry sufficient evidence references.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ExcessiveEntropy", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.ExcessiveEntropy", "summary": "The packet entropy or uncertainty exceeds the automatic-lane threshold.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InvalidDigest", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.InvalidDigest", "summary": "A declared or observed content digest is not a valid SHA-256 value.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "LowTrust", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.LowTrust", "summary": "The packet source trust score is below the configured threshold.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MissingSource", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.MissingSource", "summary": "The packet does not identify a bounded source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "None", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.None", "summary": "No firewall restriction was required.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewRequired", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.ReviewRequired", "summary": "The requested tier or disposition requires explicit review.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "StalePacket", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryFirewallReason.StalePacket", "summary": "The packet exceeded its freshness or expiry boundary.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryFirewallRequest", "full_name": "UAIX.LmRuntime.Governance.MemoryFirewallRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes the requested disposition and review proof evaluated by the memory firewall.", "remarks": "", "members": [ { "kind": "property", "name": "HumanReviewed", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallRequest.HumanReviewed", "summary": "Gets a value indicating whether explicit human review was completed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Packet", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallRequest.Packet", "summary": "Gets the packet to evaluate.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequestedStatus", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallRequest.RequestedStatus", "summary": "Gets the requested packet status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewReference", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryFirewallRequest.ReviewReference", "summary": "Gets a bounded review reference when human review was completed.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryPacket", "full_name": "UAIX.LmRuntime.Governance.MemoryPacket", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes a privacy-preserving memory packet using provenance and integrity metadata rather than raw content.", "remarks": "", "members": [ { "kind": "property", "name": "ContradictionReferences", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.ContradictionReferences", "summary": "Gets bounded references to memories or evidence involved in a contradiction.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.CreatedUtc", "summary": "Gets the UTC packet creation time.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DeclaredContentSha256", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.DeclaredContentSha256", "summary": "Gets the content SHA-256 declared by the producer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EntropyScore", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.EntropyScore", "summary": "Gets the normalized entropy or unresolved uncertainty score.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.EvidenceReferences", "summary": "Gets evidence references supporting provenance, trust, or contradiction analysis.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpiresUtc", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.ExpiresUtc", "summary": "Gets the explicit UTC expiry time when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HasContradiction", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.HasContradiction", "summary": "Gets a value indicating whether the packet contradicts active memory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsCorrupt", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.IsCorrupt", "summary": "Gets a value indicating whether an upstream integrity check marked the packet corrupt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.Metadata", "summary": "Gets bounded metadata that excludes raw memory content.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ObservedContentSha256", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.ObservedContentSha256", "summary": "Gets the independently observed content SHA-256 supplied to the firewall.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PacketId", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.PacketId", "summary": "Gets the stable packet identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Source", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.Source", "summary": "Gets the bounded provenance source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tier", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.Tier", "summary": "Gets the requested source-routed memory tier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TrustScore", "xml_id": "P:UAIX.LmRuntime.Governance.MemoryPacket.TrustScore", "summary": "Gets the normalized trust score assigned to the packet source.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryPacketStatus", "full_name": "UAIX.LmRuntime.Governance.MemoryPacketStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the current firewall disposition of a memory packet.", "remarks": "", "members": [ { "kind": "field", "name": "Candidate", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.Candidate", "summary": "The packet has not yet passed a firewall decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Promoted", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.Promoted", "summary": "The packet may be persisted in the approved target tier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Quarantined", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.Quarantined", "summary": "The packet is isolated from active retrieval while evidence or integrity is unresolved.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Rejected", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.Rejected", "summary": "The packet is invalid or unsafe to retain as active memory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Retired", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.Retired", "summary": "The packet is no longer eligible for active retrieval because it expired or was superseded.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewRequired", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryPacketStatus.ReviewRequired", "summary": "The packet is structurally valid but requires an explicit human or policy review.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MemoryTier", "full_name": "UAIX.LmRuntime.Governance.MemoryTier", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies a source-routed memory tier managed by the memory firewall.", "remarks": "", "members": [ { "kind": "field", "name": "LongTerm", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryTier.LongTerm", "summary": "Durable memory that requires provenance, contradiction checks, and governed promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MediumTerm", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryTier.MediumTerm", "summary": "Reviewable working memory retained across a bounded sequence of interactions.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ShortTerm", "xml_id": "F:UAIX.LmRuntime.Governance.MemoryTier.ShortTerm", "summary": "Ephemeral context retained only for the immediate execution window.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "NoOpReason", "full_name": "UAIX.LmRuntime.Governance.NoOpReason", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies why the runtime selected no-op.", "remarks": "", "members": [ { "kind": "field", "name": "ClaimBoundaryViolation", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ClaimBoundaryViolation", "summary": "The request or output crosses a claim boundary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ConstraintViolation", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ConstraintViolation", "summary": "The request crossed a configured runtime constraint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ExcessiveUncertainty", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ExcessiveUncertainty", "summary": "The uncertainty score is too high for an automatic action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "HardLimitExceeded", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.HardLimitExceeded", "summary": "The request exceeds a hard token, memory, or tool-count limit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InsufficientBudget", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.InsufficientBudget", "summary": "The requested work would exceed the available runtime budget.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "IrreversibleAction", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.IrreversibleAction", "summary": "The proposed action lacks a documented rollback path required for automatic execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MaintenanceCycleOpen", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.MaintenanceCycleOpen", "summary": "The work-constraint registry contains active structure outside a closed maintenance cycle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NoFeasibleImprovement", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.NoFeasibleImprovement", "summary": "No feasible proposal produced enough bounded benefit to dominate explicit no-op.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "None", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.None", "summary": "No no-op reason applies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PhaseUnstable", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.PhaseUnstable", "summary": "The current structural phase is unstable and does not permit the requested automatic action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PromotionEvidenceMissing", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.PromotionEvidenceMissing", "summary": "The requested claim promotion lacks candidate-bound evidence required by the lifecycle policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ProximityOnlyEvidence", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ProximityOnlyEvidence", "summary": "The requested claim promotion relies only on proximity to another approved claim.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewRequired", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ReviewRequired", "summary": "The requested work requires human review before promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UnsupportedAction", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.UnsupportedAction", "summary": "The requested operator is not supported in the current lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ViabilityFloor", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.ViabilityFloor", "summary": "The requested work would cross the configured viability floor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "WeakEvidence", "xml_id": "F:UAIX.LmRuntime.Governance.NoOpReason.WeakEvidence", "summary": "The evidence packet is too weak to justify a structural mutation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "QuarantineRecord", "full_name": "UAIX.LmRuntime.Governance.QuarantineRecord", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents an append-only quarantine ledger record for generated or unreviewed runtime artifacts.", "remarks": "", "members": [ { "kind": "property", "name": "ArtifactKind", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.ArtifactKind", "summary": "Gets the artifact kind associated with the quarantine record.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimStatus", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.ClaimStatus", "summary": "Gets the evidence status assigned to the quarantined item.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.ConversationId", "summary": "Gets the conversation identifier when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.CreatedUtc", "summary": "Gets the UTC record timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.EvidenceReferences", "summary": "Gets evidence references associated with the quarantined item.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.Metadata", "summary": "Gets bounded metadata for downstream review tools.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.Model", "summary": "Gets the associated model identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.PackageVersion", "summary": "Gets the package version that emitted the quarantine record.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Reason", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.Reason", "summary": "Gets the reason the item was quarantined or review-gated.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RecordId", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.RecordId", "summary": "Gets the stable quarantine record identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewGateStatus", "xml_id": "P:UAIX.LmRuntime.Governance.QuarantineRecord.ReviewGateStatus", "summary": "Gets the review-gate status that caused the record.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResourceEconomyInput", "full_name": "UAIX.LmRuntime.Governance.ResourceEconomyInput", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes the measured benefits and burdens of one observation or proposed structural action.", "remarks": "", "members": [ { "kind": "property", "name": "ActionCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.ActionCost", "summary": "Gets the estimated one-time cost of validating and applying the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CorrelationId", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.CorrelationId", "summary": "Gets the stable correlation identifier copied into the transition record.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CountAsObservation", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.CountAsObservation", "summary": "Gets a value indicating whether the committed transition represents a fast-loop observation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CountAsStructuralReservation", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.CountAsStructuralReservation", "summary": "Gets a value indicating whether the committed transition represents a structural reservation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnergyCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.EnergyCost", "summary": "Gets the estimated energy or compute cost associated with the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.EvidenceReferences", "summary": "Gets evidence references supporting the gain and cost measurements.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenanceCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.MaintenanceCost", "summary": "Gets the estimated recurring cost of retaining and reviewing the resulting structure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.MemoryCost", "summary": "Gets the estimated memory cost associated with the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PredictiveGain", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.PredictiveGain", "summary": "Gets observed predictive-loss reduction expressed as a non-negative raw gain.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.ReviewCost", "summary": "Gets the estimated human-review cost associated with the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TransitionUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.TransitionUtc", "summary": "Gets the zero-offset UTC timestamp assigned to the transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.UncertaintyCost", "summary": "Gets an explicit uncertainty cost already expressed in resource units.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyInput.UncertaintyScore", "summary": "Gets normalized proposal uncertainty in the inclusive range from zero through one.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResourceEconomyPolicy", "full_name": "UAIX.LmRuntime.Governance.ResourceEconomyPolicy", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines the bounded resource-economy policy used when structural proposals and observations are evaluated.", "remarks": "The policy makes predictive gain, action cost, maintenance burden, compute, memory, review, uncertainty, viability, and capacity explicit so a structural action cannot be justified by accuracy alone.", "members": [ { "kind": "property", "name": "ActionCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.ActionCostWeight", "summary": "Gets the multiplier applied to one-time action cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Capacity", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.Capacity", "summary": "Gets the maximum resource balance retained after a transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DecayRate", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.DecayRate", "summary": "Gets the fraction of the current resource balance removed as natural decay during each observation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnergyCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.EnergyCostWeight", "summary": "Gets the multiplier applied to estimated compute or energy cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "InitialResource", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.InitialResource", "summary": "Gets the resource balance assigned to a newly created stateful economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenanceCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.MaintenanceCostWeight", "summary": "Gets the multiplier applied to recurring maintenance cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.MemoryCostWeight", "summary": "Gets the multiplier applied to memory cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumNetGain", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.MinimumNetGain", "summary": "Gets the minimum positive net resource change required before growth is preferred over no-op.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PredictiveGainWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.PredictiveGainWeight", "summary": "Gets the multiplier applied to measured predictive gain.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.ReviewCostWeight", "summary": "Gets the multiplier applied to human-review cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyReserve", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.UncertaintyReserve", "summary": "Gets the resource reserve charged for a fully uncertain proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyReserveRatio", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.UncertaintyReserveRatio", "summary": "Gets the fraction of the current balance protected in addition to the viability floor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyPolicy.ViabilityFloor", "summary": "Gets the minimum resource balance required for an automatically approved action.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResourceEconomyState", "full_name": "UAIX.LmRuntime.Governance.ResourceEconomyState", "namespace": "UAIX.LmRuntime.Governance", "summary": "Captures the endogenous resource state carried between fast observations and structural-control cycles.", "remarks": "This state is independent from model weights and inference tensors. It records bounded accounting context used by the slow-loop control plane and cannot alter deterministic parity mode without an explicit external actuator.", "members": [ { "kind": "property", "name": "Capacity", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.Capacity", "summary": "Gets the configured capacity used to normalize resource-retention metrics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeActionCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeActionCost", "summary": "Gets the cumulative weighted one-time action cost charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeDecay", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeDecay", "summary": "Gets the cumulative endogenous decay charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeEnergyCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeEnergyCost", "summary": "Gets the cumulative weighted energy or compute cost charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeMaintenanceCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeMaintenanceCost", "summary": "Gets the cumulative weighted maintenance cost charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeMemoryCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeMemoryCost", "summary": "Gets the cumulative weighted memory cost charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativePredictiveGain", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativePredictiveGain", "summary": "Gets the cumulative weighted predictive gain accepted by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeReviewCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeReviewCost", "summary": "Gets the cumulative weighted human-review cost charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CumulativeUncertaintyReserve", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CumulativeUncertaintyReserve", "summary": "Gets the cumulative uncertainty reserve charged by the resource economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CurrentResource", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.CurrentResource", "summary": "Gets the current resource balance available to sustain runtime structure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Cycle", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.Cycle", "summary": "Gets the monotonically increasing committed transition number.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ObservationCount", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.ObservationCount", "summary": "Gets the number of accepted fast-loop observations.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StructuralReservationCount", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.StructuralReservationCount", "summary": "Gets the number of approved structural reservations.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UpdatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.UpdatedUtc", "summary": "Gets the UTC time at which the state was produced.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.ViabilityFloor", "summary": "Gets the configured viability floor used by the current economy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityMargin", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyState.ViabilityMargin", "summary": "Gets current resource minus the configured viability floor.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ResourceEconomyTransition", "full_name": "UAIX.LmRuntime.Governance.ResourceEconomyTransition", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports the deterministic resource transition associated with an observation or structural proposal.", "remarks": "", "members": [ { "kind": "property", "name": "CorrelationId", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.CorrelationId", "summary": "Gets the observation or reservation identifier associated with the transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.CreatedUtc", "summary": "Gets the UTC time at which the transition was produced.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DecayCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.DecayCost", "summary": "Gets the natural decay charged to the transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EffectiveViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.EffectiveViabilityFloor", "summary": "Gets the effective viability boundary after the protected reserve is added to the policy floor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.EvidenceReferences", "summary": "Gets the evidence references supporting the transition inputs.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.Message", "summary": "Gets the bounded diagnostic explaining the transition outcome.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NetChange", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.NetChange", "summary": "Gets the unconstrained net resource change before capacity clamping.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NextState", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.NextState", "summary": "Gets the candidate state after gain, decay, costs, and capacity bounds are applied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.NoOpReason", "summary": "Gets the no-op reason when the transition is not viable or does not repay its burden.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreviousState", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.PreviousState", "summary": "Gets the state supplied before the transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProtectedReserve", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.ProtectedReserve", "summary": "Gets the resource reserve protected in proportion to the previous balance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Viable", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.Viable", "summary": "Gets a value indicating whether the transition remains above the configured viability floor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedActionCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedActionCost", "summary": "Gets the weighted one-time action cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedCost", "summary": "Gets the total weighted action, maintenance, compute, memory, review, and uncertainty cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedEnergyCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedEnergyCost", "summary": "Gets the weighted compute or energy cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedGain", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedGain", "summary": "Gets the weighted gain credited to the transition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedMaintenanceCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedMaintenanceCost", "summary": "Gets the weighted recurring maintenance cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedMemoryCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedMemoryCost", "summary": "Gets the weighted memory cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedReviewCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedReviewCost", "summary": "Gets the weighted human-review cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightedUncertaintyCost", "xml_id": "P:UAIX.LmRuntime.Governance.ResourceEconomyTransition.WeightedUncertaintyCost", "summary": "Gets the uncertainty cost and reserve charged to the transition.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReviewGateDecision", "full_name": "UAIX.LmRuntime.Governance.ReviewGateDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents the result of slow-loop review gate evaluation.", "remarks": "", "members": [ { "kind": "property", "name": "Allowed", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.Allowed", "summary": "Gets a value indicating whether automatic execution may proceed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.CreatedUtc", "summary": "Gets the UTC review-gate timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.EvidenceReferences", "summary": "Gets evidence references used by the review decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.Message", "summary": "Gets the bounded review-gate message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.Metadata", "summary": "Gets bounded metadata for review and audit systems.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.NoOpReason", "summary": "Gets the no-op reason when automatic execution is blocked.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewState", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.ReviewState", "summary": "Gets the review-state label assigned to the work.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Status", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.Status", "summary": "Gets the review-gate status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TriggeredRuleIds", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateDecision.TriggeredRuleIds", "summary": "Gets triggered review rule identifiers.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReviewGateRequest", "full_name": "UAIX.LmRuntime.Governance.ReviewGateRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes runtime work that may require slow-loop review before execution or promotion.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.Action", "summary": "Gets the requested structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.ConversationId", "summary": "Gets the conversation identifier when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.CreatedUtc", "summary": "Gets the UTC timestamp when the review request was created.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedReviewMinutes", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.EstimatedReviewMinutes", "summary": "Gets the estimated review effort in minutes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.EvidenceReferences", "summary": "Gets evidence references used to justify the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.Metadata", "summary": "Gets bounded request metadata used by the policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.Model", "summary": "Gets the model identifier associated with the request.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolDefinitions", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.ToolDefinitions", "summary": "Gets the number of tool definitions exposed to the request.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.ReviewGateRequest.UncertaintyScore", "summary": "Gets the normalized uncertainty score declared by the caller or derived by the orchestrator.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReviewGateStatus", "full_name": "UAIX.LmRuntime.Governance.ReviewGateStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the slow-loop review gate disposition.", "remarks": "", "members": [ { "kind": "field", "name": "Approved", "xml_id": "F:UAIX.LmRuntime.Governance.ReviewGateStatus.Approved", "summary": "The work is already approved for the selected lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Blocked", "xml_id": "F:UAIX.LmRuntime.Governance.ReviewGateStatus.Blocked", "summary": "The work is blocked by review policy and must select no-op.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NotRequired", "xml_id": "F:UAIX.LmRuntime.Governance.ReviewGateStatus.NotRequired", "summary": "No additional review is required for the selected lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ReviewRequired", "xml_id": "F:UAIX.LmRuntime.Governance.ReviewGateStatus.ReviewRequired", "summary": "Human review is required before promotion or mutation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.ReviewGateStatus.Unknown", "summary": "No review decision has been made.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBudget", "full_name": "UAIX.LmRuntime.Governance.RuntimeBudget", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines resource-economy limits used by the runtime budget governor.", "remarks": "", "members": [ { "kind": "property", "name": "AvailableResource", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.AvailableResource", "summary": "Gets the available resource budget for the evaluated action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxInputTokens", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MaxInputTokens", "summary": "Gets the maximum accepted input-token count before a hard limit block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxMemoryEntries", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MaxMemoryEntries", "summary": "Gets the maximum number of injected memory entries accepted before a hard limit block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxOutputTokens", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MaxOutputTokens", "summary": "Gets the maximum accepted output-token count before a hard limit block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxToolDefinitions", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MaxToolDefinitions", "summary": "Gets the maximum number of tool definitions accepted before a hard limit block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxUncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MaxUncertaintyScore", "summary": "Gets the maximum uncertainty score accepted in an automatic lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryEntryCost", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.MemoryEntryCost", "summary": "Gets the resource cost assigned to each injected memory entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewMinuteCost", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.ReviewMinuteCost", "summary": "Gets the resource cost assigned to each declared review minute.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenCostWeight", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.TokenCostWeight", "summary": "Gets the resource cost assigned to each token considered by the request.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolDefinitionCost", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.ToolDefinitionCost", "summary": "Gets the resource cost assigned to each exposed tool definition.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyCost", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.UncertaintyCost", "summary": "Gets the resource cost assigned to uncertainty after normalization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudget.ViabilityFloor", "summary": "Gets the minimum reserve below which automatic structural growth is blocked.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBudgetDecision", "full_name": "UAIX.LmRuntime.Governance.RuntimeBudgetDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents a resource-economy decision for a runtime action.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.Action", "summary": "Gets the selected or requested structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ActionCost", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.ActionCost", "summary": "Gets the computed action cost.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Approved", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.Approved", "summary": "Gets a value indicating whether the action may continue automatically.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AvailableResource", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.AvailableResource", "summary": "Gets the configured available resource value used during evaluation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.CreatedUtc", "summary": "Gets the UTC decision timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.EvidenceReferences", "summary": "Gets evidence references used by the decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.Message", "summary": "Gets a bounded decision message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.NoOpReason", "summary": "Gets the no-op reason when no-op was selected.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Status", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.Status", "summary": "Gets the decision status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityFloor", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetDecision.ViabilityFloor", "summary": "Gets the configured viability floor used during evaluation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBudgetRequest", "full_name": "UAIX.LmRuntime.Governance.RuntimeBudgetRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes a request or structural action being evaluated by the runtime budget governor.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.Action", "summary": "Gets the requested structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.ConversationId", "summary": "Gets the conversation identifier associated with the action when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedReviewMinutes", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.EstimatedReviewMinutes", "summary": "Gets the expected human review burden in minutes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.EvidenceReferences", "summary": "Gets evidence references associated with the decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "InputTokens", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.InputTokens", "summary": "Gets the input-token count after prompt and memory preparation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryEntries", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.MemoryEntries", "summary": "Gets the number of memory entries injected into the prompt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.Model", "summary": "Gets the model identifier associated with the action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputTokens", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.OutputTokens", "summary": "Gets the requested output-token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RetrievalFanOut", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.RetrievalFanOut", "summary": "Gets the retrieval fan-out declared by the caller or retriever.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Source", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.Source", "summary": "Gets a bounded source label for the evaluated action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolDefinitions", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.ToolDefinitions", "summary": "Gets the number of tool definitions exposed to the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.RuntimeBudgetRequest.UncertaintyScore", "summary": "Gets the normalized uncertainty score in the range zero to one.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralChangeDecision", "full_name": "UAIX.LmRuntime.Governance.StructuralChangeDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents the budget, review, and evidence disposition for a proposed structural change.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.Action", "summary": "Gets the selected structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BudgetDecision", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.BudgetDecision", "summary": "Gets the resource-budget decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.CreatedUtc", "summary": "Gets the UTC decision timestamp.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GovernanceReceipt", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.GovernanceReceipt", "summary": "Gets the governance receipt emitted for the decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.Message", "summary": "Gets the bounded decision message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.NoOpReason", "summary": "Gets the no-op reason when no mutation may occur.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "QuarantineRecord", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.QuarantineRecord", "summary": "Gets the quarantine record when the decision is held for review.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewGateDecision", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.ReviewGateDecision", "summary": "Gets the review-gate decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Status", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeDecision.Status", "summary": "Gets the decision status.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralChangeDecisionStatus", "full_name": "UAIX.LmRuntime.Governance.StructuralChangeDecisionStatus", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the disposition of a proposed structural change.", "remarks": "", "members": [ { "kind": "field", "name": "Approved", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralChangeDecisionStatus.Approved", "summary": "The proposal was approved for the caller's mutation lane.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NoOpSelected", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralChangeDecisionStatus.NoOpSelected", "summary": "No mutation is allowed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequiresReview", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralChangeDecisionStatus.RequiresReview", "summary": "The proposal was converted to slow-loop review.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralChangeRequest", "full_name": "UAIX.LmRuntime.Governance.StructuralChangeRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes a slow-loop structural change proposed for runtime configuration, memory, tools, prompts, or backend routing.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.Action", "summary": "Gets the requested structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ChangeId", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.ChangeId", "summary": "Gets the caller-provided change identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimText", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.ClaimText", "summary": "Gets claim text associated with the change, if any.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConversationId", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.ConversationId", "summary": "Gets the conversation affected by the change when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedOutputTokens", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.EstimatedOutputTokens", "summary": "Gets the estimated generated-token cost of validation or rollback evidence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedReviewMinutes", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.EstimatedReviewMinutes", "summary": "Gets the estimated human review minutes required before promotion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EstimatedTokens", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.EstimatedTokens", "summary": "Gets the estimated token cost of validating or applying the change.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.EvidenceReferences", "summary": "Gets evidence references supporting the requested change.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryEntries", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.MemoryEntries", "summary": "Gets the number of memory entries affected by the change.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.Metadata", "summary": "Gets bounded metadata used for receipts and audit correlation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.Model", "summary": "Gets the model affected by the change when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RetrievalFanOut", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.RetrievalFanOut", "summary": "Gets the retrieval fan-out required to validate the change.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TargetKind", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.TargetKind", "summary": "Gets the type of structure being changed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TargetName", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.TargetName", "summary": "Gets the structure name or stable key.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ToolDefinitions", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.ToolDefinitions", "summary": "Gets the number of tool definitions affected by the change.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralChangeRequest.UncertaintyScore", "summary": "Gets the normalized uncertainty score for the change.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralObservationWindow", "full_name": "UAIX.LmRuntime.Governance.StructuralObservationWindow", "namespace": "UAIX.LmRuntime.Governance", "summary": "Captures bounded fast-loop measurements used by the slow-loop structural phase detector.", "remarks": "", "members": [ { "kind": "property", "name": "ActionRate", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.ActionRate", "summary": "Gets the normalized rate of structural actions in the current window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CurrentComplexity", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.CurrentComplexity", "summary": "Gets the current normalized structural complexity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CurrentLoss", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.CurrentLoss", "summary": "Gets the current normalized predictive loss.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DriftScore", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.DriftScore", "summary": "Gets the normalized cross-context or cross-window behavioral drift score.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenancePressure", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.MaintenancePressure", "summary": "Gets the normalized recurring maintenance pressure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreviousComplexity", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.PreviousComplexity", "summary": "Gets the normalized structural complexity from the preceding window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreviousLoss", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.PreviousLoss", "summary": "Gets the normalized predictive loss from the preceding window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewPressure", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.ReviewPressure", "summary": "Gets the normalized human-review pressure associated with recent changes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SampleCount", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.SampleCount", "summary": "Gets the number of observations represented by the window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ViabilityMargin", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralObservationWindow.ViabilityMargin", "summary": "Gets the resource balance minus the configured viability floor.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralPhase", "full_name": "UAIX.LmRuntime.Governance.StructuralPhase", "namespace": "UAIX.LmRuntime.Governance", "summary": "Identifies the bounded structural regime inferred from a recent observation window.", "remarks": "", "members": [ { "kind": "field", "name": "Drifting", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.Drifting", "summary": "Behavior has changed materially across contexts or observation periods.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Growth", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.Growth", "summary": "Loss is improving while bounded structural change remains economically viable.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "OverStructured", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.OverStructured", "summary": "Complexity and maintenance burden are growing without sufficient predictive improvement.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PhaseLocked", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.PhaseLocked", "summary": "Loss, complexity, and action rate are stable within configured tolerances.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ResourceConstrained", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.ResourceConstrained", "summary": "The resource margin is too small to support additional automatic structure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UnderStructured", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.UnderStructured", "summary": "Loss remains high while complexity is low and viable growth remains available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Governance.StructuralPhase.Unknown", "summary": "The observation window is too small or invalid for classification.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralPhaseAssessment", "full_name": "UAIX.LmRuntime.Governance.StructuralPhaseAssessment", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports the structural phase and bounded reasoning derived from an observation window.", "remarks": "", "members": [ { "kind": "property", "name": "ComplexityDelta", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhaseAssessment.ComplexityDelta", "summary": "Gets the current-minus-previous complexity delta.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Confidence", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhaseAssessment.Confidence", "summary": "Gets the normalized confidence in the classification.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LossDelta", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhaseAssessment.LossDelta", "summary": "Gets the current-minus-previous loss delta.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhaseAssessment.Message", "summary": "Gets the bounded explanation for the classification.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Phase", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhaseAssessment.Phase", "summary": "Gets the classified structural phase.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralPhasePolicy", "full_name": "UAIX.LmRuntime.Governance.StructuralPhasePolicy", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines deterministic thresholds for structural phase classification.", "remarks": "", "members": [ { "kind": "property", "name": "ComplexityGrowthThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.ComplexityGrowthThreshold", "summary": "Gets the complexity-growth threshold used to identify over-structured behavior.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DriftThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.DriftThreshold", "summary": "Gets the drift score at or above which the phase is classified as drifting.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GrowthImprovementThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.GrowthImprovementThreshold", "summary": "Gets the minimum loss improvement required to classify a window as bounded growth.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HighLossThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.HighLossThreshold", "summary": "Gets the loss level above which a low-complexity system is considered under-structured.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LowComplexityThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.LowComplexityThreshold", "summary": "Gets the complexity level below which a high-loss system may be considered under-structured.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenancePressureThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.MaintenancePressureThreshold", "summary": "Gets the maintenance-pressure threshold used to identify over-structured behavior.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumSampleCount", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.MinimumSampleCount", "summary": "Gets the minimum number of observations required for classification.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewPressureThreshold", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.ReviewPressureThreshold", "summary": "Gets the review-pressure threshold used to identify over-structured behavior.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StableActionRate", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.StableActionRate", "summary": "Gets the maximum action rate accepted as phase-locked stability.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StableComplexityDelta", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.StableComplexityDelta", "summary": "Gets the maximum absolute complexity change accepted as phase-locked stability.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StableLossDelta", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralPhasePolicy.StableLossDelta", "summary": "Gets the maximum absolute loss change accepted as phase-locked stability.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralProposal", "full_name": "UAIX.LmRuntime.Governance.StructuralProposal", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes one reversible candidate considered by the slow structural-control loop.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.Action", "summary": "Gets the proposed structural operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ActionCost", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.ActionCost", "summary": "Gets the one-time cost of validating and applying the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ComplexityDelta", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.ComplexityDelta", "summary": "Gets the signed structural-complexity change; negative values reduce complexity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnergyCost", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.EnergyCost", "summary": "Gets the estimated energy or compute cost of the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EvidenceReferences", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.EvidenceReferences", "summary": "Gets the evidence references that justify the proposal estimates.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedPredictiveGain", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.ExpectedPredictiveGain", "summary": "Gets the expected predictive-loss reduction produced by the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaintenanceCost", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.MaintenanceCost", "summary": "Gets the recurring cost of retaining the resulting structure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryCost", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.MemoryCost", "summary": "Gets the estimated memory cost of the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.Metadata", "summary": "Gets bounded metadata attached to the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProposalId", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.ProposalId", "summary": "Gets the stable proposal identifier used by evidence and trace records.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequiresHumanReview", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.RequiresHumanReview", "summary": "Gets a value indicating whether the proposal requires explicit human approval before application.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Reversible", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.Reversible", "summary": "Gets a value indicating whether the proposal can be rolled back through a documented inverse action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReviewCost", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.ReviewCost", "summary": "Gets the expected human-review cost of the proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Target", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.Target", "summary": "Gets the stable name of the affected structure.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyScore", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposal.UncertaintyScore", "summary": "Gets the normalized proposal uncertainty in the inclusive range from zero through one.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "StructuralProposalEvaluation", "full_name": "UAIX.LmRuntime.Governance.StructuralProposalEvaluation", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports the viability and local objective for one structural proposal.", "remarks": "", "members": [ { "kind": "property", "name": "Feasible", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.Feasible", "summary": "Gets a value indicating whether all automatic-action gates were satisfied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.Message", "summary": "Gets the bounded diagnostic explaining the evaluation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.NoOpReason", "summary": "Gets the reason the proposal was excluded when it was not feasible.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Objective", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.Objective", "summary": "Gets the local objective, where lower values represent a more favorable bounded action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Proposal", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.Proposal", "summary": "Gets the evaluated proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourceTransition", "xml_id": "P:UAIX.LmRuntime.Governance.StructuralProposalEvaluation.ResourceTransition", "summary": "Gets the resource transition predicted for the proposal.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicControlRequest", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicControlRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Aggregates one opt-in slow-loop evaluation without exposing or mutating model inference state.", "remarks": "", "members": [ { "kind": "property", "name": "ClaimTransition", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.ClaimTransition", "summary": "Gets a claim-lifecycle transition evaluated during the cycle when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConstraintRegistry", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.ConstraintRegistry", "summary": "Gets the work-constraint registry snapshot.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.CreatedUtc", "summary": "Gets the zero-offset UTC time assigned to the control cycle and trace entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CycleId", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.CycleId", "summary": "Gets the stable control-cycle identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DecisionPolicy", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.DecisionPolicy", "summary": "Gets the proposal-scoring and safety policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.Metadata", "summary": "Gets bounded metadata copied into the decision trace.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ObservationWindow", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.ObservationWindow", "summary": "Gets the recent fast-loop observation window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PhasePolicy", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.PhasePolicy", "summary": "Gets the structural-phase threshold policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Proposals", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.Proposals", "summary": "Gets the structural proposals considered during the cycle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourcePolicy", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.ResourcePolicy", "summary": "Gets the resource-economy policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourceState", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlRequest.ResourceState", "summary": "Gets the resource state observed before the cycle.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicControlResult", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicControlResult", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports the complete bounded output of one opt-in teleodynamic control cycle.", "remarks": "", "members": [ { "kind": "property", "name": "ClaimDecision", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlResult.ClaimDecision", "summary": "Gets the claim-lifecycle decision when one is present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConstraintClosure", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlResult.ConstraintClosure", "summary": "Gets the work-constraint closure analysis.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Decision", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlResult.Decision", "summary": "Gets the selected structural proposal or explicit no-op decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PhaseAssessment", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlResult.PhaseAssessment", "summary": "Gets the structural phase inferred from the observation window.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TraceEntry", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicControlResult.TraceEntry", "summary": "Gets the tamper-evident trace entry appended for the cycle.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicDecision", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicDecision", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports the deterministic selection made across structural proposals and the explicit no-op candidate.", "remarks": "", "members": [ { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.CreatedUtc", "summary": "Gets the UTC time at which the decision was produced.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DecisionId", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.DecisionId", "summary": "Gets the stable decision identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Evaluations", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.Evaluations", "summary": "Gets all bounded proposal evaluations in stable proposal-identifier order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.Message", "summary": "Gets the bounded explanation for the selected action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.NoOpReason", "summary": "Gets the reason no-op was selected, or UAIX.LmRuntime.Governance.NoOpReason.None for an actionable proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedAction", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.SelectedAction", "summary": "Gets the selected action, including explicit no-op.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedProposalId", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.SelectedProposalId", "summary": "Gets the selected proposal identifier, or when no-op wins.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedTransition", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecision.SelectedTransition", "summary": "Gets the resource transition associated with the selected proposal or the unchanged no-op state.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicDecisionPolicy", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy", "namespace": "UAIX.LmRuntime.Governance", "summary": "Defines deterministic scoring and safety rules for choosing among structural proposals and no-op.", "remarks": "", "members": [ { "kind": "property", "name": "ComplexityWeight", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.ComplexityWeight", "summary": "Gets the weight applied to absolute structural-complexity growth in the local objective.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DeferHumanReviewProposals", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.DeferHumanReviewProposals", "summary": "Gets a value indicating whether proposals requiring human review are excluded from automatic selection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumProposals", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.MaximumProposals", "summary": "Gets the maximum number of proposals accepted in one bounded evaluation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumUncertainty", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.MaximumUncertainty", "summary": "Gets the maximum uncertainty accepted for an automatically actionable proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumEvidenceCount", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.MinimumEvidenceCount", "summary": "Gets the minimum evidence-reference count required for an automatically actionable proposal.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpAdvantage", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.NoOpAdvantage", "summary": "Gets the non-negative advantage a proposal must have over no-op before it can be selected.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequireReversibleAutomaticAction", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.RequireReversibleAutomaticAction", "summary": "Gets a value indicating whether automatic proposal selection requires a documented rollback path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UncertaintyWeight", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicDecisionPolicy.UncertaintyWeight", "summary": "Gets the weight applied to uncertainty in the local objective.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicTraceEntry", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicTraceEntry", "namespace": "UAIX.LmRuntime.Governance", "summary": "Represents one immutable entry in the SHA-256-linked teleodynamic decision trace.", "remarks": "", "members": [ { "kind": "property", "name": "ContentHash", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceEntry.ContentHash", "summary": "Gets the lowercase SHA-256 digest covering the sequence, previous hash, and canonical request fields.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreviousHash", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceEntry.PreviousHash", "summary": "Gets the preceding entry hash, or 64 zero characters for the first entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Request", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceEntry.Request", "summary": "Gets the canonical event request stored by the entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Sequence", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceEntry.Sequence", "summary": "Gets the one-based sequence number assigned by the trace chain.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TeleodynamicTraceRequest", "full_name": "UAIX.LmRuntime.Governance.TeleodynamicTraceRequest", "namespace": "UAIX.LmRuntime.Governance", "summary": "Describes the canonical fields appended to the tamper-evident teleodynamic decision trace.", "remarks": "", "members": [ { "kind": "property", "name": "Action", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.Action", "summary": "Gets the selected governance action.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CreatedUtc", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.CreatedUtc", "summary": "Gets the UTC event time supplied by the orchestrator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EventId", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.EventId", "summary": "Gets the stable decision or event identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EventKind", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.EventKind", "summary": "Gets the bounded event kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.Metadata", "summary": "Gets bounded metadata serialized in ordinal key order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NoOpReason", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.NoOpReason", "summary": "Gets the no-op reason when no structural action was selected.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourceAfter", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.ResourceAfter", "summary": "Gets the resource balance selected after the event.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResourceBefore", "xml_id": "P:UAIX.LmRuntime.Governance.TeleodynamicTraceRequest.ResourceBefore", "summary": "Gets the resource balance observed before the event.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TraceChainVerificationResult", "full_name": "UAIX.LmRuntime.Governance.TraceChainVerificationResult", "namespace": "UAIX.LmRuntime.Governance", "summary": "Reports whether a teleodynamic trace chain is structurally and cryptographically intact.", "remarks": "", "members": [ { "kind": "property", "name": "FirstInvalidSequence", "xml_id": "P:UAIX.LmRuntime.Governance.TraceChainVerificationResult.FirstInvalidSequence", "summary": "Gets the one-based sequence number of the first invalid entry, or zero when the chain is valid.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Governance.TraceChainVerificationResult.Message", "summary": "Gets the bounded verification diagnostic.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Valid", "xml_id": "P:UAIX.LmRuntime.Governance.TraceChainVerificationResult.Valid", "summary": "Gets a value indicating whether every sequence, predecessor hash, and content hash is valid.", "remarks": "", "parameters": {}, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Tensors", "types": [ { "name": "GgmlTensorType", "full_name": "UAIX.LmRuntime.Tensors.GgmlTensorType", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Identifies GGML tensor storage types as encoded in GGUF tensor descriptors.", "remarks": "", "members": [ { "kind": "field", "name": "BF16", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.BF16", "summary": "16-bit brain floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "F16", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.F16", "summary": "16-bit floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "F32", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.F32", "summary": "32-bit floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "F64", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.F64", "summary": "64-bit floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "I16", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.I16", "summary": "16-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "I32", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.I32", "summary": "32-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "I64", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.I64", "summary": "64-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "I8", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.I8", "summary": "8-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "IQ4_NL", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.IQ4_NL", "summary": "IQ4_NL block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q2_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q2_K", "summary": "Q2_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q3_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q3_K", "summary": "Q3_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_0", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q4_0", "summary": "Q4_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_1", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q4_1", "summary": "Q4_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q4_K", "summary": "Q4_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_0", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q5_0", "summary": "Q5_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_1", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q5_1", "summary": "Q5_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q5_K", "summary": "Q5_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q6_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q6_K", "summary": "Q6_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_0", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q8_0", "summary": "Q8_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_1", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q8_1", "summary": "Q8_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_K", "xml_id": "F:UAIX.LmRuntime.Tensors.GgmlTensorType.Q8_K", "summary": "Q8_K block quantization.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ITensor", "full_name": "UAIX.LmRuntime.Tensors.ITensor", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Defines tensor metadata common to all backend placements.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Tensors.ITensor.DataType", "summary": "Gets the tensor element representation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Shape", "xml_id": "P:UAIX.LmRuntime.Tensors.ITensor.Shape", "summary": "Gets the tensor shape.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q4_1Block", "full_name": "UAIX.LmRuntime.Tensors.Q4_1Block", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Represents a Q4_1 quantized block descriptor.", "remarks": "", "members": [ { "kind": "property", "name": "Minimum", "xml_id": "P:UAIX.LmRuntime.Tensors.Q4_1Block.Minimum", "summary": "Gets the block minimum.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackedValues", "xml_id": "P:UAIX.LmRuntime.Tensors.Q4_1Block.PackedValues", "summary": "Gets the packed values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scale", "xml_id": "P:UAIX.LmRuntime.Tensors.Q4_1Block.Scale", "summary": "Gets the block scale.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q5_0Block", "full_name": "UAIX.LmRuntime.Tensors.Q5_0Block", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Represents a Q5_0 quantized block descriptor.", "remarks": "", "members": [ { "kind": "property", "name": "HighBits", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_0Block.HighBits", "summary": "Gets the high-bit metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackedValues", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_0Block.PackedValues", "summary": "Gets the packed low-bit values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scale", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_0Block.Scale", "summary": "Gets the block scale.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q5_1Block", "full_name": "UAIX.LmRuntime.Tensors.Q5_1Block", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Represents a Q5_1 quantized block descriptor.", "remarks": "", "members": [ { "kind": "property", "name": "HighBits", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_1Block.HighBits", "summary": "Gets the high-bit metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Minimum", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_1Block.Minimum", "summary": "Gets the block minimum.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackedValues", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_1Block.PackedValues", "summary": "Gets the packed low-bit values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scale", "xml_id": "P:UAIX.LmRuntime.Tensors.Q5_1Block.Scale", "summary": "Gets the block scale.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q8_1Block", "full_name": "UAIX.LmRuntime.Tensors.Q8_1Block", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Represents a Q8_1 quantized block descriptor.", "remarks": "", "members": [ { "kind": "property", "name": "Scale", "xml_id": "P:UAIX.LmRuntime.Tensors.Q8_1Block.Scale", "summary": "Gets the block scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Sum", "xml_id": "P:UAIX.LmRuntime.Tensors.Q8_1Block.Sum", "summary": "Gets the block sum metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Values", "xml_id": "P:UAIX.LmRuntime.Tensors.Q8_1Block.Values", "summary": "Gets the quantized values.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "QuantizedBlockTrait", "full_name": "UAIX.LmRuntime.Tensors.QuantizedBlockTrait", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Describes a quantized block layout.", "remarks": "", "members": [ { "kind": "property", "name": "BlockByteCount", "xml_id": "P:UAIX.LmRuntime.Tensors.QuantizedBlockTrait.BlockByteCount", "summary": "Gets the physical bytes in one block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BlockElementCount", "xml_id": "P:UAIX.LmRuntime.Tensors.QuantizedBlockTrait.BlockElementCount", "summary": "Gets the logical elements in one block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgmlType", "xml_id": "P:UAIX.LmRuntime.Tensors.QuantizedBlockTrait.GgmlType", "summary": "Gets the GGML tensor type.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "QuantizedBlockTraits", "full_name": "UAIX.LmRuntime.Tensors.QuantizedBlockTraits", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Provides quantized block trait lookup.", "remarks": "", "members": [ { "kind": "method", "name": "Get(UAIX.LmRuntime.Tensors.GgmlTensorType)", "xml_id": "M:UAIX.LmRuntime.Tensors.QuantizedBlockTraits.Get(UAIX.LmRuntime.Tensors.GgmlTensorType)", "summary": "Gets quantized block layout information for a GGML tensor type.", "remarks": "QuantizedBlockTraits.Get implements this contract: Gets quantized block layout information for a GGML tensor type. It evaluates type before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules." }, "returns": "The QuantizedBlockTrait result produced by QuantizedBlockTraits.Get for this contract: Gets quantized block layout information for a GGML tensor type. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "TensorDataType", "full_name": "UAIX.LmRuntime.Tensors.TensorDataType", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Identifies supported tensor element representations.", "remarks": "", "members": [ { "kind": "field", "name": "BFloat16", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.BFloat16", "summary": "16-bit brain floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Float16", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Float16", "summary": "16-bit IEEE floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Float32", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Float32", "summary": "32-bit IEEE floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int16", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Int16", "summary": "16-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int32", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Int32", "summary": "32-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int64", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Int64", "summary": "64-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int8", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Int8", "summary": "8-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "IQ4_NL", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.IQ4_NL", "summary": "GGML IQ4_NL block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MXFP4", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.MXFP4", "summary": "MXFP4 packed floating-point storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "NVFP4", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.NVFP4", "summary": "NVFP4 packed floating-point storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q2_K", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q2_K", "summary": "GGML Q2_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q3_K", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q3_K", "summary": "GGML Q3_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_0", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q4_0", "summary": "GGML Q4_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_1", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q4_1", "summary": "GGML Q4_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_K", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q4_K", "summary": "GGML Q4_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_0", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q5_0", "summary": "GGML Q5_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_1", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q5_1", "summary": "GGML Q5_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q5_K", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q5_K", "summary": "GGML Q5_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q6_K", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q6_K", "summary": "GGML Q6_K block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_0", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q8_0", "summary": "GGML Q8_0 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_1", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Q8_1", "summary": "GGML Q8_1 block quantization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TQ1_0", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.TQ1_0", "summary": "TQ1_0 ternary quantized storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TQ2_0", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.TQ2_0", "summary": "TQ2_0 ternary quantized storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Tensors.TensorDataType.Unknown", "summary": "Unknown or unsupported tensor representation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorShape", "full_name": "UAIX.LmRuntime.Tensors.TensorShape", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Represents immutable tensor shape metadata.", "remarks": "", "members": [ { "kind": "property", "name": "Dimensions", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorShape.Dimensions", "summary": "Gets the tensor dimensions.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ElementCount", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorShape.ElementCount", "summary": "Gets the number of tensor elements.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "From(long[])", "xml_id": "M:UAIX.LmRuntime.Tensors.TensorShape.From(System.Int64[])", "summary": "Creates the result from the tensor shape after validating the supplied representation.", "remarks": "TensorShape.From implements this contract: Creates the result from the tensor shape after validating the supplied representation. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The TensorShape result produced by TensorShape.From for this contract: Creates the result from the tensor shape after validating the supplied representation. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "TensorTypeTraits", "full_name": "UAIX.LmRuntime.Tensors.TensorTypeTraits", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Describes storage traits for a GGML tensor type.", "remarks": "", "members": [ { "kind": "property", "name": "BlockByteCount", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorTypeTraits.BlockByteCount", "summary": "Gets the number of physical bytes in one storage block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BlockElementCount", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorTypeTraits.BlockElementCount", "summary": "Gets the number of logical elements in one physical storage block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorTypeTraits.DataType", "summary": "Gets the runtime tensor data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgmlType", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorTypeTraits.GgmlType", "summary": "Gets the GGML tensor type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsQuantized", "xml_id": "P:UAIX.LmRuntime.Tensors.TensorTypeTraits.IsQuantized", "summary": "Gets a value indicating whether the type is block-quantized.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorTypeTraitsCatalog", "full_name": "UAIX.LmRuntime.Tensors.TensorTypeTraitsCatalog", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Provides GGML tensor type trait lookup and byte-length validation.", "remarks": "", "members": [ { "kind": "method", "name": "ComputeByteLength(UAIX.LmRuntime.Tensors.GgmlTensorType,ulong)", "xml_id": "M:UAIX.LmRuntime.Tensors.TensorTypeTraitsCatalog.ComputeByteLength(UAIX.LmRuntime.Tensors.GgmlTensorType,System.UInt64)", "summary": "Computes the physical byte length required for a tensor type and element count.", "remarks": "TensorTypeTraitsCatalog.ComputeByteLength implements this contract: Computes the physical byte length required for a tensor type and element count. It evaluates type and elementCount before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules.", "elementCount": "The element count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The ulong value computed by TensorTypeTraitsCatalog.ComputeByteLength for this contract: Computes the physical byte length required for a tensor type and element count. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "Get(UAIX.LmRuntime.Tensors.GgmlTensorType)", "xml_id": "M:UAIX.LmRuntime.Tensors.TensorTypeTraitsCatalog.Get(UAIX.LmRuntime.Tensors.GgmlTensorType)", "summary": "Gets traits for the specified tensor type.", "remarks": "TensorTypeTraitsCatalog.Get implements this contract: Gets traits for the specified tensor type. It evaluates type before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules." }, "returns": "The TensorTypeTraits result produced by TensorTypeTraitsCatalog.Get for this contract: Gets traits for the specified tensor type. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "VectorMath", "full_name": "UAIX.LmRuntime.Tensors.VectorMath", "namespace": "UAIX.LmRuntime.Tensors", "summary": "Provides allocation-free vector math kernels used by tests and CPU fallback paths.", "remarks": "", "members": [ { "kind": "method", "name": "Dot(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Tensors.VectorMath.Dot(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single})", "summary": "Computes the dot product of two equal-length vectors.", "remarks": "VectorMath.Dot implements this contract: Computes the dot product of two equal-length vectors. It evaluates left and right before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "left": "The left sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "right": "The right sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by VectorMath.Dot for this contract: Computes the dot product of two equal-length vectors. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "RmsNorm(System.ReadOnlySpan,System.ReadOnlySpan,System.Span,float)", "xml_id": "M:UAIX.LmRuntime.Tensors.VectorMath.RmsNorm(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Single)", "summary": "Applies RMS normalization using an explicit weight vector.", "remarks": "VectorMath.RmsNorm implements this contract: Applies RMS normalization using an explicit weight vector. It evaluates input, weight, output, and epsilon before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "input": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "weight": "The weight sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "epsilon": "The positive normalization epsilon added to the mean-square term to avoid division by zero while preserving deterministic numerical behavior." }, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Acceleration", "types": [ { "name": "DiagnosticRuntimeBackend", "full_name": "UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Provides shared diagnostic behavior for backend packages that declare compatibility before native execution is proven.", "remarks": "The class keeps package-visible backend declarations DRY. It performs no native loads, subprocess execution, provider calls, network access, or model downloads; concrete packages remain responsible only for naming their compatibility API, runtime identifiers, and package-specific diagnostics.", "members": [ { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend.Capabilities", "summary": "Gets the backend capability declaration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DisplayName", "xml_id": "P:UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend.DisplayName", "summary": "Gets the human-readable backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Id", "xml_id": "P:UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend.Id", "summary": "Gets the stable backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend.Kind", "summary": "Gets the backend kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Acceleration.DiagnosticRuntimeBackend.ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "summary": "Probes a diagnostic backend and reports unavailable until native assets, runtime libraries, and devices are proven.", "remarks": "This default implementation makes compatibility declarations fail closed. A production native adapter may override this member only after it can prove assets, drivers, runtime libraries, and device availability.", "parameters": { "options": "The caller-supplied probing and selection options.", "cancellationToken": "A token that cancels the probe." }, "returns": "The backend probe result." } ] }, { "name": "IRuntimeBackend", "full_name": "UAIX.LmRuntime.Acceleration.IRuntimeBackend", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Defines a local runtime backend that can report capabilities and probe available devices.", "remarks": "Backends are package-visible compatibility surfaces. Implementations must not perform hidden downloads, provider calls, subprocess execution, or remote inference during probing or selection.", "members": [ { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.Acceleration.IRuntimeBackend.Capabilities", "summary": "Gets the backend capability declaration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DisplayName", "xml_id": "P:UAIX.LmRuntime.Acceleration.IRuntimeBackend.DisplayName", "summary": "Gets the human-readable backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Id", "xml_id": "P:UAIX.LmRuntime.Acceleration.IRuntimeBackend.Id", "summary": "Gets the stable backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Acceleration.IRuntimeBackend.Kind", "summary": "Gets the backend kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Acceleration.IRuntimeBackend.ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "summary": "Probes the backend for local execution availability and devices.", "remarks": "Probe diagnostics must clearly distinguish unavailable native assets, missing drivers, missing devices, and policy restrictions.", "parameters": { "options": "The caller-supplied probing and selection options.", "cancellationToken": "A token that cancels the probe." }, "returns": "The backend probe result." } ] }, { "name": "IRuntimeBackendRegistry", "full_name": "UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Defines a registry of runtime backends available to a host application.", "remarks": "The registry is explicit and local. Merely installing a package does not grant hidden runtime authority unless the host registers the backend instance.", "members": [ { "kind": "method", "name": "FindById(string)", "xml_id": "M:UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry.FindById(System.String)", "summary": "Finds a backend by identifier.", "remarks": "", "parameters": { "backendId": "The backend identifier to find." }, "returns": "The matching backend, or when no backend is registered for the ID." }, { "kind": "method", "name": "GetBackends", "xml_id": "M:UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry.GetBackends", "summary": "Gets the currently registered runtime backends.", "remarks": "", "parameters": {}, "returns": "The ordered registered backend list." }, { "kind": "method", "name": "Register(UAIX.LmRuntime.Acceleration.IRuntimeBackend)", "xml_id": "M:UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry.Register(UAIX.LmRuntime.Acceleration.IRuntimeBackend)", "summary": "Registers one runtime backend.", "remarks": "", "parameters": { "backend": "The backend to register." }, "returns": "" } ] }, { "name": "IRuntimeBackendSelector", "full_name": "UAIX.LmRuntime.Acceleration.IRuntimeBackendSelector", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Defines backend selection over a registered set of local runtime backends.", "remarks": "Selection returns explicit backend and device identity so CPU fallback is never confused with GPU execution.", "members": [ { "kind": "method", "name": "SelectAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Acceleration.IRuntimeBackendSelector.SelectAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "summary": "Selects a backend according to the supplied policy and options.", "remarks": "", "parameters": { "options": "The backend selection options.", "cancellationToken": "A token that cancels selection." }, "returns": "The backend selection result." } ] }, { "name": "RuntimeBackendCapabilities", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Reports the execution and compatibility capabilities declared by a runtime backend.", "remarks": "Capabilities are package-visible declarations. Availability is still decided by probing native assets, runtime libraries, drivers, and devices before a backend is selected for execution.", "members": [ { "kind": "property", "name": "BackendApiName", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.BackendApiName", "summary": "Gets or sets the backend API name, such as CUDA, DirectML, Vulkan, ROCm, Metal, or managed CPU.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.Diagnostics", "summary": "Gets diagnostic messages describing compatibility, package state, and probe status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NativeAssetState", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.NativeAssetState", "summary": "Gets or sets the backend-reported native asset state.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeIdentifiers", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.RuntimeIdentifiers", "summary": "Gets runtime identifiers supported or observed by the backend package.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsCpuOnlyExecution", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsCpuOnlyExecution", "summary": "Gets or sets a value indicating whether the backend can execute without GPU hardware.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsDeviceSelection", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsDeviceSelection", "summary": "Gets or sets a value indicating whether callers can select among backend devices.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsGguf", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsGguf", "summary": "Gets or sets a value indicating whether the backend supports GGUF model inputs.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsGpuExecution", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsGpuExecution", "summary": "Gets or sets a value indicating whether the backend can execute on a GPU device.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsLlama", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsLlama", "summary": "Gets or sets a value indicating whether the backend supports LLaMA-family model binding.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsMemoryQuery", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsMemoryQuery", "summary": "Gets or sets a value indicating whether the backend can query device or execution memory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsStreaming", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.SupportsStreaming", "summary": "Gets or sets a value indicating whether the backend supports streaming token output.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesGpuAcceleration", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.UsesGpuAcceleration", "summary": "Gets or sets a value indicating whether the backend uses GPU acceleration when it executes successfully.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesNativeInference", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendCapabilities.UsesNativeInference", "summary": "Gets or sets a value indicating whether the backend uses native inference components.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendKind", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendKind", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Identifies the accelerator API family or execution class represented by a runtime backend.", "remarks": "The value describes the backend package family, not a claim that a device, driver, or native library is available on the current machine.", "members": [ { "kind": "field", "name": "CpuManaged", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.CpuManaged", "summary": "The managed CPU reference backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Cuda", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.Cuda", "summary": "An NVIDIA CUDA backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "DirectML", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.DirectML", "summary": "A Windows DirectML backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ExternalNative", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.ExternalNative", "summary": "A backend supplied by an external native package or host adapter.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Metal", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.Metal", "summary": "An Apple Metal backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Rocm", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.Rocm", "summary": "An AMD ROCm backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.Unknown", "summary": "An unknown or not-yet-classified backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Vulkan", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeBackendKind.Vulkan", "summary": "A Vulkan compute backend.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendOptions", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendOptions", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Provides caller-supplied backend selection and probing options.", "remarks": "These options never authorize hidden downloads, provider fallback, subprocess execution, or remote inference. They only describe how registered local backends should be probed and selected.", "members": [ { "kind": "property", "name": "AllowCpuFallback", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.AllowCpuFallback", "summary": "Gets or sets a value indicating whether prefer policies may fall back to CPU execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NativeAssetDirectory", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.NativeAssetDirectory", "summary": "Gets or sets an optional directory that a backend may inspect for native assets.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Policy", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.Policy", "summary": "Gets or sets the backend selection policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreferredBackendId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.PreferredBackendId", "summary": "Gets or sets the preferred or required backend identifier for backend-id policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreferredDeviceId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.PreferredDeviceId", "summary": "Gets or sets the preferred backend-local device identifier when device selection is supported.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequestedRuntimeIdentifier", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.RequestedRuntimeIdentifier", "summary": "Gets or sets the runtime identifier requested by the caller, when different from the current process.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequireNativeAssets", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendOptions.RequireNativeAssets", "summary": "Gets or sets a value indicating whether a selected backend must have native assets available.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendProbeResult", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Reports the result of probing one registered runtime backend.", "remarks": "A backend may declare capabilities but still probe unavailable when native assets, runtime libraries, drivers, or devices are absent.", "members": [ { "kind": "property", "name": "BackendId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.BackendId", "summary": "Gets or sets the backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BackendKind", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.BackendKind", "summary": "Gets or sets the backend kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.Capabilities", "summary": "Gets or sets the backend capabilities.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Devices", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.Devices", "summary": "Gets discovered devices reported by the backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.Diagnostics", "summary": "Gets probe diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsAvailable", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeBackendProbeResult.IsAvailable", "summary": "Gets or sets a value indicating whether the backend is available for execution.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendRegistry", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendRegistry", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Provides an in-memory explicit registry of local runtime backends.", "remarks": "Registration order is preserved so callers can make deterministic selection decisions.", "members": [ { "kind": "method", "name": "FindById(string)", "xml_id": "M:UAIX.LmRuntime.Acceleration.RuntimeBackendRegistry.FindById(System.String)", "summary": "Finds a backend by identifier.", "remarks": "", "parameters": { "backendId": "The backend identifier to find." }, "returns": "The matching backend, or when no backend is registered for the ID." }, { "kind": "method", "name": "GetBackends", "xml_id": "M:UAIX.LmRuntime.Acceleration.RuntimeBackendRegistry.GetBackends", "summary": "Gets the currently registered runtime backends.", "remarks": "", "parameters": {}, "returns": "The ordered registered backend list." }, { "kind": "method", "name": "Register(UAIX.LmRuntime.Acceleration.IRuntimeBackend)", "xml_id": "M:UAIX.LmRuntime.Acceleration.RuntimeBackendRegistry.Register(UAIX.LmRuntime.Acceleration.IRuntimeBackend)", "summary": "Registers one runtime backend.", "remarks": "", "parameters": { "backend": "The backend to register." }, "returns": "" } ] }, { "name": "RuntimeBackendSelector", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeBackendSelector", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Selects a local runtime backend from an explicit registry.", "remarks": "The selector probes registered backends and reports fallback identity instead of silently substituting one execution class for another.", "members": [ { "kind": "method", "name": "RuntimeBackendSelector(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Acceleration.RuntimeBackendSelector.#ctor(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Initializes a new instance of the UAIX.LmRuntime.Acceleration.RuntimeBackendSelector class.", "remarks": "", "parameters": { "registry": "The backend registry to select from." }, "returns": "" }, { "kind": "method", "name": "SelectAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Acceleration.RuntimeBackendSelector.SelectAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "summary": "Selects a backend according to the supplied policy and options.", "remarks": "", "parameters": { "options": "The backend selection options.", "cancellationToken": "A token that cancels selection." }, "returns": "The backend selection result." } ] }, { "name": "RuntimeDeviceDescriptor", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Describes one CPU or accelerator device discovered by a runtime backend probe.", "remarks": "Device descriptors are diagnostic evidence. They should identify the device that would execute work without exposing private file paths, credentials, prompt text, or generated text.", "members": [ { "kind": "property", "name": "BackendApiName", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.BackendApiName", "summary": "Gets or sets the acceleration API name associated with the device.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BackendId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.BackendId", "summary": "Gets or sets the identifier of the backend that reported the device.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BackendKind", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.BackendKind", "summary": "Gets or sets the backend kind that reported the device.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ComputeCapability", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.ComputeCapability", "summary": "Gets or sets the backend-reported compute capability, feature level, or API version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DeviceId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.DeviceId", "summary": "Gets or sets the stable backend-local device identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.Diagnostics", "summary": "Gets diagnostic messages associated with the device descriptor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DisplayName", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.DisplayName", "summary": "Gets or sets the human-readable device name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsCpu", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.IsCpu", "summary": "Gets or sets a value indicating whether the descriptor represents CPU execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsGpu", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.IsGpu", "summary": "Gets or sets a value indicating whether the descriptor represents GPU execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryBytes", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.MemoryBytes", "summary": "Gets or sets the backend-reported device memory in bytes when known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeIdentifier", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.RuntimeIdentifier", "summary": "Gets or sets the runtime identifier associated with the probed process.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Vendor", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeDeviceDescriptor.Vendor", "summary": "Gets or sets the vendor or implementation owner reported by the backend.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeSelectionPolicy", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Defines how the selector chooses among registered runtime backends.", "remarks": "Policies that prefer a backend may fall back when the options allow it. Policies that require a backend fail clearly when the required capability is unavailable.", "members": [ { "kind": "field", "name": "PreferBackendId", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.PreferBackendId", "summary": "Prefer a specific backend identifier and fall back only when fallback is permitted.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PreferCpu", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.PreferCpu", "summary": "Prefer a CPU-capable backend but allow a different available backend when CPU is absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PreferGpu", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.PreferGpu", "summary": "Prefer an available GPU backend and fall back to CPU only when fallback is permitted.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequireBackendId", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.RequireBackendId", "summary": "Select only a specific backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequireCpu", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.RequireCpu", "summary": "Select only a CPU-capable backend.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "RequireGpu", "xml_id": "F:UAIX.LmRuntime.Acceleration.RuntimeSelectionPolicy.RequireGpu", "summary": "Select only an available GPU backend.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeSelectionResult", "full_name": "UAIX.LmRuntime.Acceleration.RuntimeSelectionResult", "namespace": "UAIX.LmRuntime.Acceleration", "summary": "Reports the selected backend, selected device, and any fallback used by a selection policy.", "remarks": "Selection results make CPU fallback explicit so callers never mistake fallback execution for GPU execution.", "members": [ { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.Diagnostics", "summary": "Gets selection diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FailureReason", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.FailureReason", "summary": "Gets or sets the selection failure reason when selection did not succeed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Policy", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.Policy", "summary": "Gets or sets the policy used for selection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedBackendId", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.SelectedBackendId", "summary": "Gets or sets the selected backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedBackendKind", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.SelectedBackendKind", "summary": "Gets or sets the selected backend kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedCapabilities", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.SelectedCapabilities", "summary": "Gets or sets the selected backend capabilities.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedDevice", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.SelectedDevice", "summary": "Gets or sets the selected device descriptor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Succeeded", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.Succeeded", "summary": "Gets or sets a value indicating whether selection succeeded.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsedCpuFallback", "xml_id": "P:UAIX.LmRuntime.Acceleration.RuntimeSelectionResult.UsedCpuFallback", "summary": "Gets or sets a value indicating whether a GPU-prefer policy fell back to CPU execution.", "remarks": "", "parameters": {}, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Gguf", "types": [ { "name": "Float32TensorReader", "full_name": "UAIX.LmRuntime.Gguf.Float32TensorReader", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Reads float32 values from a validated tensor view with explicit GGUF byte-order handling.", "remarks": "", "members": [ { "kind": "property", "name": "ElementCount", "xml_id": "P:UAIX.LmRuntime.Gguf.Float32TensorReader.ElementCount", "summary": "Gets the logical float32 element count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Gguf.Float32TensorReader.CopyTo(System.Span{System.Single})", "summary": "Decodes every element into a caller-provided destination.", "remarks": "Float32TensorReader.CopyTo implements this contract: Decodes every element into a caller-provided destination. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "destination": "The destination with room for every tensor element." }, "returns": "" }, { "kind": "method", "name": "Float32TensorReader(UAIX.LmRuntime.Gguf.IReadOnlyTensorView)", "xml_id": "M:UAIX.LmRuntime.Gguf.Float32TensorReader.#ctor(UAIX.LmRuntime.Gguf.IReadOnlyTensorView)", "summary": "Initializes a new Float32TensorReader instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the Float32TensorReader instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "ReadElement(int)", "xml_id": "M:UAIX.LmRuntime.Gguf.Float32TensorReader.ReadElement(System.Int32)", "summary": "Reads one element by flat storage index.", "remarks": "Float32TensorReader.ReadElement implements this contract: Reads one element by flat storage index. It evaluates index before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "index": "The zero-based index; it must identify an existing position within the relevant validated range." }, "returns": "The float value computed by Float32TensorReader.ReadElement for this contract: Reads one element by flat storage index. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "ToArray", "xml_id": "M:UAIX.LmRuntime.Gguf.Float32TensorReader.ToArray", "summary": "Creates an explicit bounded managed copy for scalar reference execution.", "remarks": "Float32TensorReader.ToArray implements this contract: Creates an explicit bounded managed copy for scalar reference execution. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "A newly allocated float[] containing the ordered result of Float32TensorReader.ToArray: Creates an explicit bounded managed copy for scalar reference execution. The caller owns the returned array and later mutation cannot alter the source object." } ] }, { "name": "GgufArtifactClassifier", "full_name": "UAIX.LmRuntime.Gguf.GgufArtifactClassifier", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Classifies GGUF artifacts from metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Classify(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufArtifactClassifier.Classify(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Classifies the GGUF artifact kind from validated metadata and tensor-layout evidence.", "remarks": "GgufArtifactClassifier.Classify implements this contract: Classifies the GGUF artifact kind from validated metadata and tensor-layout evidence. It evaluates model before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The GgufArtifactKind result produced by GgufArtifactClassifier.Classify for this contract: Classifies the GGUF artifact kind from validated metadata and tensor-layout evidence. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufArtifactKind", "full_name": "UAIX.LmRuntime.Gguf.GgufArtifactKind", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Identifies the likely role of a GGUF artifact.", "remarks": "", "members": [ { "kind": "field", "name": "BaseModel", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufArtifactKind.BaseModel", "summary": "Base model artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "LoraSidecar", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufArtifactKind.LoraSidecar", "summary": "LoRA sidecar artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MultimodalProjectorSidecar", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufArtifactKind.MultimodalProjectorSidecar", "summary": "Multimodal projector sidecar artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MultiTokenPredictionSidecar", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufArtifactKind.MultiTokenPredictionSidecar", "summary": "Multi-token-prediction sidecar artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "VocabOnly", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufArtifactKind.VocabOnly", "summary": "Vocabulary-only artifact.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufByteOrder", "full_name": "UAIX.LmRuntime.Gguf.GgufByteOrder", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Identifies the byte order used by a GGUF artifact.", "remarks": "", "members": [ { "kind": "field", "name": "Auto", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufByteOrder.Auto", "summary": "Detect the byte order from the version field and reject ambiguous headers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "BigEndian", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufByteOrder.BigEndian", "summary": "Interpret multi-byte values as big-endian.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "LittleEndian", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufByteOrder.LittleEndian", "summary": "Interpret multi-byte values as little-endian.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufDiagnostic", "full_name": "UAIX.LmRuntime.Gguf.GgufDiagnostic", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a structured GGUF parser diagnostic.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufDiagnostic.ByteOffset", "summary": "Gets the byte offset associated with the diagnostic when known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufDiagnostic.Code", "summary": "Gets the stable diagnostic code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufDiagnostic.Message", "summary": "Gets the diagnostic message.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufDumpWriter", "full_name": "UAIX.LmRuntime.Gguf.GgufDumpWriter", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Writes human-readable GGUF metadata and tensor catalog dumps.", "remarks": "", "members": [ { "kind": "method", "name": "Write(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufDumpWriter.Write(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Creates a textual dump for a parsed GGUF model.", "remarks": "GgufDumpWriter.Write implements this contract: Creates a textual dump for a parsed GGUF model. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The text produced by GgufDumpWriter.Write for this contract: Creates a textual dump for a parsed GGUF model. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufFormatException", "full_name": "UAIX.LmRuntime.Gguf.GgufFormatException", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a GGUF format violation with a stable code and byte offset.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufFormatException.ByteOffset", "summary": "Gets the byte offset associated with the violation when known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufFormatException.Code", "summary": "Gets the stable diagnostic code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GgufFormatException(string,string,System.Nullable,System.Exception)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufFormatException.#ctor(System.String,System.String,System.Nullable{System.UInt64},System.Exception)", "summary": "Initializes a new GgufFormatException instance with validated dependencies and operational bounds.", "remarks": "GgufFormatException.GgufFormatException establishes the invariants required by this contract: Initializes a new GgufFormatException instance with validated dependencies and operational bounds. It evaluates code, message, byteOffset, and innerException before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "code": "The stable machine-readable diagnostic code used to classify the failure without relying on localized message text.", "message": "The display-safe diagnostic message describing the failure without embedding prompt text, generated text, credentials, or private file contents.", "byteOffset": "The zero-based byte offset into the relevant source or destination; range validation occurs before access.", "innerException": "The underlying exception preserved for diagnostic chaining, or null when no lower-level failure is available." }, "returns": "" } ] }, { "name": "GgufHashingReader", "full_name": "UAIX.LmRuntime.Gguf.GgufHashingReader", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Computes integrity hashes for GGUF and related model artifacts.", "remarks": "", "members": [ { "kind": "method", "name": "ComputeSha256(string)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufHashingReader.ComputeSha256(System.String)", "summary": "Computes the SHA-256 hash of a file.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Local I/O remains bounded to the source or destination supplied by the caller.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy." }, "returns": "The text produced by GgufHashingReader.ComputeSha256 for this contract: Computes the SHA-256 hash of a file. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufJsonDumpWriter", "full_name": "UAIX.LmRuntime.Gguf.GgufJsonDumpWriter", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Writes machine-readable GGUF dump JSON.", "remarks": "", "members": [ { "kind": "method", "name": "Write(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufJsonDumpWriter.Write(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Writes a stable JSON dump for a parsed GGUF model.", "remarks": "GgufJsonDumpWriter.Write implements this contract: Writes a stable JSON dump for a parsed GGUF model. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The text produced by GgufJsonDumpWriter.Write for this contract: Writes a stable JSON dump for a parsed GGUF model. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufMetadataAccessors", "full_name": "UAIX.LmRuntime.Gguf.GgufMetadataAccessors", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Provides strongly typed accessors for GGUF metadata values.", "remarks": "", "members": [ { "kind": "method", "name": "TryGetBoolean(UAIX.LmRuntime.Gguf.GgufModel,string,bool@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetBoolean(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Boolean@)", "summary": "Tries to read a Boolean metadata value.", "remarks": "GgufMetadataAccessors.TryGetBoolean implements this contract: Tries to read a Boolean metadata value. It evaluates model, key, and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "value": "When the method returns, contains the value produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains a Boolean value." }, { "kind": "method", "name": "TryGetByteArray(UAIX.LmRuntime.Gguf.GgufModel,string,System.Collections.Generic.IReadOnlyList@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetByteArray(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Collections.Generic.IReadOnlyList{System.Byte}@)", "summary": "Tries to read a metadata byte array.", "remarks": "GgufMetadataAccessors.TryGetByteArray implements this contract: Tries to read a metadata byte array. It evaluates model, key, and values before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "values": "When the method returns, contains the values produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains integral elements convertible to bytes." }, { "kind": "method", "name": "TryGetInt32(UAIX.LmRuntime.Gguf.GgufModel,string,int@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetInt32(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Int32@)", "summary": "Tries to read a metadata 32-bit signed integer scalar.", "remarks": "GgufMetadataAccessors.TryGetInt32 implements this contract: Tries to read a metadata 32-bit signed integer scalar. It evaluates model, key, and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "value": "When the method returns, contains the value produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains an integral value convertible to int." }, { "kind": "method", "name": "TryGetInt32Array(UAIX.LmRuntime.Gguf.GgufModel,string,System.Collections.Generic.IReadOnlyList@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetInt32Array(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Collections.Generic.IReadOnlyList{System.Int32}@)", "summary": "Tries to read a metadata 32-bit signed integer array.", "remarks": "GgufMetadataAccessors.TryGetInt32Array implements this contract: Tries to read a metadata 32-bit signed integer array. It evaluates model, key, and values before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "values": "When the method returns, contains the values produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains integral elements convertible to int." }, { "kind": "method", "name": "TryGetSingleArray(UAIX.LmRuntime.Gguf.GgufModel,string,System.Collections.Generic.IReadOnlyList@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetSingleArray(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Collections.Generic.IReadOnlyList{System.Single}@)", "summary": "Tries to read a metadata single-precision floating point array.", "remarks": "GgufMetadataAccessors.TryGetSingleArray implements this contract: Tries to read a metadata single-precision floating point array. It evaluates model, key, and values before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "values": "When the method returns, contains the values produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains numeric elements convertible to float." }, { "kind": "method", "name": "TryGetStringArray(UAIX.LmRuntime.Gguf.GgufModel,string,System.Collections.Generic.IReadOnlyList@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataAccessors.TryGetStringArray(UAIX.LmRuntime.Gguf.GgufModel,System.String,System.Collections.Generic.IReadOnlyList{System.String}@)", "summary": "Tries to read a metadata string array.", "remarks": "GgufMetadataAccessors.TryGetStringArray implements this contract: Tries to read a metadata string array. It evaluates model, key, and values before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "values": "When the method returns, contains the values produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains only string elements." } ] }, { "name": "GgufMetadataArray", "full_name": "UAIX.LmRuntime.Gguf.GgufMetadataArray", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a typed GGUF metadata array.", "remarks": "", "members": [ { "kind": "property", "name": "ElementType", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufMetadataArray.ElementType", "summary": "Gets the element type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Items", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufMetadataArray.Items", "summary": "Gets the array values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ToString", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataArray.ToString", "summary": "Returns a concise description of this array.", "remarks": "GgufMetadataArray.ToString implements this contract: Returns a concise description of this array. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The text produced by GgufMetadataArray.ToString for this contract: Returns a concise description of this array. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufMetadataKeyPolicy", "full_name": "UAIX.LmRuntime.Gguf.GgufMetadataKeyPolicy", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Validates GGUF metadata key syntax.", "remarks": "", "members": [ { "kind": "method", "name": "Validate(string)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataKeyPolicy.Validate(System.String)", "summary": "Validates the supplied key against the invariants required by GgufMetadataKeyPolicy.", "remarks": "Validation is fail closed: the method evaluates the documented format, range, and cross-field invariants before returning a value, does not mutate the validated input, and exposes no partial acceptance state.", "parameters": { "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key." }, "returns": "The GgufValidationError? result produced by GgufMetadataKeyPolicy.Validate for this contract: Validates the supplied key against the invariants required by GgufMetadataKeyPolicy. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufMetadataValue", "full_name": "UAIX.LmRuntime.Gguf.GgufMetadataValue", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a typed GGUF metadata value.", "remarks": "", "members": [ { "kind": "property", "name": "Type", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufMetadataValue.Type", "summary": "Gets the metadata value type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Value", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufMetadataValue.Value", "summary": "Gets the scalar value or a UAIX.LmRuntime.Gguf.GgufMetadataArray for arrays.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Create(UAIX.LmRuntime.Gguf.GgufMetadataValueType,object)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataValue.Create(UAIX.LmRuntime.Gguf.GgufMetadataValueType,System.Object)", "summary": "Creates the GGUF metadata value from the validated inputs required by GgufMetadataValue.", "remarks": "GgufMetadataValue.Create implements this contract: Creates the GGUF metadata value from the validated inputs required by GgufMetadataValue. It evaluates type and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "type": "The type containing validated format or tokenizer metadata required by this operation.", "value": "The value input of type object? read by GgufMetadataValue.Create; it must satisfy the member-specific nullability, identity, range, and ownership rules before dependent work begins." }, "returns": "The metadata value, with ownership and disposal obligations defined by the returned type and the Create contract." }, { "kind": "method", "name": "ToString", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufMetadataValue.ToString", "summary": "Returns the string representation of this value.", "remarks": "GgufMetadataValue.ToString implements this contract: Returns the string representation of this value. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The text produced by GgufMetadataValue.ToString for this contract: Returns the string representation of this value. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufMetadataValueType", "full_name": "UAIX.LmRuntime.Gguf.GgufMetadataValueType", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Identifies GGUF metadata value types.", "remarks": "", "members": [ { "kind": "field", "name": "Array", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Array", "summary": "Typed array.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Bool", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Bool", "summary": "Boolean.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Float32", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Float32", "summary": "32-bit floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Float64", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Float64", "summary": "64-bit floating point.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int16", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Int16", "summary": "16-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int32", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Int32", "summary": "32-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int64", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Int64", "summary": "64-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Int8", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.Int8", "summary": "8-bit signed integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "String", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.String", "summary": "UTF-8 string.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UInt16", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.UInt16", "summary": "16-bit unsigned integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UInt32", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.UInt32", "summary": "32-bit unsigned integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UInt64", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.UInt64", "summary": "64-bit unsigned integer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UInt8", "xml_id": "F:UAIX.LmRuntime.Gguf.GgufMetadataValueType.UInt8", "summary": "8-bit unsigned integer.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufModel", "full_name": "UAIX.LmRuntime.Gguf.GgufModel", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a parsed GGUF artifact catalog and metadata dictionary.", "remarks": "", "members": [ { "kind": "property", "name": "Alignment", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Alignment", "summary": "Gets the tensor-data alignment.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ArtifactKind", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.ArtifactKind", "summary": "Gets the inferred artifact kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ByteOrder", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.ByteOrder", "summary": "Gets the resolved byte order used by the artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FileLength", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.FileLength", "summary": "Gets the source file length captured during parsing.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Metadata", "summary": "Gets the parsed metadata dictionary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Path", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Path", "summary": "Gets the source file path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Shard", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Shard", "summary": "Gets shard metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorDataOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.TensorDataOffset", "summary": "Gets the absolute tensor-data section start offset.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tensors", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Tensors", "summary": "Gets the tensor catalog.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Version", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufModel.Version", "summary": "Gets the GGUF format version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Load(string,UAIX.LmRuntime.Gguf.GgufParseOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufModel.Load(System.String,UAIX.LmRuntime.Gguf.GgufParseOptions)", "summary": "Loads the GGUF model from a verified local source into GgufModel.", "remarks": "GgufModel.Load implements this contract: Loads the GGUF model from a verified local source into GgufModel. It evaluates path and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional GgufParseOptions controlling Load; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The parsed model catalog, with ownership and disposal obligations defined by the returned type and the Load contract." }, { "kind": "method", "name": "TryGetSingle(string,float@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufModel.TryGetSingle(System.String,System.Single@)", "summary": "Tries to get a single-precision metadata value.", "remarks": "GgufModel.TryGetSingle implements this contract: Tries to get a single-precision metadata value. It evaluates key and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "value": "When the method returns, contains the value produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and can be converted to a single-precision value." }, { "kind": "method", "name": "TryGetString(string,string@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufModel.TryGetString(System.String,System.String@)", "summary": "Tries to get a string metadata value.", "remarks": "GgufModel.TryGetString implements this contract: Tries to get a string metadata value. It evaluates key and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "value": "When the method returns, contains the value produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and contains a string." }, { "kind": "method", "name": "TryGetTensor(string,UAIX.LmRuntime.Gguf.GgufTensorDescriptor@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufModel.TryGetTensor(System.String,UAIX.LmRuntime.Gguf.GgufTensorDescriptor@)", "summary": "Tries to resolve a tensor descriptor by its exact GGUF name.", "remarks": "GgufModel.TryGetTensor implements this contract: Tries to resolve a tensor descriptor by its exact GGUF name. It evaluates name and tensor before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "name": "The exact ordinal name used for catalog lookup, canonical hashing, or diagnostic labeling as defined by the containing member.", "tensor": "When the method returns, contains the tensor produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when try get tensor succeeds for the supplied values; otherwise, false." }, { "kind": "method", "name": "TryGetUInt32(string,uint@)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufModel.TryGetUInt32(System.String,System.UInt32@)", "summary": "Tries to get an unsigned 32-bit metadata value.", "remarks": "GgufModel.TryGetUInt32 implements this contract: Tries to get an unsigned 32-bit metadata value. It evaluates key and value before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "key": "The exact ordinal metadata or catalog key used for lookup; the operation does not normalize or retain a mutable alias of the key.", "value": "When the method returns, contains the value produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the key exists and can be converted to an unsigned 32-bit integer." } ] }, { "name": "GgufParseOptions", "full_name": "UAIX.LmRuntime.Gguf.GgufParseOptions", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Defines safety limits for GGUF parsing.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOrder", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.ByteOrder", "summary": "Gets the requested GGUF byte order. Auto uses the version-field heuristic.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxArrayDepth", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxArrayDepth", "summary": "Gets the maximum recursive array depth.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxArrayLength", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxArrayLength", "summary": "Gets the maximum metadata array length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxDimensionCount", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxDimensionCount", "summary": "Gets the maximum supported dimension count per tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxMetadataCount", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxMetadataCount", "summary": "Gets the maximum supported metadata key-value count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxStringBytes", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxStringBytes", "summary": "Gets the maximum metadata string byte length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaxTensorCount", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseOptions.MaxTensorCount", "summary": "Gets the maximum supported tensor count.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufParseResult", "full_name": "UAIX.LmRuntime.Gguf.GgufParseResult", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a non-throwing GGUF parse result.", "remarks": "", "members": [ { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseResult.Diagnostics", "summary": "Gets parser diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseResult.Model", "summary": "Gets the parsed model when parsing succeeded.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Succeeded", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufParseResult.Succeeded", "summary": "Gets a value indicating whether parsing succeeded without diagnostics.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufReader", "full_name": "UAIX.LmRuntime.Gguf.GgufReader", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Reads and validates GGUF model artifacts.", "remarks": "", "members": [ { "kind": "method", "name": "Read(string,UAIX.LmRuntime.Gguf.GgufParseOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufReader.Read(System.String,UAIX.LmRuntime.Gguf.GgufParseOptions)", "summary": "Reads a GGUF artifact from disk without copying tensor payloads to managed memory.", "remarks": "The method advances the local source only as bytes are successfully consumed and reports truncated or malformed data instead of returning a partial value. The returned value is produced only after the method's complete processing path succeeds.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional GgufParseOptions controlling Read; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The GgufModel result produced by GgufReader.Read for this contract: Reads a GGUF artifact from disk without copying tensor payloads to managed memory. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "TryRead(string,UAIX.LmRuntime.Gguf.GgufParseOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufReader.TryRead(System.String,UAIX.LmRuntime.Gguf.GgufParseOptions)", "summary": "Parses a GGUF artifact and returns structured diagnostics instead of throwing for format failures.", "remarks": "GgufReader.TryRead implements this contract: Parses a GGUF artifact and returns structured diagnostics instead of throwing for format failures. It evaluates path and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional GgufParseOptions controlling TryRead; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "True when the GGUF parse result is produced successfully; otherwise, false and no successful result is published." } ] }, { "name": "GgufShardInfo", "full_name": "UAIX.LmRuntime.Gguf.GgufShardInfo", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Describes sharding metadata found in a GGUF artifact.", "remarks": "", "members": [ { "kind": "property", "name": "IsSharded", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufShardInfo.IsSharded", "summary": "Gets a value indicating whether sharding metadata was found.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ShardCount", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufShardInfo.ShardCount", "summary": "Gets the shard count when present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ShardIndex", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufShardInfo.ShardIndex", "summary": "Gets the shard index when present.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufShardResolver", "full_name": "UAIX.LmRuntime.Gguf.GgufShardResolver", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Resolves GGUF shard files adjacent to a root artifact.", "remarks": "", "members": [ { "kind": "method", "name": "ResolveShards(string)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufShardResolver.ResolveShards(System.String)", "summary": "Resolves likely shard paths for a GGUF model path.", "remarks": "GgufShardResolver.ResolveShards implements this contract: Resolves likely shard paths for a GGUF model path. It evaluates path before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy." }, "returns": "An ordered read-only IReadOnlyList result from GgufShardResolver.ResolveShards: Resolves likely shard paths for a GGUF model path. Mutable internal collection aliases are not exposed through the returned contract." } ] }, { "name": "GgufStrictValidator", "full_name": "UAIX.LmRuntime.Gguf.GgufStrictValidator", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Validates GGUF artifacts without claiming execution parity.", "remarks": "", "members": [ { "kind": "method", "name": "Validate(string,UAIX.LmRuntime.Gguf.GgufParseOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufStrictValidator.Validate(System.String,UAIX.LmRuntime.Gguf.GgufParseOptions)", "summary": "Validates the supplied path and the supplied options against the invariants required by GgufStrictValidator.", "remarks": "GgufStrictValidator.Validate implements this contract: Validates the supplied path and the supplied options against the invariants required by GgufStrictValidator. It evaluates path and options before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional GgufParseOptions controlling Validate; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The GgufValidationReport result produced by GgufStrictValidator.Validate for this contract: Validates the supplied path and the supplied options against the invariants required by GgufStrictValidator. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufTensorDescriptor", "full_name": "UAIX.LmRuntime.Gguf.GgufTensorDescriptor", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Describes a tensor stored in a GGUF artifact without copying its payload.", "remarks": "", "members": [ { "kind": "property", "name": "AbsoluteOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.AbsoluteOffset", "summary": "Gets the absolute file offset for this tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ByteLength", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.ByteLength", "summary": "Gets the physical tensor byte length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Dimensions", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.Dimensions", "summary": "Gets tensor dimensions in GGUF order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ElementCount", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.ElementCount", "summary": "Gets the logical element count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgmlType", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.GgmlType", "summary": "Gets the GGML storage type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.Name", "summary": "Gets the tensor name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RelativeOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorDescriptor.RelativeOffset", "summary": "Gets the relative tensor offset from the tensor data section.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufTensorPayloadView", "full_name": "UAIX.LmRuntime.Gguf.GgufTensorPayloadView", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a zero-copy tensor payload range inside a GGUF file.", "remarks": "", "members": [ { "kind": "property", "name": "AbsoluteOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorPayloadView.AbsoluteOffset", "summary": "Gets the absolute file offset.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LengthBytes", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufTensorPayloadView.LengthBytes", "summary": "Gets the payload byte length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "FromTensor(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "xml_id": "M:UAIX.LmRuntime.Gguf.GgufTensorPayloadView.FromTensor(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "summary": "Creates a payload view from a tensor descriptor.", "remarks": "GgufTensorPayloadView.FromTensor implements this contract: Creates a payload view from a tensor descriptor. It evaluates tensor before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tensor": "The validated GGUF tensor descriptor whose dimensions, offsets, storage type, and byte length drive the operation." }, "returns": "The GgufTensorPayloadView result produced by GgufTensorPayloadView.FromTensor for this contract: Creates a payload view from a tensor descriptor. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufValidationError", "full_name": "UAIX.LmRuntime.Gguf.GgufValidationError", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents a GGUF validation error.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOffset", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationError.ByteOffset", "summary": "Gets the byte offset associated with the error, if known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationError.Code", "summary": "Gets the diagnostic code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationError.Message", "summary": "Gets the diagnostic message.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufValidationReport", "full_name": "UAIX.LmRuntime.Gguf.GgufValidationReport", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Represents the result of strict GGUF validation.", "remarks": "", "members": [ { "kind": "property", "name": "Errors", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationReport.Errors", "summary": "Gets validation errors with byte offsets when known.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsValid", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationReport.IsValid", "summary": "Gets a value indicating whether validation succeeded.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Gguf.GgufValidationReport.Model", "summary": "Gets the parsed model when validation succeeded.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "IMappedModelFile", "full_name": "UAIX.LmRuntime.Gguf.IMappedModelFile", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Defines bounded, zero-copy access to tensor payloads in a mapped model artifact.", "remarks": "", "members": [ { "kind": "property", "name": "FileLength", "xml_id": "P:UAIX.LmRuntime.Gguf.IMappedModelFile.FileLength", "summary": "Gets the mapped file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Gguf.IMappedModelFile.Model", "summary": "Gets the parsed GGUF model catalog associated with the mapping.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetMemorySegments(ulong,ulong,int)", "xml_id": "M:UAIX.LmRuntime.Gguf.IMappedModelFile.GetMemorySegments(System.UInt64,System.UInt64,System.Int32)", "summary": "Creates bounded read-only memory windows for a validated mapped-file range.", "remarks": "Implementations of IMappedModelFile validate the supplied absolute offset, the supplied byte length, and the supplied maximum segment byte count before completing GetMemorySegments and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "absoluteOffset": "The zero-based absolute offset into the relevant source or destination; range validation occurs before access.", "byteLength": "The bounded payload length in bytes used to validate offsets and prevent arithmetic overflow before slicing mapped storage.", "maximumSegmentByteCount": "The positive maximum byte count per returned segment." }, "returns": "Ordered borrowed segments whose combined length equals byteLength." }, { "kind": "method", "name": "GetTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "xml_id": "M:UAIX.LmRuntime.Gguf.IMappedModelFile.GetTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "summary": "Gets a synchronous read-only span over one tensor payload.", "remarks": "Implementations of IMappedModelFile validate the supplied tensor before completing GetTensorBytes and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tensor": "The validated GGUF tensor descriptor whose dimensions, offsets, storage type, and byte length drive the operation." }, "returns": "A read-only span valid until this mapping is disposed." }, { "kind": "method", "name": "GetTensorMemory(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "xml_id": "M:UAIX.LmRuntime.Gguf.IMappedModelFile.GetTensorMemory(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "summary": "Gets a read-only memory view over one tensor payload.", "remarks": "Implementations of IMappedModelFile validate the supplied tensor before completing GetTensorMemory and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tensor": "The validated GGUF tensor descriptor whose dimensions, offsets, storage type, and byte length drive the operation." }, "returns": "A read-only memory view whose owner remains the mapped file." }, { "kind": "method", "name": "TryGetTensorMemory(string,System.ReadOnlyMemory@)", "xml_id": "M:UAIX.LmRuntime.Gguf.IMappedModelFile.TryGetTensorMemory(System.String,System.ReadOnlyMemory{System.Byte}@)", "summary": "Attempts to get a read-only memory view by tensor name.", "remarks": "Implementations of IMappedModelFile validate the supplied tensor name and the supplied memory before completing TryGetTensorMemory and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tensorName": "The exact ordinal GGUF tensor catalog name used for lookup and diagnostics.", "memory": "When the method returns, contains the memory produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when try get tensor memory succeeds for the supplied values; otherwise, false." } ] }, { "name": "IReadOnlyTensorView", "full_name": "UAIX.LmRuntime.Gguf.IReadOnlyTensorView", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Defines a read-only tensor view backed by validated model storage.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOrder", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.ByteOrder", "summary": "Gets the GGUF byte order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.DataType", "summary": "Gets the runtime data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Descriptor", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.Descriptor", "summary": "Gets the authoritative GGUF tensor descriptor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.IsDisposed", "summary": "Gets whether the backing owner has been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LogicalDimensions", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.LogicalDimensions", "summary": "Gets normalized logical row-major dimensions.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDimensions", "xml_id": "P:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.StorageDimensions", "summary": "Gets dimensions in GGUF storage order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetMemory", "xml_id": "M:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.GetMemory", "summary": "Gets a borrowed read-only memory view over the tensor payload.", "remarks": "Implementations of IReadOnlyTensorView validate the instance's existing state before completing GetMemory and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": {}, "returns": "The memory region containing the memory, bounded to the validated range owned by the result." }, { "kind": "method", "name": "GetSpan", "xml_id": "M:UAIX.LmRuntime.Gguf.IReadOnlyTensorView.GetSpan", "summary": "Gets a synchronous borrowed span over the tensor payload.", "remarks": "Implementations of IReadOnlyTensorView validate the instance's existing state before completing GetSpan and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": {}, "returns": "The bounded ReadOnlySpan view produced by IReadOnlyTensorView.GetSpan: Gets a synchronous borrowed span over the tensor payload. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." } ] }, { "name": "MappedGgufFile", "full_name": "UAIX.LmRuntime.Gguf.MappedGgufFile", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Owns a read-only operating-system mapping of a GGUF artifact and exposes bounded tensor payload views.", "remarks": "The mapping is the sole owner of the acquired unmanaged pointer. Returned spans and memory views borrow that pointer and become invalid immediately after UAIX.LmRuntime.Gguf.MappedGgufFile.Dispose. Public entry points verify that descriptors belong to the parsed catalog before pointer arithmetic occurs.", "members": [ { "kind": "property", "name": "FileLength", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedGgufFile.FileLength", "summary": "Gets the mapped file length captured from the validated catalog.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedGgufFile.IsDisposed", "summary": "Gets a value indicating whether the mapping has been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Model", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedGgufFile.Model", "summary": "Gets the immutable GGUF catalog that was validated before the operating-system mapping was opened.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyBytes(ulong,System.Span)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.CopyBytes(System.UInt64,System.Span{System.Byte})", "summary": "Copies a validated mapped-file range into a caller-owned destination.", "remarks": "This is the bounded large-file alternative to a single ReadOnlySpan{T} or ReadOnlyMemory{T} view. Callers can iterate with fixed-size destinations while retaining UInt64 file offsets and without exposing a pointer beyond the mapping lifetime.", "parameters": { "absoluteOffset": "The zero-based absolute offset into the relevant source or destination; range validation occurs before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "CopyTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Span)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.CopyTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Span{System.Byte})", "summary": "Copies a complete tensor payload into a caller-owned destination.", "remarks": "MappedGgufFile.CopyTensorBytes implements this contract: Copies a complete tensor payload into a caller-owned destination. It evaluates tensor and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "tensor": "The validated GGUF tensor descriptor whose dimensions, offsets, storage type, and byte length drive the operation.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "CreateTensorView(UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Collections.Generic.IReadOnlyList)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.CreateTensorView(UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Collections.Generic.IReadOnlyList{System.UInt64})", "summary": "Creates a read-only typed tensor view whose lifetime is owned by this mapping.", "remarks": "MappedGgufFile.CreateTensorView implements this contract: Creates a read-only typed tensor view whose lifetime is owned by this mapping. It evaluates tensor and logicalDimensions before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tensor": "The validated GGUF tensor descriptor whose dimensions, offsets, storage type, and byte length drive the operation.", "logicalDimensions": "Optional logical row-major dimensions; storage dimensions are used when omitted." }, "returns": "The borrowed mapped tensor view, with ownership and disposal obligations defined by the returned type and the CreateTensorView contract." }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.Dispose", "summary": "Releases the acquired view pointer, operating-system mapping handles, and source file handle.", "remarks": "Disposal is idempotent. All previously returned spans, memory objects, and tensor views are borrowed and must not be accessed after this method returns.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetBytes(ulong,ulong)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.GetBytes(System.UInt64,System.UInt64)", "summary": "Gets a read-only span over a validated file range.", "remarks": "MappedGgufFile.GetBytes implements this contract: Gets a read-only span over a validated file range. It evaluates absoluteOffset and byteLength before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "absoluteOffset": "The zero-based absolute offset into the relevant source or destination; range validation occurs before access.", "byteLength": "The bounded payload length in bytes used to validate offsets and prevent arithmetic overflow before slicing mapped storage." }, "returns": "The bounded ReadOnlySpan view produced by MappedGgufFile.GetBytes: Gets a read-only span over a validated file range. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "GetMemorySegments(ulong,ulong,int)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.GetMemorySegments(System.UInt64,System.UInt64,System.Int32)", "summary": "Splits a validated mapped-file range into bounded borrowed memory segments.", "remarks": "Segmenting limits the size of each ReadOnlyMemory{T} instance; it does not copy bytes and it does not extend the mapping lifetime. Every segment remains invalid after Dispose.", "parameters": { "absoluteOffset": "The absolute file offset at which the first segment begins.", "byteLength": "The total number of bytes represented by all returned segments.", "maximumSegmentByteCount": "The positive upper bound for each managed segment descriptor." }, "returns": "Ordered borrowed memory segments that exactly cover the requested range." }, { "kind": "method", "name": "GetTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.GetTensorBytes(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "summary": "Gets a synchronous borrowed span over one catalog tensor payload.", "remarks": "MappedGgufFile.GetTensorBytes implements this contract: Gets a synchronous borrowed span over one catalog tensor payload. It evaluates tensor before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "tensor": "The descriptor that must match the mapping's authoritative tensor catalog." }, "returns": "A read-only span whose lifetime cannot exceed the current synchronous call chain." }, { "kind": "method", "name": "GetTensorMemory(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.GetTensorMemory(UAIX.LmRuntime.Gguf.GgufTensorDescriptor)", "summary": "Gets a borrowed memory object over one catalog tensor payload.", "remarks": "The returned memory does not own the mapped pointer. Accessing its span after this mapping is disposed throws ObjectDisposedException through the owner-backed memory manager.", "parameters": { "tensor": "The descriptor that must match the mapping's authoritative tensor catalog." }, "returns": "A read-only memory view backed directly by the operating-system mapping." }, { "kind": "method", "name": "MappedGgufFile(string,UAIX.LmRuntime.Gguf.GgufParseOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.#ctor(System.String,UAIX.LmRuntime.Gguf.GgufParseOptions)", "summary": "Opens, validates, and maps a GGUF file read-only.", "remarks": "MappedGgufFile.MappedGgufFile establishes the invariants required by this contract: Opens, validates, and maps a GGUF file read-only. It evaluates path and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional GgufParseOptions controlling MappedGgufFile; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "" }, { "kind": "method", "name": "MappedGgufFile(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.#ctor(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Maps a GGUF file using an already validated catalog.", "remarks": "Construction opens a read-only file handle, rechecks the live length captured by the parsed catalog, and creates an operating-system mapping from that locked handle before acquiring or publishing a pointer. The mapped view may have a platform-rounded capacity, so the invariant is that it covers the validated file length exactly used by all public range checks. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce lifecycle and range checks against the same validated length.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "" }, { "kind": "method", "name": "TryGetTensorMemory(string,System.ReadOnlyMemory@)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedGgufFile.TryGetTensorMemory(System.String,System.ReadOnlyMemory{System.Byte}@)", "summary": "Tries to resolve a named tensor and create a borrowed mapped-memory view.", "remarks": "MappedGgufFile.TryGetTensorMemory implements this contract: Tries to resolve a named tensor and create a borrowed mapped-memory view. It evaluates tensorName and memory before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "tensorName": "The exact ordinal GGUF tensor catalog name used for lookup and diagnostics.", "memory": "Receives the borrowed tensor memory when the tensor exists; otherwise receives empty memory." }, "returns": "True when the tensor exists and a view was created; otherwise false." } ] }, { "name": "MappedTensorView", "full_name": "UAIX.LmRuntime.Gguf.MappedTensorView", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Carries validated tensor geometry and a borrowed read-only view into a mapped GGUF file.", "remarks": "", "members": [ { "kind": "property", "name": "ByteOrder", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.ByteOrder", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Descriptor", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.Descriptor", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.IsDisposed", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LogicalDimensions", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.LogicalDimensions", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDimensions", "xml_id": "P:UAIX.LmRuntime.Gguf.MappedTensorView.StorageDimensions", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetMemory", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedTensorView.GetMemory", "summary": "Retrieves the memory from the current MappedTensorView state after validating the requested access.", "remarks": "MappedTensorView.GetMemory implements this contract: Retrieves the memory from the current MappedTensorView state after validating the requested access. It evaluates its explicitly owned state before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": {}, "returns": "The memory region containing the memory, bounded to the validated range owned by the result." }, { "kind": "method", "name": "GetSpan", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedTensorView.GetSpan", "summary": "Retrieves the span from the current MappedTensorView state after validating the requested access.", "remarks": "MappedTensorView.GetSpan implements this contract: Retrieves the span from the current MappedTensorView state after validating the requested access. It evaluates its explicitly owned state before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": {}, "returns": "The bounded ReadOnlySpan view produced by MappedTensorView.GetSpan: Retrieves the span from the current MappedTensorView state after validating the requested access. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "MappedTensorView(UAIX.LmRuntime.Gguf.MappedGgufFile,UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Collections.Generic.IReadOnlyList)", "xml_id": "M:UAIX.LmRuntime.Gguf.MappedTensorView.#ctor(UAIX.LmRuntime.Gguf.MappedGgufFile,UAIX.LmRuntime.Gguf.GgufTensorDescriptor,System.Collections.Generic.IReadOnlyList{System.UInt64})", "summary": "Initializes a new MappedTensorView instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied owner, the supplied descriptor, and the supplied logical dimensions before the MappedTensorView instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "owner": "The mapped model-file owner that keeps the tensor payload alive for the lifetime of the created view.", "descriptor": "The validated tensor descriptor retained by the view; its offsets and lengths remain bounded by the mapped file.", "logicalDimensions": "The logical dimensions sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "ModelFileSegment", "full_name": "UAIX.LmRuntime.Gguf.ModelFileSegment", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Owns one pooled, bounded model-file segment returned by UAIX.LmRuntime.Gguf.SegmentedModelFileReader.", "remarks": "The segment owns an System.Buffers.ArrayPool`1 lease. Consumers may retain UAIX.LmRuntime.Gguf.ModelFileSegment.Memory only while this instance is alive and must dispose the segment exactly once when the bytes are no longer needed.", "members": [ { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Gguf.ModelFileSegment.IsDisposed", "summary": "Gets whether the pooled segment has been released.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Gguf.ModelFileSegment.Length", "summary": "Gets the number of valid bytes in the segment.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Memory", "xml_id": "P:UAIX.LmRuntime.Gguf.ModelFileSegment.Memory", "summary": "Gets the read-only segment bytes while this owner remains alive.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Offset", "xml_id": "P:UAIX.LmRuntime.Gguf.ModelFileSegment.Offset", "summary": "Gets the unsigned logical file offset represented by this segment.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.Gguf.ModelFileSegment.Dispose", "summary": "Returns the rented byte array to the shared pool and invalidates Memory.", "remarks": "The lifecycle transition releases only resources owned by this instance and prevents subsequent operations from observing partially disposed state. Shared state transitions are synchronized against concurrent use and disposal.", "parameters": {}, "returns": "" } ] }, { "name": "SegmentedModelFileOptions", "full_name": "UAIX.LmRuntime.Gguf.SegmentedModelFileOptions", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Configures bounded segmented reads from a model file whose logical offsets remain unsigned 64-bit values.", "remarks": "", "members": [ { "kind": "property", "name": "MaximumSegmentByteCount", "xml_id": "P:UAIX.LmRuntime.Gguf.SegmentedModelFileOptions.MaximumSegmentByteCount", "summary": "Gets the maximum bytes returned by one owned segment.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "SegmentedModelFileReader", "full_name": "UAIX.LmRuntime.Gguf.SegmentedModelFileReader", "namespace": "UAIX.LmRuntime.Gguf", "summary": "Reads bounded windows from a local model file without representing the complete file as one managed span.", "remarks": "Logical positions remain unsigned 64-bit values until the final checked conversion required by the operating-system random-access API. Returned owned segments are copies in pooled memory; caller-provided spans remain caller owned. This class performs no network access and never follows URLs.", "members": [ { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.IsDisposed", "summary": "Gets whether the reader has released its file handle.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.Length", "summary": "Gets the file length as an unsigned 64-bit value.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumSegmentByteCount", "xml_id": "P:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.MaximumSegmentByteCount", "summary": "Gets the maximum owned segment size.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.Dispose", "summary": "Releases resources owned by SegmentedModelFileReader and transitions it to the disposed state.", "remarks": "Disposal is idempotent; subsequent read operations throw ObjectDisposedException. State changes are limited to fields explicitly updated by this operation.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ReadExactly(ulong,System.Span)", "xml_id": "M:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.ReadExactly(System.UInt64,System.Span{System.Byte})", "summary": "Reads exactly into a caller-owned bounded destination.", "remarks": "The method advances the local source only as bytes are successfully consumed and reports truncated or malformed data instead of returning a partial value. The method completes without publishing a partial success state.", "parameters": { "offset": "The zero-based offset into the relevant source or destination; range validation occurs before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "ReadSegment(ulong,int)", "xml_id": "M:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.ReadSegment(System.UInt64,System.Int32)", "summary": "Reads the segment from the current binary source using the component's validated representation.", "remarks": "SegmentedModelFileReader.ReadSegment implements this contract: Reads the segment from the current binary source using the component's validated representation. It evaluates offset and length before publishing state or a return value. Any rented buffer remains method-owned and is returned through the documented cleanup path before control leaves the operation. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "offset": "The zero-based offset into the relevant source or destination; range validation occurs before access.", "length": "The length used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The ModelFileSegment result produced by SegmentedModelFileReader.ReadSegment for this contract: Reads the segment from the current binary source using the component's validated representation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "SegmentedModelFileReader(string,UAIX.LmRuntime.Gguf.SegmentedModelFileOptions)", "xml_id": "M:UAIX.LmRuntime.Gguf.SegmentedModelFileReader.#ctor(System.String,UAIX.LmRuntime.Gguf.SegmentedModelFileOptions)", "summary": "Opens a local model file for deterministic random access.", "remarks": "Construction validates and records the supplied path and the supplied options before the SegmentedModelFileReader instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional SegmentedModelFileOptions controlling SegmentedModelFileReader; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Sampling", "types": [ { "name": "GenerationController", "full_name": "UAIX.LmRuntime.Sampling.GenerationController", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Enforces stop, limit, cancellation, usage, and output-publication boundaries for one generation.", "remarks": "", "members": [ { "kind": "property", "name": "FinishReason", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationController.FinishReason", "summary": "Gets the first decisive finish reason, or UAIX.LmRuntime.Sampling.GenerationFinishReason.None while active.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputTokenIds", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationController.OutputTokenIds", "summary": "Gets generated token identifiers retained under stop-token emission policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "State", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationController.State", "summary": "Gets the session-local sampling state used by the same generation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Usage", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationController.Usage", "summary": "Gets exact tokenizer-ID usage without deriving counts from text or bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "AcceptToken(int,System.ReadOnlySpan,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Sampling.GenerationController.AcceptToken(System.Int32,System.ReadOnlySpan{System.Byte},System.Threading.CancellationToken)", "summary": "Attempts to accept and publish one generated token at a bounded cancellation point.", "remarks": "GenerationController.AcceptToken implements this contract: Attempts to accept and publish one generated token at a bounded cancellation point. It evaluates tokenId, decodedBytes, and cancellationToken before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "decodedBytes": "The decoded bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "cancellationToken": "Cancellation observed before the token is recorded or published." }, "returns": "The token/output/finish transition produced by this step." }, { "kind": "method", "name": "CompleteVisibleBytes", "xml_id": "M:UAIX.LmRuntime.Sampling.GenerationController.CompleteVisibleBytes", "summary": "Completes an otherwise active stream and flushes any bytes retained as a possible stop prefix.", "remarks": "GenerationController.CompleteVisibleBytes implements this contract: Completes an otherwise active stream and flushes any bytes retained as a possible stop prefix. It evaluates its explicitly owned state before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": {}, "returns": "Remaining visible bytes; the finish reason remains GenerationFinishReason.None." }, { "kind": "method", "name": "Fail(System.Exception)", "xml_id": "M:UAIX.LmRuntime.Sampling.GenerationController.Fail(System.Exception)", "summary": "Records an execution failure without exposing exception details through the stable finish reason.", "remarks": "GenerationController.Fail implements this contract: Records an execution failure without exposing exception details through the stable finish reason. It evaluates exception before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "exception": "The non-null execution failure observed by the caller." }, "returns": "The GenerationFinishReason result produced by GenerationController.Fail for this contract: Records an execution failure without exposing exception details through the stable finish reason. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "GenerationController(int,int,UAIX.LmRuntime.Sampling.SamplingOptions)", "xml_id": "M:UAIX.LmRuntime.Sampling.GenerationController.#ctor(System.Int32,System.Int32,UAIX.LmRuntime.Sampling.SamplingOptions)", "summary": "Initializes a controller from validated vocabulary and prompt-token bounds.", "remarks": "Construction validates and records the supplied vocabulary size, the supplied prompt token count, and the supplied options before the GenerationController instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "vocabularySize": "The positive tokenizer vocabulary size used to validate token identifiers and size bounded result buffers.", "promptTokenCount": "The prompt token count used to bound this operation; it must be nonnegative and within the supported range.", "options": "The optional SamplingOptions controlling GenerationController; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "" }, { "kind": "method", "name": "ObserveCancellation(System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Sampling.GenerationController.ObserveCancellation(System.Threading.CancellationToken)", "summary": "Observes cancellation between decode steps without publishing another token.", "remarks": "GenerationController.ObserveCancellation implements this contract: Observes cancellation between decode steps without publishing another token. It evaluates cancellationToken before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The GenerationFinishReason result produced by GenerationController.ObserveCancellation for this contract: Observes cancellation between decode steps without publishing another token. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GenerationFinishReason", "full_name": "UAIX.LmRuntime.Sampling.GenerationFinishReason", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Identifies the first decisive condition that ended a generation.", "remarks": "", "members": [ { "kind": "field", "name": "Cancelled", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.Cancelled", "summary": "Cancellation was observed before publishing another token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ContextLimit", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.ContextLimit", "summary": "The configured prompt-plus-generation context bound was reached.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ExecutionError", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.ExecutionError", "summary": "An execution error ended generation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "None", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.None", "summary": "Generation remains active.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "StopText", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.StopText", "summary": "A configured decoded UTF-8 stop sequence ended generation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "StopToken", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.StopToken", "summary": "An exact configured token identifier ended generation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TokenLimit", "xml_id": "F:UAIX.LmRuntime.Sampling.GenerationFinishReason.TokenLimit", "summary": "The configured maximum generated-token count was reached.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GenerationStepResult", "full_name": "UAIX.LmRuntime.Sampling.GenerationStepResult", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Represents the observable result of attempting to publish one generated token.", "remarks": "", "members": [ { "kind": "property", "name": "FinishReason", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationStepResult.FinishReason", "summary": "Gets the stable finish reason after this step.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenAccepted", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationStepResult.TokenAccepted", "summary": "Gets whether the token identifier was retained in generated-token output.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VisibleBytes", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationStepResult.VisibleBytes", "summary": "Gets bytes newly safe to publish after stop-prefix matching.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GenerationUsage", "full_name": "UAIX.LmRuntime.Sampling.GenerationUsage", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Records tokenizer-ID-based usage accounting.", "remarks": "", "members": [ { "kind": "property", "name": "CompletionTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationUsage.CompletionTokens", "summary": "Gets the exact number of generated token identifiers accepted by the controller.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationUsage.PromptTokens", "summary": "Gets the exact number of prompt token identifiers consumed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TotalTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.GenerationUsage.TotalTokens", "summary": "Gets the checked sum of prompt and completion token counts.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GreedySampler", "full_name": "UAIX.LmRuntime.Sampling.GreedySampler", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Provides deterministic greedy token selection with explicit non-finite input policy.", "remarks": "", "members": [ { "kind": "method", "name": "Select(System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Sampling.GreedySampler.Select(System.ReadOnlySpan{System.Single})", "summary": "Selects the highest logit index with deterministic lower-index tie-breaking.", "remarks": "GreedySampler.Select implements this contract: Selects the highest logit index with deterministic lower-index tie-breaking. It evaluates logits before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The non-empty source logits. NaN is rejected; infinities compare normally." }, "returns": "The int value computed by GreedySampler.Select for this contract: Selects the highest logit index with deterministic lower-index tie-breaking. Range, finite-value, and overflow checks are completed before the value is returned." } ] }, { "name": "LogitProcessor", "full_name": "UAIX.LmRuntime.Sampling.LogitProcessor", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Applies validated, deterministic token-history and bias policies to logits.", "remarks": "", "members": [ { "kind": "method", "name": "ApplyBias(System.Span,System.Collections.Generic.IReadOnlyDictionary)", "xml_id": "M:UAIX.LmRuntime.Sampling.LogitProcessor.ApplyBias(System.Span{System.Single},System.Collections.Generic.IReadOnlyDictionary{System.Int32,System.Single})", "summary": "Adds all validated per-token biases exactly once.", "remarks": "LogitProcessor.ApplyBias implements this contract: Adds all validated per-token biases exactly once. It evaluates logits and biases before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "biases": "The ordered biases collection of type IReadOnlyDictionary; LogitProcessor.ApplyBias validates nullability, count, and element constraints before consuming or snapshotting it and does not retain a mutable caller alias." }, "returns": "" }, { "kind": "method", "name": "ApplyHistoryPenalties(System.Span,UAIX.LmRuntime.Sampling.SamplingOptions,System.Collections.Generic.IReadOnlyDictionary)", "xml_id": "M:UAIX.LmRuntime.Sampling.LogitProcessor.ApplyHistoryPenalties(System.Span{System.Single},UAIX.LmRuntime.Sampling.SamplingOptions,System.Collections.Generic.IReadOnlyDictionary{System.Int32,System.Int32})", "summary": "Applies sign-aware repetition, frequency, and presence penalties in one deterministic pass.", "remarks": "LogitProcessor.ApplyHistoryPenalties implements this contract: Applies sign-aware repetition, frequency, and presence penalties in one deterministic pass. It evaluates logits, options, and tokenCounts before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "options": "The optional SamplingOptions controlling ApplyHistoryPenalties; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "tokenCounts": "The ordered token counts collection of type IReadOnlyDictionary; LogitProcessor.ApplyHistoryPenalties validates nullability, count, and element constraints before consuming or snapshotting it and does not retain a mutable caller alias." }, "returns": "" }, { "kind": "method", "name": "Process(System.ReadOnlySpan,UAIX.LmRuntime.Sampling.SamplingOptions,UAIX.LmRuntime.Sampling.SamplingState)", "xml_id": "M:UAIX.LmRuntime.Sampling.LogitProcessor.Process(System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Sampling.SamplingOptions,UAIX.LmRuntime.Sampling.SamplingState)", "summary": "Produces a processed copy of the source logits without exposing partially mutated caller data on validation failure.", "remarks": "LogitProcessor.Process implements this contract: Produces a processed copy of the source logits without exposing partially mutated caller data on validation failure. It evaluates logits, options, and state before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "options": "The optional SamplingOptions controlling Process; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "state": "The validated state value consumed by the operation; mutations, when applicable, are limited to the explicitly documented state owner." }, "returns": "A newly allocated float[] containing the ordered result of LogitProcessor.Process: Produces a processed copy of the source logits without exposing partially mutated caller data on validation failure. The caller owns the returned array and later mutation cannot alter the source object." }, { "kind": "method", "name": "SuppressEarlyStopTokens(System.Span,UAIX.LmRuntime.Sampling.SamplingOptions,int)", "xml_id": "M:UAIX.LmRuntime.Sampling.LogitProcessor.SuppressEarlyStopTokens(System.Span{System.Single},UAIX.LmRuntime.Sampling.SamplingOptions,System.Int32)", "summary": "Marks configured stop tokens ineligible before the exact minimum-token boundary.", "remarks": "LogitProcessor.SuppressEarlyStopTokens implements this contract: Marks configured stop tokens ineligible before the exact minimum-token boundary. It evaluates logits, options, and generatedTokenCount before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "options": "The optional SamplingOptions controlling SuppressEarlyStopTokens; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "generatedTokenCount": "The generated token count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "" } ] }, { "name": "LogitScore", "full_name": "UAIX.LmRuntime.Sampling.LogitScore", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Represents a scored token candidate.", "remarks": "", "members": [ { "kind": "property", "name": "Score", "xml_id": "P:UAIX.LmRuntime.Sampling.LogitScore.Score", "summary": "Gets the logit score.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenIndex", "xml_id": "P:UAIX.LmRuntime.Sampling.LogitScore.TokenIndex", "summary": "Gets the token index.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ProbabilitySampler", "full_name": "UAIX.LmRuntime.Sampling.ProbabilitySampler", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Builds stable normalized distributions and samples them with session-local deterministic state.", "remarks": "", "members": [ { "kind": "method", "name": "BuildDistribution(System.ReadOnlySpan,UAIX.LmRuntime.Sampling.SamplingOptions)", "xml_id": "M:UAIX.LmRuntime.Sampling.ProbabilitySampler.BuildDistribution(System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Sampling.SamplingOptions)", "summary": "Builds a stable, filtered, and normalized probability distribution without consuming random state.", "remarks": "ProbabilitySampler.BuildDistribution implements this contract: Builds a stable, filtered, and normalized probability distribution without consuming random state. It evaluates processedLogits and options before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "processedLogits": "The processed logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "options": "The optional SamplingOptions controlling BuildDistribution; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "Candidates ordered by descending probability and ascending token identifier for ties." }, { "kind": "method", "name": "Select(System.ReadOnlySpan,UAIX.LmRuntime.Sampling.SamplingOptions,UAIX.LmRuntime.Sampling.SamplingState)", "xml_id": "M:UAIX.LmRuntime.Sampling.ProbabilitySampler.Select(System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Sampling.SamplingOptions,UAIX.LmRuntime.Sampling.SamplingState)", "summary": "Processes logits and selects one token under the supplied deterministic policy.", "remarks": "ProbabilitySampler.Select implements this contract: Processes logits and selects one token under the supplied deterministic policy. It evaluates logits, options, and state before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "options": "The optional SamplingOptions controlling Select; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "state": "The validated state value consumed by the operation; mutations, when applicable, are limited to the explicitly documented state owner." }, "returns": "The SamplingDecision result produced by ProbabilitySampler.Select for this contract: Processes logits and selects one token under the supplied deterministic policy. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "SamplingCandidate", "full_name": "UAIX.LmRuntime.Sampling.SamplingCandidate", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Represents one normalized token candidate retained after all filters.", "remarks": "", "members": [ { "kind": "property", "name": "Probability", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingCandidate.Probability", "summary": "Gets the normalized candidate probability.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingCandidate.TokenId", "summary": "Gets the token identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "SamplingDecision", "full_name": "UAIX.LmRuntime.Sampling.SamplingDecision", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Describes one deterministic or stochastic sampling decision.", "remarks": "", "members": [ { "kind": "property", "name": "Candidates", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingDecision.Candidates", "summary": "Gets the candidate distribution used for selection, ordered by probability and token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsGreedy", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingDecision.IsGreedy", "summary": "Gets whether the zero-temperature greedy path made the decision.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingDecision.TokenId", "summary": "Gets the selected token identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "SamplingOptions", "full_name": "UAIX.LmRuntime.Sampling.SamplingOptions", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Defines deterministic logit-processing, candidate-selection, and generation-stop policies for one sampling session.", "remarks": "Instances are treated as immutable configuration after a UAIX.LmRuntime.Sampling.SamplingState is created. Validation is intentionally performed before a logit buffer is modified so an invalid option cannot leave partially adjusted data.", "members": [ { "kind": "property", "name": "FrequencyPenalty", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.FrequencyPenalty", "summary": "Gets the amount subtracted for each prior occurrence of a token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IncludeStopSequence", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.IncludeStopSequence", "summary": "Gets whether matched stop-sequence bytes are included in visible output.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IncludeStopToken", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.IncludeStopToken", "summary": "Gets whether a matched stop token is retained in emitted token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LogitBias", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.LogitBias", "summary": "Gets finite per-token additive logit biases.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumContextTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.MaximumContextTokens", "summary": "Gets the maximum prompt-plus-generation token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumGeneratedTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.MaximumGeneratedTokens", "summary": "Gets the maximum number of generated tokens. Zero permits no generated tokens.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumGeneratedTokens", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.MinimumGeneratedTokens", "summary": "Gets the minimum generated-token count before stop-token or stop-text policies become eligible.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumP", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.MinimumP", "summary": "Gets the minimum probability relative to the highest candidate probability.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PresencePenalty", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.PresencePenalty", "summary": "Gets the amount subtracted once from any token that has previously appeared.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RepetitionPenalty", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.RepetitionPenalty", "summary": "Gets the positive sign-aware repetition penalty.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Seed", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.Seed", "summary": "Gets the deterministic per-session pseudo-random generator seed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopSequences", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.StopSequences", "summary": "Gets UTF-8 stop strings matched across decoded token boundaries.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopTokenIds", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.StopTokenIds", "summary": "Gets exact token identifiers that terminate generation after the minimum-token boundary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Temperature", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.Temperature", "summary": "Gets the non-negative temperature. Zero selects the deterministic greedy path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TopK", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.TopK", "summary": "Gets the maximum candidate count. Zero disables top-k filtering.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TopP", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingOptions.TopP", "summary": "Gets the normalized nucleus probability threshold in the inclusive range zero through one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Validate(int)", "xml_id": "M:UAIX.LmRuntime.Sampling.SamplingOptions.Validate(System.Int32)", "summary": "Validates every option and token-indexed policy against a vocabulary size without mutating caller data.", "remarks": "SamplingOptions.Validate implements this contract: Validates every option and token-indexed policy against a vocabulary size without mutating caller data. It evaluates vocabularySize before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "vocabularySize": "The positive number of logits accepted by the model." }, "returns": "" } ] }, { "name": "SamplingState", "full_name": "UAIX.LmRuntime.Sampling.SamplingState", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Stores token history and deterministic pseudo-random state for exactly one generation session.", "remarks": "A state instance must not be shared by independent requests. Keeping history and random state together makes session isolation explicit and prevents interleaved requests from consuming one another's random sequence.", "members": [ { "kind": "property", "name": "GeneratedTokenCount", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingState.GeneratedTokenCount", "summary": "Gets the number of generated token identifiers recorded by this session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Random", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingState.Random", "summary": "Gets the session-local deterministic random generator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenCounts", "xml_id": "P:UAIX.LmRuntime.Sampling.SamplingState.TokenCounts", "summary": "Gets the session-owned prior-token counts through a read-only interface.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetTokenCount(int)", "xml_id": "M:UAIX.LmRuntime.Sampling.SamplingState.GetTokenCount(System.Int32)", "summary": "Gets the prior count for one token without adding it to history.", "remarks": "SamplingState.GetTokenCount implements this contract: Gets the prior count for one token without adding it to history. It evaluates tokenId before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range." }, "returns": "The recorded count, or zero when the token has not appeared." }, { "kind": "method", "name": "RecordToken(int)", "xml_id": "M:UAIX.LmRuntime.Sampling.SamplingState.RecordToken(System.Int32)", "summary": "Records one generated token for repetition, frequency, presence, and usage policies.", "remarks": "SamplingState.RecordToken implements this contract: Records one generated token for repetition, frequency, presence, and usage policies. It evaluates tokenId before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "tokenId": "The non-negative tokenizer identifier generated by the model." }, "returns": "" }, { "kind": "method", "name": "SamplingState(UAIX.LmRuntime.Sampling.SamplingOptions)", "xml_id": "M:UAIX.LmRuntime.Sampling.SamplingState.#ctor(UAIX.LmRuntime.Sampling.SamplingOptions)", "summary": "Initializes isolated state from the immutable session options.", "remarks": "SamplingState.SamplingState establishes the invariants required by this contract: Initializes isolated state from the immutable session options. It evaluates options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "options": "The options whose seed initializes the session generator." }, "returns": "" } ] }, { "name": "StopSequenceMatcher", "full_name": "UAIX.LmRuntime.Sampling.StopSequenceMatcher", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Matches UTF-8 stop sequences across arbitrary decoded-byte boundaries while retaining only a bounded possible prefix.", "remarks": "", "members": [ { "kind": "property", "name": "MaximumRetainedBytes", "xml_id": "P:UAIX.LmRuntime.Sampling.StopSequenceMatcher.MaximumRetainedBytes", "summary": "Gets the maximum retained prefix bytes, bounded by the longest configured stop sequence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RetainedByteCount", "xml_id": "P:UAIX.LmRuntime.Sampling.StopSequenceMatcher.RetainedByteCount", "summary": "Gets the current possible stop-prefix byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Append(System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Sampling.StopSequenceMatcher.Append(System.ReadOnlySpan{System.Byte})", "summary": "Appends one decoded byte chunk and releases bytes that can no longer participate in a stop match.", "remarks": "StopSequenceMatcher.Append implements this contract: Appends one decoded byte chunk and releases bytes that can no longer participate in a stop match. It evaluates bytes before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "bytes": "The next decoded UTF-8 bytes; chunks may split a code point or stop sequence." }, "returns": "The newly visible bytes and optional terminal match." }, { "kind": "method", "name": "Complete", "xml_id": "M:UAIX.LmRuntime.Sampling.StopSequenceMatcher.Complete", "summary": "Completes matching and releases any retained non-matching prefix bytes.", "remarks": "StopSequenceMatcher.Complete implements this contract: Completes matching and releases any retained non-matching prefix bytes. It evaluates its explicitly owned state before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": {}, "returns": "A newly allocated byte[] containing the ordered result of StopSequenceMatcher.Complete: Completes matching and releases any retained non-matching prefix bytes. The caller owns the returned array and later mutation cannot alter the source object." }, { "kind": "method", "name": "StopSequenceMatcher(System.Collections.Generic.IEnumerable,bool)", "xml_id": "M:UAIX.LmRuntime.Sampling.StopSequenceMatcher.#ctor(System.Collections.Generic.IEnumerable{System.String},System.Boolean)", "summary": "Initializes a matcher from non-empty stop strings.", "remarks": "Construction validates and records the supplied stop sequences and the supplied include matched bytes before the StopSequenceMatcher instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "stopSequences": "The exact Unicode strings encoded as UTF-8 for byte matching.", "includeMatchedBytes": "Whether a terminal match is included in visible output." }, "returns": "" } ] }, { "name": "StopSequenceMatchResult", "full_name": "UAIX.LmRuntime.Sampling.StopSequenceMatchResult", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Represents visible bytes released by one bounded stop-sequence matching step.", "remarks": "", "members": [ { "kind": "property", "name": "Matched", "xml_id": "P:UAIX.LmRuntime.Sampling.StopSequenceMatchResult.Matched", "summary": "Gets whether a terminal stop sequence has matched.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MatchedStopSequence", "xml_id": "P:UAIX.LmRuntime.Sampling.StopSequenceMatchResult.MatchedStopSequence", "summary": "Gets the exact stop string that completed during this step, if any.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VisibleBytes", "xml_id": "P:UAIX.LmRuntime.Sampling.StopSequenceMatchResult.VisibleBytes", "summary": "Gets newly visible bytes that cannot participate in a future stop match.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TopKSelector", "full_name": "UAIX.LmRuntime.Sampling.TopKSelector", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Provides partial top-k selection for logit arrays.", "remarks": "", "members": [ { "kind": "method", "name": "SelectTopK(System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Sampling.TopKSelector.SelectTopK(System.ReadOnlySpan{System.Single},System.Int32)", "summary": "Selects the highest scoring token candidates without sorting the full input.", "remarks": "TopKSelector.SelectTopK implements this contract: Selects the highest scoring token candidates without sorting the full input. It evaluates logits and k before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "k": "The numeric k consumed by SelectTopK; it must satisfy the member's documented range, geometry, and finite-value requirements." }, "returns": "The selected candidates in descending score order with deterministic index tie-breaking." } ] }, { "name": "Xoshiro256StarStar", "full_name": "UAIX.LmRuntime.Sampling.Xoshiro256StarStar", "namespace": "UAIX.LmRuntime.Sampling", "summary": "Implements the xoshiro256** generator with SplitMix64 seed expansion and deterministic unsigned arithmetic.", "remarks": "The generator is intentionally session-local and not thread-safe. Its transition follows the published xoshiro256** reference algorithm; seed expansion prevents the prohibited all-zero state for a zero seed.", "members": [ { "kind": "method", "name": "NextUInt64", "xml_id": "M:UAIX.LmRuntime.Sampling.Xoshiro256StarStar.NextUInt64", "summary": "Returns the next 64-bit output and advances the generator exactly once.", "remarks": "Xoshiro256StarStar.NextUInt64 implements this contract: Returns the next 64-bit output and advances the generator exactly once. It evaluates its explicitly owned state before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": {}, "returns": "The ulong value computed by Xoshiro256StarStar.NextUInt64 for this contract: Returns the next 64-bit output and advances the generator exactly once. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "NextUnitDouble", "xml_id": "M:UAIX.LmRuntime.Sampling.Xoshiro256StarStar.NextUnitDouble", "summary": "Returns a uniformly distributed value in the half-open interval [0, 1).", "remarks": "Xoshiro256StarStar.NextUnitDouble implements this contract: Returns a uniformly distributed value in the half-open interval [0, 1). It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The double value computed by Xoshiro256StarStar.NextUnitDouble for this contract: Returns a uniformly distributed value in the half-open interval [0, 1). Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "Xoshiro256StarStar(ulong)", "xml_id": "M:UAIX.LmRuntime.Sampling.Xoshiro256StarStar.#ctor(System.UInt64)", "summary": "Initializes the generator from one deterministic 64-bit seed.", "remarks": "Construction validates and records the supplied seed before the Xoshiro256StarStar instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "seed": "The numeric seed consumed by Xoshiro256StarStar; it must satisfy the member's documented range, geometry, and finite-value requirements." }, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Kernels.Cpu", "types": [ { "name": "Avx2Float32Kernels", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Avx2Float32Kernels", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides dedicated AVX2 float32 correctness kernels with scalar tails.", "remarks": "These kernels are selected only when AVX2 is explicitly requested and supported. Scalar implementations remain the numerical authority, and no throughput claim is implied until executed benchmark evidence exists.", "members": [ { "kind": "method", "name": "Dot(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Avx2Float32Kernels.Dot(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single})", "summary": "Computes a float32 dot product with AVX/FMA vector arithmetic and a scalar tail.", "remarks": "Avx2Float32Kernels.Dot implements this contract: Computes a float32 dot product with AVX/FMA vector arithmetic and a scalar tail. It evaluates left and right before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "left": "The left sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "right": "The right sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by Avx2Float32Kernels.Dot for this contract: Computes a float32 dot product with AVX/FMA vector arithmetic and a scalar tail. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "MatVec(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Avx2Float32Kernels.MatVec(System.ReadOnlySpan{System.Single},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a row-major float32 matrix-vector product by reusing the dedicated AVX2 dot kernel.", "remarks": "Avx2Float32Kernels.MatVec implements this contract: Computes a row-major float32 matrix-vector product by reusing the dedicated AVX2 dot kernel. It evaluates matrix, rowCount, columnCount, vector, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "CpuKernelDispatcher", "full_name": "UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Dispatches correctness-first CPU kernels through explicitly selectable implementation tiers.", "remarks": "Scalar implementations remain the numerical authority. Portable and architecture-specific paths are additive and can always be bypassed by requesting UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.Scalar.", "members": [ { "kind": "method", "name": "DotFloat32(System.ReadOnlySpan,System.ReadOnlySpan,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.DotFloat32(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "summary": "Computes a float32 dot product through the selected implementation tier.", "remarks": "CpuKernelDispatcher.DotFloat32 implements this contract: Computes a float32 dot product through the selected implementation tier. It evaluates left, right, requestedTier, and selection before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "left": "The left sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "right": "The right sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing.", "selection": "When the method returns, contains the selection produced by the operation when successful; otherwise contains the type's default value." }, "returns": "The float value computed by CpuKernelDispatcher.DotFloat32 for this contract: Computes a float32 dot product through the selected implementation tier. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DotQ4_0(System.ReadOnlySpan,System.ReadOnlySpan,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.DotQ4_0(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "summary": "Computes a Q4_0 block dot product through a scalar or portable-vector correctness path.", "remarks": "CpuKernelDispatcher.DotQ4_0 implements this contract: Computes a Q4_0 block dot product through a scalar or portable-vector correctness path. It evaluates block, activations, requestedTier, and selection before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing.", "selection": "When the method returns, contains the selection produced by the operation when successful; otherwise contains the type's default value." }, "returns": "The float value computed by CpuKernelDispatcher.DotQ4_0 for this contract: Computes a Q4_0 block dot product through a scalar or portable-vector correctness path. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DotQ8_0(System.ReadOnlySpan,System.ReadOnlySpan,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.DotQ8_0(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "summary": "Computes a Q8_0 block dot product through a scalar or portable-vector correctness path.", "remarks": "CpuKernelDispatcher.DotQ8_0 implements this contract: Computes a Q8_0 block dot product through a scalar or portable-vector correctness path. It evaluates block, activations, requestedTier, and selection before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing.", "selection": "When the method returns, contains the selection produced by the operation when successful; otherwise contains the type's default value." }, "returns": "The float value computed by CpuKernelDispatcher.DotQ8_0 for this contract: Computes a Q8_0 block dot product through a scalar or portable-vector correctness path. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "MatVecFloat32(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.MatVecFloat32(System.ReadOnlySpan{System.Single},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single},UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "summary": "Computes a row-major float32 matrix-vector product through the selected implementation tier.", "remarks": "CpuKernelDispatcher.MatVecFloat32 implements this contract: Computes a row-major float32 matrix-vector product through the selected implementation tier. It evaluates matrix, rowCount, columnCount, vector, output, requestedTier, and selection before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing.", "selection": "When the method returns, contains the selection produced by the operation when successful; otherwise contains the type's default value." }, "returns": "" }, { "kind": "method", "name": "RmsNorm(System.ReadOnlySpan,System.ReadOnlySpan,System.Span,float,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.RmsNorm(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Single,UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier,UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection@)", "summary": "Applies RMS normalization using the selected scalar or portable-vector accumulation tier.", "remarks": "CpuKernelDispatcher.RmsNorm implements this contract: Applies RMS normalization using the selected scalar or portable-vector accumulation tier. It evaluates input, weight, output, epsilon, requestedTier, and selection before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "input": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "weight": "The weight sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "epsilon": "The positive normalization epsilon added to the mean-square term to avoid division by zero while preserving deterministic numerical behavior.", "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing.", "selection": "When the method returns, contains the selection produced by the operation when successful; otherwise contains the type's default value." }, "returns": "" }, { "kind": "method", "name": "SelectFloat32DotTier(UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.CpuKernelDispatcher.SelectFloat32DotTier(UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier)", "summary": "Selects the implemented tier for a float32 dot product.", "remarks": "CpuKernelDispatcher.SelectFloat32DotTier implements this contract: Selects the implemented tier for a float32 dot product. It evaluates requestedTier before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "requestedTier": "The requested tier containing caller-supplied values for this operation; all required fields are validated before processing." }, "returns": "The CpuKernelSelection result produced by CpuKernelDispatcher.SelectFloat32DotTier for this contract: Selects the implemented tier for a float32 dot product. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "CpuKernelSelection", "full_name": "UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Describes the requested and selected CPU kernel tier for one operation.", "remarks": "", "members": [ { "kind": "property", "name": "Operation", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection.Operation", "summary": "Gets the operation name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Reason", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection.Reason", "summary": "Gets the stable selection rationale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequestedTier", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection.RequestedTier", "summary": "Gets the requested tier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedTier", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.CpuKernelSelection.SelectedTier", "summary": "Gets the selected tier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "CpuKernelTier", "full_name": "UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Identifies a managed CPU kernel implementation tier.", "remarks": "", "members": [ { "kind": "field", "name": "AdvSimd", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.AdvSimd", "summary": "Uses an ARM64 AdvSimd implementation when the operation provides one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Auto", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.Auto", "summary": "Selects the highest supported tier implemented for the requested operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Avx2", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.Avx2", "summary": "Uses an AVX2 implementation when the operation provides one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Avx512", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.Avx512", "summary": "Uses an AVX-512 implementation when the operation provides one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "PortableVector", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.PortableVector", "summary": "Uses portable System.Numerics.Vector`1 operations.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scalar", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.CpuKernelTier.Scalar", "summary": "Uses the scalar correctness implementation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "FusedQuantizedDotProduct", "full_name": "UAIX.LmRuntime.Kernels.Cpu.FusedQuantizedDotProduct", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides fused dequantize-and-dot reference kernels.", "remarks": "", "members": [ { "kind": "method", "name": "Dot(UAIX.LmRuntime.Tensors.GgmlTensorType,System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.FusedQuantizedDotProduct.Dot(UAIX.LmRuntime.Tensors.GgmlTensorType,System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single})", "summary": "Computes a dot product between a quantized block and float activations.", "remarks": "FusedQuantizedDotProduct.Dot implements this contract: Computes a dot product between a quantized block and float activations. It evaluates type, block, and activations before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules.", "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by FusedQuantizedDotProduct.Dot for this contract: Computes a dot product between a quantized block and float activations. Range, finite-value, and overflow checks are completed before the value is returned." } ] }, { "name": "KQuantizedBlockLayout", "full_name": "UAIX.LmRuntime.Kernels.Cpu.KQuantizedBlockLayout", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Describes one audited K-quantized block layout.", "remarks": "", "members": [ { "kind": "property", "name": "ByteCount", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedBlockLayout.ByteCount", "summary": "Gets the physical byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ElementCount", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedBlockLayout.ElementCount", "summary": "Gets the logical element count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Format", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedBlockLayout.Format", "summary": "Gets the format name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LayoutDescription", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedBlockLayout.LayoutDescription", "summary": "Gets the audited layout statement.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "KQuantizedCpuKernels", "full_name": "UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides correctness-first scalar GGML Q4_K and Q6_K block kernels.", "remarks": "These methods operate on one exact 256-element block and never materialize a complete model matrix. All scale fields are interpreted as little-endian IEEE half values because current direct K-quant execution is limited to little-endian GGUF storage.", "members": [ { "kind": "field", "name": "BlockElementCount", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.BlockElementCount", "summary": "Gets the number of logical values in one K-quant block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_KBlockBytes", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q4_KBlockBytes", "summary": "Gets the historical Q4_K block-byte constant retained for source compatibility.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4KBlockByteCount", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q4KBlockByteCount", "summary": "Gets the exact Q4_K block byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q6_KBlockBytes", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q6_KBlockBytes", "summary": "Gets the historical Q6_K block-byte constant retained for source compatibility.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q6KBlockByteCount", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q6KBlockByteCount", "summary": "Gets the exact Q6_K block byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Q4KLayout", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q4KLayout", "summary": "Gets the audited Q4_K block layout.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Q6KLayout", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.Q6KLayout", "summary": "Gets the audited Q6_K block layout.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "DequantizeQ4_K(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DequantizeQ4_K(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one Q4_K block using the historical method name retained for source compatibility.", "remarks": "KQuantizedCpuKernels.DequantizeQ4_K implements this contract: Dequantizes one Q4_K block using the historical method name retained for source compatibility. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "DequantizeQ4K(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DequantizeQ4K(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one exact Q4_K block into a caller-owned destination.", "remarks": "KQuantizedCpuKernels.DequantizeQ4K implements this contract: Dequantizes one exact Q4_K block into a caller-owned destination. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "DequantizeQ6_K(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DequantizeQ6_K(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one Q6_K block using the historical method name retained for source compatibility.", "remarks": "KQuantizedCpuKernels.DequantizeQ6_K implements this contract: Dequantizes one Q6_K block using the historical method name retained for source compatibility. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "DequantizeQ6K(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DequantizeQ6K(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one exact Q6_K block into a caller-owned destination.", "remarks": "KQuantizedCpuKernels.DequantizeQ6K implements this contract: Dequantizes one exact Q6_K block into a caller-owned destination. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "DotQ4K(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DotQ4K(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single})", "summary": "Computes an allocation-free dot product for one exact Q4_K block.", "remarks": "KQuantizedCpuKernels.DotQ4K implements this contract: Computes an allocation-free dot product for one exact Q4_K block. It evaluates block and activations before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by KQuantizedCpuKernels.DotQ4K for this contract: Computes an allocation-free dot product for one exact Q4_K block. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DotQ6K(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.DotQ6K(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single})", "summary": "Computes an allocation-free dot product for one exact Q6_K block.", "remarks": "KQuantizedCpuKernels.DotQ6K implements this contract: Computes an allocation-free dot product for one exact Q6_K block. It evaluates block and activations before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by KQuantizedCpuKernels.DotQ6K for this contract: Computes an allocation-free dot product for one exact Q6_K block. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "MatVecQ4_K(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.MatVecQ4_K(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a Q4_K matrix-vector product using the historical method name retained for source compatibility.", "remarks": "KQuantizedCpuKernels.MatVecQ4_K implements this contract: Computes a Q4_K matrix-vector product using the historical method name retained for source compatibility. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "MatVecQ4K(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.MatVecQ4K(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a row-major Q4_K matrix-vector product without whole-matrix dequantization.", "remarks": "KQuantizedCpuKernels.MatVecQ4K implements this contract: Computes a row-major Q4_K matrix-vector product without whole-matrix dequantization. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "MatVecQ6_K(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.MatVecQ6_K(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a Q6_K matrix-vector product using the historical method name retained for source compatibility.", "remarks": "KQuantizedCpuKernels.MatVecQ6_K implements this contract: Computes a Q6_K matrix-vector product using the historical method name retained for source compatibility. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "MatVecQ6K(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.KQuantizedCpuKernels.MatVecQ6K(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a row-major Q6_K matrix-vector product without whole-matrix dequantization.", "remarks": "KQuantizedCpuKernels.MatVecQ6K implements this contract: Computes a row-major Q6_K matrix-vector product without whole-matrix dequantization. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "Q4_0Block", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q4_0Block", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Defines the exact packed Q4_0 block layout used by GGML storage.", "remarks": "", "members": [ { "kind": "field", "name": "QuantizedValues", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4_0Block.QuantizedValues", "summary": "Stores 32 signed 4-bit values in 16 packed bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scale", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4_0Block.Scale", "summary": "Gets or sets the little-endian IEEE half scale field.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q4_1Dequantizer", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q4_1Dequantizer", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Dequantizes Q4_1 blocks for scalar reference parity.", "remarks": "", "members": [ { "kind": "method", "name": "DequantizeBlock(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Q4_1Dequantizer.DequantizeBlock(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one Q4_1 block into destination floats.", "remarks": "Q4_1Dequantizer.DequantizeBlock implements this contract: Dequantizes one Q4_1 block into destination floats. It evaluates source and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "source": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "Q4KBlock", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q4KBlock", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Defines the audited packed GGML Q4_K block layout for 256 logical values.", "remarks": "", "members": [ { "kind": "field", "name": "MinimumScale", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4KBlock.MinimumScale", "summary": "Gets or sets the common little-endian IEEE half minimum scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "QuantizedValues", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4KBlock.QuantizedValues", "summary": "Stores 256 four-bit quants in 128 bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scale", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4KBlock.Scale", "summary": "Gets or sets the common little-endian IEEE half scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ScaleMinimums", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q4KBlock.ScaleMinimums", "summary": "Stores eight packed 6-bit scales and eight packed 6-bit minimum factors.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q5_0Dequantizer", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q5_0Dequantizer", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Dequantizes Q5_0 blocks for scalar reference parity.", "remarks": "", "members": [ { "kind": "method", "name": "DequantizeBlock(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Q5_0Dequantizer.DequantizeBlock(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one Q5_0 block into destination floats.", "remarks": "Q5_0Dequantizer.DequantizeBlock implements this contract: Dequantizes one Q5_0 block into destination floats. It evaluates source and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "source": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "Q6_KDequantizer", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q6_KDequantizer", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Dequantizes Q6_K blocks for scalar reference parity.", "remarks": "", "members": [ { "kind": "method", "name": "DequantizeBlock(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Q6_KDequantizer.DequantizeBlock(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one exact GGML Q6_K block into destination floats.", "remarks": "Q6_KDequantizer.DequantizeBlock implements this contract: Dequantizes one exact GGML Q6_K block into destination floats. It evaluates source and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "source": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "Q6KBlock", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q6KBlock", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Defines the audited packed GGML Q6_K block layout for 256 logical values.", "remarks": "", "members": [ { "kind": "field", "name": "HighBits", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q6KBlock.HighBits", "summary": "Stores the upper two bits for 256 quants.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "LowBits", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q6KBlock.LowBits", "summary": "Stores the lower four bits for 256 quants.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scale", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q6KBlock.Scale", "summary": "Gets or sets the common little-endian IEEE half scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scales", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q6KBlock.Scales", "summary": "Stores sixteen signed sub-block scales.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Q8_0Block", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Q8_0Block", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Defines the exact packed Q8_0 block layout used by GGML storage.", "remarks": "", "members": [ { "kind": "field", "name": "QuantizedValues", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q8_0Block.QuantizedValues", "summary": "Stores 32 signed 8-bit values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Scale", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.Q8_0Block.Scale", "summary": "Gets or sets the little-endian IEEE half scale field.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "QuantizedCpuKernels", "full_name": "UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides allocation-free scalar correctness kernels for high-value GGML quantization formats.", "remarks": "", "members": [ { "kind": "field", "name": "BlockElementCount", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.BlockElementCount", "summary": "Gets the logical element count in a Q4_0 or Q8_0 block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q4_0BlockBytes", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.Q4_0BlockBytes", "summary": "Gets the byte length of a Q4_0 block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Q8_0BlockBytes", "xml_id": "F:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.Q8_0BlockBytes", "summary": "Gets the byte length of a Q8_0 block.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "DequantizeQ4_0(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.DequantizeQ4_0(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one little-endian Q4_0 block into float32 values.", "remarks": "QuantizedCpuKernels.DequantizeQ4_0 implements this contract: Dequantizes one little-endian Q4_0 block into float32 values. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The destination buffer with room for 32 values." }, "returns": "" }, { "kind": "method", "name": "DequantizeQ8_0(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.DequantizeQ8_0(System.ReadOnlySpan{System.Byte},System.Span{System.Single})", "summary": "Dequantizes one little-endian Q8_0 block into float32 values.", "remarks": "QuantizedCpuKernels.DequantizeQ8_0 implements this contract: Dequantizes one little-endian Q8_0 block into float32 values. It evaluates block and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "destination": "The destination buffer with room for 32 values." }, "returns": "" }, { "kind": "method", "name": "DotQ4_0(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.DotQ4_0(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single})", "summary": "Computes an allocation-free dequantize-and-dot operation for one Q4_0 block.", "remarks": "QuantizedCpuKernels.DotQ4_0 implements this contract: Computes an allocation-free dequantize-and-dot operation for one Q4_0 block. It evaluates block and activations before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by QuantizedCpuKernels.DotQ4_0 for this contract: Computes an allocation-free dequantize-and-dot operation for one Q4_0 block. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DotQ8_0(System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.DotQ8_0(System.ReadOnlySpan{System.Byte},System.ReadOnlySpan{System.Single})", "summary": "Computes an allocation-free dequantize-and-dot operation for one Q8_0 block.", "remarks": "QuantizedCpuKernels.DotQ8_0 implements this contract: Computes an allocation-free dequantize-and-dot operation for one Q8_0 block. It evaluates block and activations before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "block": "The block sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The float value computed by QuantizedCpuKernels.DotQ8_0 for this contract: Computes an allocation-free dequantize-and-dot operation for one Q8_0 block. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "MatVecQ4_0(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.MatVecQ4_0(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a row-major Q4_0 matrix-vector product without materializing full-precision rows.", "remarks": "QuantizedCpuKernels.MatVecQ4_0 implements this contract: Computes a row-major Q4_0 matrix-vector product without materializing full-precision rows. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The number of logical columns; it must be divisible by 32.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "MatVecQ8_0(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedCpuKernels.MatVecQ8_0(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a row-major Q8_0 matrix-vector product without materializing full-precision rows.", "remarks": "QuantizedCpuKernels.MatVecQ8_0 implements this contract: Computes a row-major Q8_0 matrix-vector product without materializing full-precision rows. It evaluates matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The number of logical columns; it must be divisible by 32.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "QuantizedKernelParityReport", "full_name": "UAIX.LmRuntime.Kernels.Cpu.QuantizedKernelParityReport", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Represents the result of comparing an optimized quantized kernel to a reference kernel.", "remarks": "", "members": [ { "kind": "property", "name": "MaxAbsoluteError", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.QuantizedKernelParityReport.MaxAbsoluteError", "summary": "Gets the maximum absolute error observed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Passed", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.QuantizedKernelParityReport.Passed", "summary": "Gets a value indicating whether outputs are within tolerance.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "QuantizedKernelParityRunner", "full_name": "UAIX.LmRuntime.Kernels.Cpu.QuantizedKernelParityRunner", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Compares quantized kernels against scalar references.", "remarks": "", "members": [ { "kind": "method", "name": "CompareAgainstReference(System.ReadOnlySpan,System.ReadOnlySpan,float)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.QuantizedKernelParityRunner.CompareAgainstReference(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Single)", "summary": "Compares two output vectors with an absolute tolerance.", "remarks": "QuantizedKernelParityRunner.CompareAgainstReference implements this contract: Compares two output vectors with an absolute tolerance. It evaluates reference, actual, and tolerance before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "reference": "The reference sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "actual": "The actual sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "tolerance": "The numeric tolerance consumed by CompareAgainstReference; it must satisfy the member's documented range, geometry, and finite-value requirements." }, "returns": "The QuantizedKernelParityReport result produced by QuantizedKernelParityRunner.CompareAgainstReference for this contract: Compares two output vectors with an absolute tolerance. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "ReferenceCpuKernels", "full_name": "UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides scalar and portable CPU reference kernels for correctness anchoring.", "remarks": "", "members": [ { "kind": "method", "name": "ApplyRope(System.Span,int,float)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.ApplyRope(System.Span{System.Single},System.Int32,System.Single)", "summary": "Applies RoPE rotation using generated trigonometric tables for the supplied position.", "remarks": "ReferenceCpuKernels.ApplyRope implements this contract: Applies RoPE rotation using generated trigonometric tables for the supplied position. It evaluates vector, position, and theta before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "theta": "The rotary angle in radians applied to the paired vector components at the addressed position." }, "returns": "" }, { "kind": "method", "name": "ApplyRopeInPlace(System.Span,System.ReadOnlySpan,System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.ApplyRopeInPlace(System.Span{System.Single},System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Int32)", "summary": "Applies RoPE rotation to one query or key vector in place using precomputed sine and cosine values.", "remarks": "ReferenceCpuKernels.ApplyRopeInPlace implements this contract: Applies RoPE rotation to one query or key vector in place using precomputed sine and cosine values. It evaluates vector, cos, sin, and ropeDimensions before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "cos": "The cos sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "sin": "The sin sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "ropeDimensions": "The even number of leading head dimensions transformed by rotary positional encoding." }, "returns": "" }, { "kind": "method", "name": "MatVec(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.MatVec(System.ReadOnlySpan{System.Single},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a matrix-vector product for row-major float32 weights.", "remarks": "ReferenceCpuKernels.MatVec implements this contract: Computes a matrix-vector product for row-major float32 weights. It evaluates matrix, rowCount, columnCount, vector, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "RmsNorm(System.ReadOnlySpan,System.ReadOnlySpan,System.Span,float)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.RmsNorm(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Single)", "summary": "Applies RMS normalization using the shared vector math implementation.", "remarks": "ReferenceCpuKernels.RmsNorm implements this contract: Applies RMS normalization using the shared vector math implementation. It evaluates input, weight, output, and epsilon before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "input": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "weight": "The weight sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "epsilon": "The positive normalization epsilon added to the mean-square term to avoid division by zero while preserving deterministic numerical behavior." }, "returns": "" }, { "kind": "method", "name": "Softmax(System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.Softmax(System.Span{System.Single})", "summary": "Computes softmax probabilities for the supplied values using numerically stable normalization.", "remarks": "ReferenceCpuKernels.Softmax implements this contract: Computes softmax probabilities for the supplied values using numerically stable normalization. It evaluates values before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" }, { "kind": "method", "name": "SoftmaxInPlace(System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceCpuKernels.SoftmaxInPlace(System.Span{System.Single})", "summary": "Computes softmax probabilities for the in place using numerically stable normalization.", "remarks": "ReferenceCpuKernels.SoftmaxInPlace implements this contract: Computes softmax probabilities for the in place using numerically stable normalization. It evaluates values before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "ReferenceMatrixRowDispatcher", "full_name": "UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixRowDispatcher", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Dispatches correctness-first matrix-vector operations for supported mapped scalar and quantized rows.", "remarks": "", "members": [ { "kind": "method", "name": "Describe(UAIX.LmRuntime.Tensors.GgmlTensorType,int,int)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixRowDispatcher.Describe(UAIX.LmRuntime.Tensors.GgmlTensorType,System.Int32,System.Int32)", "summary": "Computes the exact storage byte count for a supported matrix.", "remarks": "ReferenceMatrixRowDispatcher.Describe implements this contract: Computes the exact storage byte count for a supported matrix. It evaluates type, rowCount, and columnCount before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The ReferenceMatrixStorageDescriptor result produced by ReferenceMatrixRowDispatcher.Describe for this contract: Computes the exact storage byte count for a supported matrix. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "MatVec(UAIX.LmRuntime.Tensors.GgmlTensorType,System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixRowDispatcher.MatVec(UAIX.LmRuntime.Tensors.GgmlTensorType,System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes a little-endian matrix-vector product without materializing a complete dequantized matrix.", "remarks": "ReferenceMatrixRowDispatcher.MatVec implements this contract: Computes a little-endian matrix-vector product without materializing a complete dequantized matrix. It evaluates type, matrix, rowCount, columnCount, activations, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "type": "The declared GGML tensor or metadata type used to select the corresponding decoding and validation rules.", "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "activations": "The activations sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "ReferenceMatrixStorageDescriptor", "full_name": "UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixStorageDescriptor", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Describes one supported scalar matrix storage layout.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixStorageDescriptor.ColumnCount", "summary": "Gets the logical column count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgmlType", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixStorageDescriptor.GgmlType", "summary": "Gets the GGML tensor type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequiredByteCount", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixStorageDescriptor.RequiredByteCount", "summary": "Gets the exact required storage byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Kernels.Cpu.ReferenceMatrixStorageDescriptor.RowCount", "summary": "Gets the logical row count.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Scalar16CpuKernels", "full_name": "UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels", "namespace": "UAIX.LmRuntime.Kernels.Cpu", "summary": "Provides correctness-first scalar F16 and BF16 decoding and matrix-vector kernels.", "remarks": "", "members": [ { "kind": "method", "name": "CopyBFloat16(System.ReadOnlySpan,System.Span,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.CopyBFloat16(System.ReadOnlySpan{System.Byte},System.Span{System.Single},System.Boolean)", "summary": "Copies BF16 values into a caller-owned float32 destination.", "remarks": "Scalar16CpuKernels.CopyBFloat16 implements this contract: Copies BF16 values into a caller-owned float32 destination. It evaluates source, destination, and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "source": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "destination": "The destination with one element per BF16 value.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "" }, { "kind": "method", "name": "CopyFloat16(System.ReadOnlySpan,System.Span,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.CopyFloat16(System.ReadOnlySpan{System.Byte},System.Span{System.Single},System.Boolean)", "summary": "Copies F16 values into a caller-owned float32 destination.", "remarks": "Scalar16CpuKernels.CopyFloat16 implements this contract: Copies F16 values into a caller-owned float32 destination. It evaluates source, destination, and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "source": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "destination": "The destination with one element per F16 value.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "" }, { "kind": "method", "name": "DecodeBFloat16(System.ReadOnlySpan,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.DecodeBFloat16(System.ReadOnlySpan{System.Byte},System.Boolean)", "summary": "Decodes one bfloat16 value with explicit byte order.", "remarks": "Scalar16CpuKernels.DecodeBFloat16 implements this contract: Decodes one bfloat16 value with explicit byte order. It evaluates bytes and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "The float value computed by Scalar16CpuKernels.DecodeBFloat16 for this contract: Decodes one bfloat16 value with explicit byte order. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DecodeBFloat16(System.ReadOnlySpan,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.DecodeBFloat16(System.ReadOnlySpan{System.Byte},System.Boolean,System.Boolean)", "summary": "Decodes one bfloat16 value with explicit byte order and non-finite policy.", "remarks": "Scalar16CpuKernels.DecodeBFloat16 implements this contract: Decodes one bfloat16 value with explicit byte order and non-finite policy. It evaluates bytes, bigEndian, and rejectNonFinite before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact.", "rejectNonFinite": "Whether NaN and infinity are rejected as invalid model weights." }, "returns": "The float value computed by Scalar16CpuKernels.DecodeBFloat16 for this contract: Decodes one bfloat16 value with explicit byte order and non-finite policy. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DecodeFloat16(System.ReadOnlySpan,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.DecodeFloat16(System.ReadOnlySpan{System.Byte},System.Boolean)", "summary": "Decodes one IEEE binary16 value with explicit byte order.", "remarks": "Scalar16CpuKernels.DecodeFloat16 implements this contract: Decodes one IEEE binary16 value with explicit byte order. It evaluates bytes and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "The float value computed by Scalar16CpuKernels.DecodeFloat16 for this contract: Decodes one IEEE binary16 value with explicit byte order. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "DecodeFloat16(System.ReadOnlySpan,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.DecodeFloat16(System.ReadOnlySpan{System.Byte},System.Boolean,System.Boolean)", "summary": "Decodes one IEEE binary16 value with explicit byte order and non-finite policy.", "remarks": "Scalar16CpuKernels.DecodeFloat16 implements this contract: Decodes one IEEE binary16 value with explicit byte order and non-finite policy. It evaluates bytes, bigEndian, and rejectNonFinite before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact.", "rejectNonFinite": "Whether NaN and infinity are rejected as invalid model weights." }, "returns": "The float value computed by Scalar16CpuKernels.DecodeFloat16 for this contract: Decodes one IEEE binary16 value with explicit byte order and non-finite policy. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "MatVecBFloat16(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.MatVecBFloat16(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Boolean)", "summary": "Computes a row-major BF16 matrix-vector product without whole-matrix conversion.", "remarks": "Scalar16CpuKernels.MatVecBFloat16 implements this contract: Computes a row-major BF16 matrix-vector product without whole-matrix conversion. It evaluates matrix, rowCount, columnCount, vector, output, and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "" }, { "kind": "method", "name": "MatVecFloat16(System.ReadOnlySpan,int,int,System.ReadOnlySpan,System.Span,bool)", "xml_id": "M:UAIX.LmRuntime.Kernels.Cpu.Scalar16CpuKernels.MatVecFloat16(System.ReadOnlySpan{System.Byte},System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Boolean)", "summary": "Computes a row-major F16 matrix-vector product without whole-matrix conversion.", "remarks": "Scalar16CpuKernels.MatVecFloat16 implements this contract: Computes a row-major F16 matrix-vector product without whole-matrix conversion. It evaluates matrix, rowCount, columnCount, vector, output, and bigEndian before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "matrix": "The matrix sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range.", "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "bigEndian": "True to decode source bytes in big-endian order; false to decode the little-endian representation used by the local GGUF artifact." }, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Tokenization", "types": [ { "name": "BpeMergeRule", "full_name": "UAIX.LmRuntime.Tokenization.BpeMergeRule", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents one parsed BPE merge rule.", "remarks": "", "members": [ { "kind": "property", "name": "Left", "xml_id": "P:UAIX.LmRuntime.Tokenization.BpeMergeRule.Left", "summary": "Gets the left symbol.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Right", "xml_id": "P:UAIX.LmRuntime.Tokenization.BpeMergeRule.Right", "summary": "Gets the right symbol.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "TryParse(string,UAIX.LmRuntime.Tokenization.BpeMergeRule@)", "xml_id": "M:UAIX.LmRuntime.Tokenization.BpeMergeRule.TryParse(System.String,UAIX.LmRuntime.Tokenization.BpeMergeRule@)", "summary": "Attempts to parse the Boolean result while reporting invalid input without a successful result.", "remarks": "BpeMergeRule.TryParse implements this contract: Attempts to parse the Boolean result while reporting invalid input without a successful result. It evaluates text and rule before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "rule": "When the method returns, contains the rule produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when the rule contains two non-empty symbols." } ] }, { "name": "ChatTemplateConformanceSuite", "full_name": "UAIX.LmRuntime.Tokenization.ChatTemplateConformanceSuite", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Runs chat-template conformance checks against rendered message sequences.", "remarks": "", "members": [ { "kind": "method", "name": "RenderAndValidate(string,System.Collections.Generic.IReadOnlyList)", "xml_id": "M:UAIX.LmRuntime.Tokenization.ChatTemplateConformanceSuite.RenderAndValidate(System.String,System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Renders and validates a chat template against a message sequence.", "remarks": "ChatTemplateConformanceSuite.RenderAndValidate implements this contract: Renders and validates a chat template against a message sequence. It evaluates template and messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "template": "The template text. The current safe subset ignores arbitrary code.", "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenizerParityReport result produced by ChatTemplateConformanceSuite.RenderAndValidate for this contract: Renders and validates a chat template against a message sequence. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "ChatTemplateRenderer", "full_name": "UAIX.LmRuntime.Tokenization.ChatTemplateRenderer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Renders a minimal safe chat template suitable for deterministic tests and initial GGUF tokenizer work.", "remarks": "", "members": [ { "kind": "method", "name": "Render(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.ChatTemplateRenderer.Render(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Renders messages using a small role/content template rather than a general Jinja interpreter.", "remarks": "ChatTemplateRenderer.Render implements this contract: Renders messages using a small role/content template rather than a general Jinja interpreter. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The text produced by ChatTemplateRenderer.Render for this contract: Renders messages using a small role/content template rather than a general Jinja interpreter. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "DetokenizationOptions", "full_name": "UAIX.LmRuntime.Tokenization.DetokenizationOptions", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Describes detokenization behavior for one decode operation.", "remarks": "", "members": [ { "kind": "property", "name": "CleanSpaces", "xml_id": "P:UAIX.LmRuntime.Tokenization.DetokenizationOptions.CleanSpaces", "summary": "Gets whether tokenizer-specific space cleanup should be applied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RemoveSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.DetokenizationOptions.RemoveSpecialTokens", "summary": "Gets whether special tokens should be removed from decoded text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnparseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.DetokenizationOptions.UnparseSpecialTokens", "summary": "Gets whether special tokens should be emitted as their raw token text.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufPreTokenizerRegistry", "full_name": "UAIX.LmRuntime.Tokenization.GgufPreTokenizerRegistry", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Provides a conservative allow-list for tokenizer.ggml.pre values implemented by this build.", "remarks": "", "members": [ { "kind": "method", "name": "GetSupportedNames", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufPreTokenizerRegistry.GetSupportedNames", "summary": "Retrieves the supported names from the configured tokenizer after validating the requested access.", "remarks": "GgufPreTokenizerRegistry.GetSupportedNames implements this contract: Retrieves the supported names from the configured tokenizer after validating the requested access. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "An ordered read-only IReadOnlyList result from GgufPreTokenizerRegistry.GetSupportedNames: Retrieves the supported names from the configured tokenizer after validating the requested access. Mutable internal collection aliases are not exposed through the returned contract." }, { "kind": "method", "name": "IsSupported(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufPreTokenizerRegistry.IsSupported(System.String)", "summary": "Determines whether a pre-tokenizer identifier is supported.", "remarks": "GgufPreTokenizerRegistry.IsSupported implements this contract: Determines whether a pre-tokenizer identifier is supported. It evaluates name before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "name": "The exact ordinal name used for catalog lookup, canonical hashing, or diagnostic labeling as defined by the containing member." }, "returns": "True when the identifier is absent or explicitly supported." } ] }, { "name": "GgufSpecialTokenMap", "full_name": "UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents special token identifiers resolved from GGUF metadata.", "remarks": "", "members": [ { "kind": "property", "name": "BosTokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.BosTokenId", "summary": "Gets the beginning-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EosTokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.EosTokenId", "summary": "Gets the end-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PaddingTokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.PaddingTokenId", "summary": "Gets the padding token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SeparatorTokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.SeparatorTokenId", "summary": "Gets the separator token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnknownTokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.UnknownTokenId", "summary": "Gets the unknown token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "EnumerateKnownTokenIds", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufSpecialTokenMap.EnumerateKnownTokenIds", "summary": "Enumerates the known token identifiers in stable source order without exposing mutable internal storage.", "remarks": "GgufSpecialTokenMap.EnumerateKnownTokenIds implements this contract: Enumerates the known token identifiers in stable source order without exposing mutable internal storage. It evaluates its explicitly owned state before publishing state or a return value. Enumeration preserves source order and exposes only values that have passed the member-level validation contract.", "parameters": {}, "returns": "An ordered sequence containing the known token identifiers as produced by the validated operation." } ] }, { "name": "GgufToken", "full_name": "UAIX.LmRuntime.Tokenization.GgufToken", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents one GGUF vocabulary token.", "remarks": "", "members": [ { "kind": "property", "name": "Score", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufToken.Score", "summary": "Gets the tokenizer score associated with the token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Text", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufToken.Text", "summary": "Gets the raw token text from the GGUF vocabulary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufToken.TokenId", "summary": "Gets the token identifier used by model embedding rows.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Type", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufToken.Type", "summary": "Gets the token type associated with the token.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufTokenizerEngineFactory", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerEngineFactory", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Selects a concrete tokenizer engine from validated GGUF tokenizer metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerEngineFactory.Create(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Creates the GGUF tokenizer engine from the validated inputs required by GgufTokenizerEngineFactory.", "remarks": "GgufTokenizerEngineFactory.Create implements this contract: Creates the GGUF tokenizer engine from the validated inputs required by GgufTokenizerEngineFactory. It evaluates metadata before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "The concrete tokenizer engine, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "GgufTokenizerFactory", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerFactory", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Creates strict, metadata-routed tokenizers for parsed GGUF artifacts.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerFactory.Create(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Creates the tokenizer from the validated inputs required by GgufTokenizerFactory.", "remarks": "GgufTokenizerFactory.Create implements this contract: Creates the tokenizer from the validated inputs required by GgufTokenizerFactory. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The ITokenizer result produced by GgufTokenizerFactory.Create for this contract: Creates the tokenizer from the validated inputs required by GgufTokenizerFactory. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "CreateStrict(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerFactory.CreateStrict(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Creates a tokenizer after strict GGUF tokenizer metadata validation.", "remarks": "GgufTokenizerFactory.CreateStrict implements this contract: Creates a tokenizer after strict GGUF tokenizer metadata validation. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The selected tokenizer, with ownership and disposal obligations defined by the returned type and the CreateStrict contract." } ] }, { "name": "GgufTokenizerFingerprint", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerFingerprint", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Computes a deterministic SHA-256 identity for model-facing GGUF tokenizer metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerFingerprint.Create(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Computes a canonical tokenizer fingerprint without treating decoded text as token-ID authority.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Returned or retained collections are snapshotted where stable ownership is required; count and range checks precede size-dependent allocation.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "The text produced by GgufTokenizerFingerprint.Create for this contract: Computes a canonical tokenizer fingerprint without treating decoded text as token-ID authority. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "GgufTokenizerMetadata", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Captures tokenizer metadata loaded from a GGUF model.", "remarks": "", "members": [ { "kind": "property", "name": "AddBos", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.AddBos", "summary": "Gets whether model-defined BOS insertion is enabled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AddedTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.AddedTokens", "summary": "Gets the added tokens from GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AddEos", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.AddEos", "summary": "Gets whether model-defined EOS insertion is enabled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AddSeparator", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.AddSeparator", "summary": "Gets whether model-defined separator insertion is enabled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AddSpacePrefix", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.AddSpacePrefix", "summary": "Gets whether a leading space prefix is added before text fragments.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ChatTemplate", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.ChatTemplate", "summary": "Gets the chat template from GGUF metadata, when present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CleanSpaces", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.CleanSpaces", "summary": "Gets whether detokenization should clean spaces around punctuation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EscapeWhitespaces", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.EscapeWhitespaces", "summary": "Gets whether whitespace characters are escaped using SentencePiece whitespace notation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HuggingFaceTokenizerJson", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.HuggingFaceTokenizerJson", "summary": "Gets the embedded Hugging Face tokenizer JSON, when present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Merges", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.Merges", "summary": "Gets the BPE merge rules from GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PrecompiledCharsMap", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.PrecompiledCharsMap", "summary": "Gets the optional precompiled SentencePiece normalization character map.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreTokenizer", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.PreTokenizer", "summary": "Gets the tokenizer pre-tokenizer name, when present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RemoveExtraWhitespaces", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.RemoveExtraWhitespaces", "summary": "Gets whether tokenizer-specific extra whitespace removal is enabled.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ScoresPresent", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.ScoresPresent", "summary": "Gets a value indicating whether tokenizer.ggml.scores was present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SourceScoreCount", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.SourceScoreCount", "summary": "Gets the source score-array length, or zero when the metadata key was absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SourceTokenTypeCount", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.SourceTokenTypeCount", "summary": "Gets the source token-type-array length, or zero when the metadata key was absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.SpecialTokens", "summary": "Gets the special token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerModel", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.TokenizerModel", "summary": "Gets the tokenizer model name from GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.Tokens", "summary": "Gets the vocabulary tokens indexed by token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenTypesPresent", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.TokenTypesPresent", "summary": "Gets a value indicating whether tokenizer.ggml.token_type was present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VocabularySize", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata.VocabularySize", "summary": "Gets the effective vocabulary size from the token array.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufTokenizerMetadataReader", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataReader", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Builds tokenizer metadata from a parsed GGUF artifact.", "remarks": "", "members": [ { "kind": "method", "name": "Read(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataReader.Read(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Reads tokenizer metadata without throwing for validation failures.", "remarks": "GgufTokenizerMetadataReader.Read implements this contract: Reads tokenizer metadata without throwing for validation failures. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The GgufTokenizerMetadata result produced by GgufTokenizerMetadataReader.Read for this contract: Reads tokenizer metadata without throwing for validation failures. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "ReadStrict(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataReader.ReadStrict(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Reads tokenizer metadata and throws when validation fails.", "remarks": "GgufTokenizerMetadataReader.ReadStrict implements this contract: Reads tokenizer metadata and throws when validation fails. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The GgufTokenizerMetadata result produced by GgufTokenizerMetadataReader.ReadStrict for this contract: Reads tokenizer metadata and throws when validation fails. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufTokenizerMetadataValidationResult", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataValidationResult", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents tokenizer metadata validation output.", "remarks": "", "members": [ { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataValidationResult.Diagnostics", "summary": "Gets validation diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsValid", "xml_id": "P:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataValidationResult.IsValid", "summary": "Gets a value indicating whether no diagnostics were emitted.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GgufTokenizerMetadataValidator", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataValidator", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Validates GGUF tokenizer metadata before runtime use.", "remarks": "", "members": [ { "kind": "method", "name": "Validate(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.GgufTokenizerMetadataValidator.Validate(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Validates the supplied metadata against the invariants required by GgufTokenizerMetadataValidator.", "remarks": "GgufTokenizerMetadataValidator.Validate implements this contract: Validates the supplied metadata against the invariants required by GgufTokenizerMetadataValidator. It evaluates metadata before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "The GgufTokenizerMetadataValidationResult result produced by GgufTokenizerMetadataValidator.Validate for this contract: Validates the supplied metadata against the invariants required by GgufTokenizerMetadataValidator. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "GgufTokenType", "full_name": "UAIX.LmRuntime.Tokenization.GgufTokenType", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Identifies the tokenizer token type stored in GGUF metadata.", "remarks": "", "members": [ { "kind": "field", "name": "Byte", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.Byte", "summary": "Byte-fallback token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Control", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.Control", "summary": "Control token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Normal", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.Normal", "summary": "Normal token text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unknown", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.Unknown", "summary": "Unknown token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Unused", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.Unused", "summary": "Unused token slot.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UserDefined", "xml_id": "F:UAIX.LmRuntime.Tokenization.GgufTokenType.UserDefined", "summary": "User-defined token.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "Gpt2BpeTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Executes the GPT-2 byte-level BPE tokenizer path from GGUF vocabulary and merge metadata.", "remarks": "", "members": [ { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Metadata", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.CountTokens(System.String)", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "Gpt2BpeTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "The int value computed by Gpt2BpeTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "Gpt2BpeTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by Gpt2BpeTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "Gpt2BpeTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "Gpt2BpeTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "Gpt2BpeTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text, addBos, and addEos before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Encode(string,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Encode(System.String,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "Gpt2BpeTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "options": "The optional TokenizationOptions controlling Encode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The TokenizationResult result produced by Gpt2BpeTokenizer.Encode for this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Gpt2BpeTokenizer(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Initializes the tokenizer from validated GGUF metadata.", "remarks": "Construction validates and records the supplied metadata before the Gpt2BpeTokenizer instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "" }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "Gpt2BpeTokenizer.Tokenize implements this contract: Tokenizes the supplied text with the configured metadata and preserves deterministic token order. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] }, { "name": "Gpt2BpeTokenizerEngine", "full_name": "UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizerEngine", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Implements GPT-2 byte-level BPE from GGUF vocabulary and merge metadata.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizerEngine.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizerEngine.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "Gpt2BpeTokenizerEngine.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "EncodeRaw(string,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList,System.Collections.Generic.IList)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizerEngine.EncodeRaw(System.String,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String})", "summary": "Encodes the raw with the configured tokenizer and validated special-token policy.", "remarks": "Pretokenized pieces are encoded directly for the current call and are never inserted into shared or engine-lifetime state. When tracing is enabled, each event contains only the tokenizer family and emitted token identifier; raw prompt fragments and token text are deliberately omitted. Destination ordering follows the regex match order and the BPE result order for each match.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "context": "The context that supplies session-scoped identity and boundary state; it is validated before dependent work begins.", "destination": "The destination buffer that receives the produced values.", "trace": "The trace sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" }, { "kind": "method", "name": "Gpt2BpeTokenizerEngine(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.Gpt2BpeTokenizerEngine.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Initializes a GPT-2 BPE engine from validated GGUF tokenizer metadata.", "remarks": "Construction validates and snapshots the supplied vocabulary, merge ranks, and byte-token mappings before the engine becomes observable. The engine retains model metadata only: it does not create an engine-lifetime cache keyed by caller text, so prompt fragments are released with the encode operation rather than retained across requests or sessions.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "" } ] }, { "name": "HuggingFaceTokenizerJsonAdapter", "full_name": "UAIX.LmRuntime.Tokenization.HuggingFaceTokenizerJsonAdapter", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Provides an optional seam for embedded Hugging Face tokenizer JSON metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Create(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.HuggingFaceTokenizerJsonAdapter.Create(System.String)", "summary": "Creates a tokenizer from embedded tokenizer JSON metadata when supported.", "remarks": "The supplied JSON is parsed into a bounded document before adapter selection so malformed input fails closed. No embedded Hugging Face adapter is currently registered; this operation therefore does not retain the JSON text, publish a whitespace fallback, perform file access, or contact a provider.", "parameters": { "json": "The json text consumed by HuggingFaceTokenizerJsonAdapter.Create; null, emptiness, length, encoding, identifier, or path rules are enforced as documented, and the value is not persisted by this operation." }, "returns": "A tokenizer instance, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "IGgufTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.IGgufTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Encodes and decodes text for a GGUF-backed model.", "remarks": "", "members": [ { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Tokenization.IGgufTokenizer.Metadata", "summary": "Gets the tokenizer metadata used by this tokenizer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.IGgufTokenizer.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "Implementations of IGgufTokenizer validate the supplied token identifiers and the supplied options before completing Decode and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.IGgufTokenizer.Encode(System.String,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "Implementations of IGgufTokenizer validate the supplied text and the supplied options before completing Encode and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "options": "The optional TokenizationOptions controlling Encode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The TokenizationResult result produced by IGgufTokenizer.Encode for this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "IGgufTokenizerEngine", "full_name": "UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Defines a family-specific tokenizer engine that operates after special-token partitioning.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine.Name", "summary": "Gets the stable engine name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "Implementations of IGgufTokenizerEngine validate the supplied token identifiers and the supplied options before completing Decode and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "EncodeRaw(string,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList,System.Collections.Generic.IList)", "xml_id": "M:UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine.EncodeRaw(System.String,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String})", "summary": "Encodes a raw-text fragment into model token identifiers.", "remarks": "Implementations of IGgufTokenizerEngine validate the supplied text, the supplied context, the supplied destination, and the supplied trace before completing EncodeRaw and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "context": "The context that supplies session-scoped identity and boundary state; it is validated before dependent work begins.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "trace": "The trace sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "IGgufTokenizerFactory", "full_name": "UAIX.LmRuntime.Tokenization.IGgufTokenizerFactory", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Creates tokenizer instances from GGUF tokenizer metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Tokenization.IGgufTokenizerFactory.Create(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Creates a tokenizer for a parsed GGUF model.", "remarks": "Implementations of IGgufTokenizerFactory validate the supplied model before completing Create and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The tokenizer selected from metadata, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "InvalidGgufTokenizerException", "full_name": "UAIX.LmRuntime.Tokenization.InvalidGgufTokenizerException", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Thrown when GGUF tokenizer metadata is invalid.", "remarks": "", "members": [ { "kind": "method", "name": "InvalidGgufTokenizerException(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.InvalidGgufTokenizerException.#ctor(System.String)", "summary": "Initializes a new InvalidGgufTokenizerException instance with validated dependencies and operational bounds.", "remarks": "InvalidGgufTokenizerException.InvalidGgufTokenizerException establishes the invariants required by this contract: Initializes a new InvalidGgufTokenizerException instance with validated dependencies and operational bounds. It evaluates message before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "message": "The display-safe diagnostic message describing the failure without embedding prompt text, generated text, credentials, or private file contents." }, "returns": "" } ] }, { "name": "InvalidUtf16Policy", "full_name": "UAIX.LmRuntime.Tokenization.InvalidUtf16Policy", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Defines how tokenizer entry points handle invalid UTF-16 surrogate sequences.", "remarks": "", "members": [ { "kind": "field", "name": "Reject", "xml_id": "F:UAIX.LmRuntime.Tokenization.InvalidUtf16Policy.Reject", "summary": "Rejects invalid UTF-16 before tokenizer-specific normalization or segmentation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Replace", "xml_id": "F:UAIX.LmRuntime.Tokenization.InvalidUtf16Policy.Replace", "summary": "Replaces each invalid surrogate code unit with the Unicode replacement character.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MetadataDrivenGgufTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Executes a GGUF tokenizer by combining special-token partitioning with a family-specific tokenizer engine.", "remarks": "Real GGUF execution never falls back to whitespace tokenization. Unsupported tokenizer families fail during construction so token identifiers cannot silently diverge from the model embedding table.", "members": [ { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Metadata", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.CountTokens(System.String)", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "MetadataDrivenGgufTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "The int value computed by MetadataDrivenGgufTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "MetadataDrivenGgufTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by MetadataDrivenGgufTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "MetadataDrivenGgufTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "MetadataDrivenGgufTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions)", "summary": "Decodes model token identifiers using the stable metadata-driven compatibility options contract.", "remarks": "The compatibility options are projected to canonical tokenizer options without persistence, network access, subprocess execution, or shared mutable state.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional MetadataDrivenGgufTokenizerDetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "MetadataDrivenGgufTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text, addBos, and addEos before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Encode(string,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Encode(System.String,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "Input is validated and normalized before partitioning, then token identifiers are appended in fragment order. When parity tracing is requested, trace entries expose only bounded operation labels, token identifiers, and structural indexes. Raw input fragments, parsed special-token text, decoded text, and byte values are omitted so diagnostics do not duplicate caller content.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "options": "The optional TokenizationOptions controlling Encode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The TokenizationResult result produced by MetadataDrivenGgufTokenizer.Encode for this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "MetadataDrivenGgufTokenizer(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Initializes a tokenizer from validated GGUF metadata.", "remarks": "MetadataDrivenGgufTokenizer.MetadataDrivenGgufTokenizer establishes the invariants required by this contract: Initializes a tokenizer from validated GGUF metadata. It evaluates metadata before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "" }, { "kind": "method", "name": "MetadataDrivenGgufTokenizer(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata,UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata,UAIX.LmRuntime.Tokenization.IGgufTokenizerEngine)", "summary": "Initializes a tokenizer with an explicitly selected family engine.", "remarks": "Construction validates and records the supplied metadata and the supplied engine before the MetadataDrivenGgufTokenizer instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation.", "engine": "The validated IGgufTokenizerEngine dependency consumed by MetadataDrivenGgufTokenizer; ownership and lifetime remain with the caller unless this member explicitly documents a transfer." }, "returns": "" }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "MetadataDrivenGgufTokenizer.Tokenize implements this contract: Tokenizes the supplied text with the configured metadata and preserves deterministic token order. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] }, { "name": "MetadataDrivenGgufTokenizerDetokenizationOptions", "full_name": "UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Provides a stable LocalEndpoint-facing name for metadata-driven GGUF detokenization controls.", "remarks": "This compatibility type mirrors UAIX.LmRuntime.Tokenization.DetokenizationOptions without inheritance because the canonical options type is sealed. It allows integration code to use a descriptive contract while the tokenizer retains one canonical internal representation.", "members": [ { "kind": "property", "name": "CleanSpaces", "xml_id": "P:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions.CleanSpaces", "summary": "Gets whether tokenizer-specific space cleanup should be applied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RemoveSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions.RemoveSpecialTokens", "summary": "Gets whether special tokens should be removed from decoded text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnparseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions.UnparseSpecialTokens", "summary": "Gets whether special tokens should be emitted as their raw token text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ToDetokenizationOptions", "xml_id": "M:UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions.ToDetokenizationOptions", "summary": "Creates the canonical detokenization options consumed by the tokenizer engine.", "remarks": "A new value is returned on every call so application instances and sessions cannot share mutable options.", "parameters": {}, "returns": "A new canonical options instance with the same behavior flags." } ] }, { "name": "RwkvWorldTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Marks the RWKV tokenizer family as an explicit unsupported boundary until a dedicated engine is implemented.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.CountTokens(System.String)", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "RwkvWorldTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "The int value computed by RwkvWorldTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "RwkvWorldTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by RwkvWorldTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "RwkvWorldTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "RwkvWorldTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text, addBos, and addEos before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.RwkvWorldTokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "RwkvWorldTokenizer.Tokenize implements this contract: Tokenizes the supplied text with the configured metadata and preserves deterministic token order. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] }, { "name": "SentencePieceBpeTokenizerEngine", "full_name": "UAIX.LmRuntime.Tokenization.SentencePieceBpeTokenizerEngine", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Implements the SentencePiece-BPE execution path used by LLaMA-style GGUF vocabularies.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.SentencePieceBpeTokenizerEngine.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceBpeTokenizerEngine.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "SentencePieceBpeTokenizerEngine.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "EncodeRaw(string,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList,System.Collections.Generic.IList)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceBpeTokenizerEngine.EncodeRaw(System.String,UAIX.LmRuntime.Tokenization.TokenizerFragmentContext,System.Collections.Generic.IList{System.Int32},System.Collections.Generic.IList{System.String})", "summary": "Encodes the raw with the configured tokenizer and validated special-token policy.", "remarks": "Normalization, vocabulary merges, and fallback emission preserve the deterministic source order. Optional trace events contain operation labels, structural merge indexes, and token identifiers only; they never copy raw prompt symbols, token text, or UTF-8 byte values into diagnostics.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "context": "The context that supplies session-scoped identity and boundary state; it is validated before dependent work begins.", "destination": "The destination buffer that receives the produced values.", "trace": "The trace sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" }, { "kind": "method", "name": "SentencePieceBpeTokenizerEngine(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceBpeTokenizerEngine.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Initializes the engine from validated GGUF tokenizer metadata.", "remarks": "Construction validates and records the supplied metadata before the SentencePieceBpeTokenizerEngine instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "" } ] }, { "name": "SentencePieceGgufTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Executes the SentencePiece-BPE tokenizer path used by LLaMA-style GGUF artifacts.", "remarks": "", "members": [ { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Metadata", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.CountTokens(System.String)", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "SentencePieceGgufTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "The int value computed by SentencePieceGgufTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "SentencePieceGgufTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by SentencePieceGgufTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "SentencePieceGgufTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.DetokenizationOptions)", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "SentencePieceGgufTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order.", "options": "The optional DetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "SentencePieceGgufTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text, addBos, and addEos before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Encode(string,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Encode(System.String,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "SentencePieceGgufTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "options": "The optional TokenizationOptions controlling Encode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The TokenizationResult result produced by SentencePieceGgufTokenizer.Encode for this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "SentencePieceGgufTokenizer(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.#ctor(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Initializes the tokenizer from validated GGUF metadata.", "remarks": "Construction validates and records the supplied metadata before the SentencePieceGgufTokenizer instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "" }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SentencePieceGgufTokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "SentencePieceGgufTokenizer.Tokenize implements this contract: Tokenizes the supplied text with the configured metadata and preserves deterministic token order. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] }, { "name": "SpecialTokenFragment", "full_name": "UAIX.LmRuntime.Tokenization.SpecialTokenFragment", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents one fragment emitted by special-token partitioning.", "remarks": "", "members": [ { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Kind", "summary": "Gets the fragment kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Length", "summary": "Gets the fragment length in source text characters.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Offset", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Offset", "summary": "Gets the character offset in the source text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Text", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Text", "summary": "Gets the raw text fragment.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.TokenId", "summary": "Gets the token identifier for token fragments.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Raw(string,int)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Raw(System.String,System.Int32)", "summary": "Creates a raw-text fragment representing an unmodified source slice at the supplied offset.", "remarks": "The factory records the supplied text and its length without tokenization or normalization. The caller must provide an offset and text slice already validated against the partitioned source.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "offset": "The zero-based offset into the relevant source or destination; range validation occurs before access." }, "returns": "The SpecialTokenFragment result produced by SpecialTokenFragment.Raw for this contract: Creates a raw-text fragment representing an unmodified source slice at the supplied offset. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Token(int,string,int)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SpecialTokenFragment.Token(System.Int32,System.String,System.Int32)", "summary": "Creates a special-token fragment at the supplied source-text offset.", "remarks": "The fragment records the caller-supplied token identifier and text without performing vocabulary lookup. The caller must provide an offset and text slice already validated against the partitioned source.", "parameters": { "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "offset": "The zero-based offset into the relevant source or destination; range validation occurs before access." }, "returns": "The SpecialTokenFragment result produced by SpecialTokenFragment.Token for this contract: Creates a special-token fragment at the supplied source-text offset. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "SpecialTokenFragmentKind", "full_name": "UAIX.LmRuntime.Tokenization.SpecialTokenFragmentKind", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Identifies the type of fragment emitted by special-token partitioning.", "remarks": "", "members": [ { "kind": "field", "name": "RawText", "xml_id": "F:UAIX.LmRuntime.Tokenization.SpecialTokenFragmentKind.RawText", "summary": "A raw text fragment that must be processed by the tokenizer engine.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Token", "xml_id": "F:UAIX.LmRuntime.Tokenization.SpecialTokenFragmentKind.Token", "summary": "A pre-resolved token identifier fragment.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "SpecialTokenMap", "full_name": "UAIX.LmRuntime.Tokenization.SpecialTokenMap", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents model special-token identities.", "remarks": "", "members": [ { "kind": "property", "name": "BeginningOfSequence", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenMap.BeginningOfSequence", "summary": "Gets the beginning-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EndOfSequence", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenMap.EndOfSequence", "summary": "Gets the end-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Padding", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenMap.Padding", "summary": "Gets the padding token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Unknown", "xml_id": "P:UAIX.LmRuntime.Tokenization.SpecialTokenMap.Unknown", "summary": "Gets the unknown token identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "SpecialTokenPartitioner", "full_name": "UAIX.LmRuntime.Tokenization.SpecialTokenPartitioner", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Partitions raw text around tokenizer special tokens before normal tokenization.", "remarks": "", "members": [ { "kind": "method", "name": "Partition(string,UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.SpecialTokenPartitioner.Partition(System.String,UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata,System.Boolean)", "summary": "Partitions text around known special tokens using longest-token-first matching.", "remarks": "SpecialTokenPartitioner.Partition implements this contract: Partitions text around known special tokens using longest-token-first matching. It evaluates text, metadata, and parseSpecial before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "metadata": "The metadata containing validated format or tokenizer metadata required by this operation.", "parseSpecial": "Whether control and unknown tokens should be parsed as special tokens." }, "returns": "An ordered read-only IReadOnlyList result from SpecialTokenPartitioner.Partition: Partitions text around known special tokens using longest-token-first matching. Mutable internal collection aliases are not exposed through the returned contract." } ] }, { "name": "StreamingUtf8TokenDecoder", "full_name": "UAIX.LmRuntime.Tokenization.StreamingUtf8TokenDecoder", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Incrementally decodes byte-token payloads without corrupting UTF-8 sequences split across token boundaries.", "remarks": "", "members": [ { "kind": "method", "name": "Decode(System.ReadOnlySpan,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.StreamingUtf8TokenDecoder.Decode(System.ReadOnlySpan{System.Byte},System.Boolean)", "summary": "Decodes one byte fragment and retains incomplete UTF-8 state for the next call.", "remarks": "StreamingUtf8TokenDecoder.Decode implements this contract: Decodes one byte fragment and retains incomplete UTF-8 state for the next call. It evaluates bytes and flush before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "flush": "The flush flag selecting the documented branch of Decode; it does not grant authority beyond this in-memory operation." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.Tokenization.StreamingUtf8TokenDecoder.Reset", "summary": "Resets the requested state to its validated initial state without publishing partial state.", "remarks": "StreamingUtf8TokenDecoder.Reset implements this contract: Resets the requested state to its validated initial state without publishing partial state. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "" } ] }, { "name": "TokenBudgetTruncator", "full_name": "UAIX.LmRuntime.Tokenization.TokenBudgetTruncator", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Truncates message sequences by token budget.", "remarks": "", "members": [ { "kind": "method", "name": "TruncateMessages(System.Collections.Generic.IEnumerable,UAIX.LmRuntime.Abstractions.ITokenizer,int)", "xml_id": "M:UAIX.LmRuntime.Tokenization.TokenBudgetTruncator.TruncateMessages(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage},UAIX.LmRuntime.Abstractions.ITokenizer,System.Int32)", "summary": "Truncates messages so the total token count does not exceed the budget.", "remarks": "TokenBudgetTruncator.TruncateMessages implements this contract: Truncates messages so the total token count does not exceed the budget. It evaluates messages, tokenizer, and maxTokens before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "tokenizer": "The validated ITokenizer dependency consumed by TruncateMessages; ownership and lifetime remain with the caller unless this member explicitly documents a transfer.", "maxTokens": "The numeric max tokens consumed by TruncateMessages; it must satisfy the member's documented range, geometry, and finite-value requirements." }, "returns": "An ordered read-only IReadOnlyList result from TokenBudgetTruncator.TruncateMessages: Truncates messages so the total token count does not exceed the budget. Mutable internal collection aliases are not exposed through the returned contract." } ] }, { "name": "TokenizationOptions", "full_name": "UAIX.LmRuntime.Tokenization.TokenizationOptions", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Describes tokenization behavior for one encode operation.", "remarks": "", "members": [ { "kind": "property", "name": "AddSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.AddSpecialTokens", "summary": "Gets whether model-defined special tokens should be added.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EmitTrace", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.EmitTrace", "summary": "Gets whether content-minimized trace data should be emitted for parity diagnostics.", "remarks": "Trace entries contain bounded operation labels, token identifiers, and structural ordering indexes only. Implementations must not copy raw input text, token text, decoded text, or source byte values into trace entries. The trace remains caller-owned transient output and is not persisted by the tokenizer.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "InvalidUtf16Policy", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.InvalidUtf16Policy", "summary": "Gets the policy for invalid UTF-16 surrogate sequences.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OverrideAddBos", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.OverrideAddBos", "summary": "Gets an optional override for BOS insertion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OverrideAddEos", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.OverrideAddEos", "summary": "Gets an optional override for EOS insertion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationOptions.ParseSpecialTokens", "summary": "Gets whether raw special-token text should be parsed as special tokens.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TokenizationResult", "full_name": "UAIX.LmRuntime.Tokenization.TokenizationResult", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents the output of a tokenizer encode operation.", "remarks": "", "members": [ { "kind": "property", "name": "TokenIds", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationResult.TokenIds", "summary": "Gets the emitted token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Trace", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizationResult.Trace", "summary": "Gets optional content-minimized events used for tokenizer parity diagnostics.", "remarks": "Events preserve tokenizer operation order but contain no raw prompt fragments, token text, decoded text, or source byte values. Consumers must treat token identifiers as session data and must not infer persistence authority from the presence of this transient read-only collection.", "parameters": {}, "returns": "" } ] }, { "name": "TokenizerFragmentContext", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerFragmentContext", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Describes the position of one raw-text fragment within special-token partitioning.", "remarks": "", "members": [ { "kind": "property", "name": "IsFirstFragment", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerFragmentContext.IsFirstFragment", "summary": "Gets a value indicating whether this is the first raw-text fragment in the input.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreviousFragmentWasSpecial", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerFragmentContext.PreviousFragmentWasSpecial", "summary": "Gets a value indicating whether the immediately preceding fragment was a special token.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TokenizerGoldenCorpus", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerGoldenCorpus", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Loads tokenizer golden corpora.", "remarks": "", "members": [ { "kind": "method", "name": "Load(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.TokenizerGoldenCorpus.Load(System.String)", "summary": "Loads ordered tokenizer golden record collection from a verified local source into TokenizerGoldenCorpus.", "remarks": "TokenizerGoldenCorpus.Load implements this contract: Loads ordered tokenizer golden record collection from a verified local source into TokenizerGoldenCorpus. It evaluates json before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "json": "The json text consumed by TokenizerGoldenCorpus.Load; null, emptiness, length, encoding, identifier, or path rules are enforced as documented, and the value is not persisted by this operation." }, "returns": "An ordered read-only IReadOnlyList result from TokenizerGoldenCorpus.Load: Loads ordered tokenizer golden record collection from a verified local source into TokenizerGoldenCorpus. Mutable internal collection aliases are not exposed through the returned contract." } ] }, { "name": "TokenizerGoldenRecord", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerGoldenRecord", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents one tokenizer golden record.", "remarks": "", "members": [ { "kind": "property", "name": "ExpectedTokenIds", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerGoldenRecord.ExpectedTokenIds", "summary": "Gets expected token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Text", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerGoldenRecord.Text", "summary": "Gets the source text.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TokenizerParityReport", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerParityReport", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Represents tokenizer parity diagnostics.", "remarks": "", "members": [ { "kind": "property", "name": "Mismatches", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerParityReport.Mismatches", "summary": "Gets tokenizer mismatches.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TokenizerTextSafety", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerTextSafety", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Validates and normalizes managed strings before tokenizer-specific processing.", "remarks": "", "members": [ { "kind": "method", "name": "NormalizeUtf16(string,UAIX.LmRuntime.Tokenization.InvalidUtf16Policy)", "xml_id": "M:UAIX.LmRuntime.Tokenization.TokenizerTextSafety.NormalizeUtf16(System.String,UAIX.LmRuntime.Tokenization.InvalidUtf16Policy)", "summary": "Validates a managed string and optionally replaces unpaired surrogate code units.", "remarks": "TokenizerTextSafety.NormalizeUtf16 implements this contract: Validates a managed string and optionally replaces unpaired surrogate code units. It evaluates text and policy before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "policy": "The policy that define validation limits and execution behavior; required values are checked before use." }, "returns": "The original string when valid, or a normalized replacement string when requested." } ] }, { "name": "TokenizerVocabularyReconciler", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciler", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Reconciles embedded Hugging Face vocabulary identifiers against authoritative GGUF token-array order.", "remarks": "", "members": [ { "kind": "method", "name": "Reconcile(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "xml_id": "M:UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciler.Reconcile(UAIX.LmRuntime.Tokenization.GgufTokenizerMetadata)", "summary": "Validates embedded tokenizer JSON without allowing it to reorder GGUF token identifiers.", "remarks": "TokenizerVocabularyReconciler.Reconcile implements this contract: Validates embedded tokenizer JSON without allowing it to reorder GGUF token identifiers. It evaluates metadata before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "metadata": "The metadata containing validated format or tokenizer metadata required by this operation." }, "returns": "The TokenizerVocabularyReconciliationResult result produced by TokenizerVocabularyReconciler.Reconcile for this contract: Validates embedded tokenizer JSON without allowing it to reorder GGUF token identifiers. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "TokenizerVocabularyReconciliationResult", "full_name": "UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciliationResult", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Describes a consistency check between GGUF vocabulary order and embedded Hugging Face tokenizer JSON.", "remarks": "", "members": [ { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciliationResult.Diagnostics", "summary": "Gets bounded deterministic diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EmbeddedJsonPresent", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciliationResult.EmbeddedJsonPresent", "summary": "Gets whether embedded tokenizer JSON was present.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsConsistent", "xml_id": "P:UAIX.LmRuntime.Tokenization.TokenizerVocabularyReconciliationResult.IsConsistent", "summary": "Gets whether the embedded tokenizer JSON is absent or consistent with GGUF token identifiers.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "UnsupportedTokenizerException", "full_name": "UAIX.LmRuntime.Tokenization.UnsupportedTokenizerException", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Thrown when a GGUF tokenizer family is not supported.", "remarks": "", "members": [ { "kind": "method", "name": "UnsupportedTokenizerException(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.UnsupportedTokenizerException.#ctor(System.String)", "summary": "Initializes a new UnsupportedTokenizerException instance with validated dependencies and operational bounds.", "remarks": "UnsupportedTokenizerException.UnsupportedTokenizerException establishes the invariants required by this contract: Initializes a new UnsupportedTokenizerException instance with validated dependencies and operational bounds. It evaluates message before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "message": "The display-safe diagnostic message describing the failure without embedding prompt text, generated text, credentials, or private file contents." }, "returns": "" } ] }, { "name": "WhitespaceTokenizer", "full_name": "UAIX.LmRuntime.Tokenization.WhitespaceTokenizer", "namespace": "UAIX.LmRuntime.Tokenization", "summary": "Provides a deterministic tokenizer for tests, examples, and fallback token budgeting.", "remarks": "", "members": [ { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.Name", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CountTokens(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.CountTokens(System.String)", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "WhitespaceTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "The int value computed by WhitespaceTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. Range, finite-value, and overflow checks are completed before the value is returned." }, { "kind": "method", "name": "CountTokens(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.CountTokens(System.Collections.Generic.IEnumerable{UAIX.LmRuntime.Contracts.LlmMessage})", "summary": "Counts the tokens using the same deterministic rules as the corresponding processing operation.", "remarks": "WhitespaceTokenizer.CountTokens implements this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It evaluates messages before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "messages": "The messages sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "The TokenCountResult result produced by WhitespaceTokenizer.CountTokens for this contract: Counts the tokens using the same deterministic rules as the corresponding processing operation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IEnumerable)", "xml_id": "M:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.Decode(System.Collections.Generic.IEnumerable{System.Int32})", "summary": "Decodes the supplied token sequence with the configured tokenizer while preserving sequence order.", "remarks": "WhitespaceTokenizer.Decode implements this contract: Decodes the supplied token sequence with the configured tokenizer while preserving sequence order. It evaluates tokenIds before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "tokenIds": "The token identifiers to process in sequence order." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Encode(string,bool,bool)", "xml_id": "M:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.Encode(System.String,System.Boolean,System.Boolean)", "summary": "Encodes the supplied text with the configured tokenizer and validated special-token policy.", "remarks": "WhitespaceTokenizer.Encode implements this contract: Encodes the supplied text with the configured tokenizer and validated special-token policy. It evaluates text, addBos, and addEos before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules.", "addBos": "A value indicating whether add BOS applies to this operation.", "addEos": "A value indicating whether add EOS applies to this operation." }, "returns": "An ordered read-only collection of token identifiers produced by the configured tokenizer." }, { "kind": "method", "name": "Tokenize(string)", "xml_id": "M:UAIX.LmRuntime.Tokenization.WhitespaceTokenizer.Tokenize(System.String)", "summary": "Tokenizes the supplied text with the configured metadata and preserves deterministic token order.", "remarks": "WhitespaceTokenizer.Tokenize implements this contract: Tokenizes the supplied text with the configured metadata and preserves deterministic token order. It evaluates text before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "text": "The text to process using the configured encoding and normalization rules." }, "returns": "An ordered read-only collection of token text values produced by the configured tokenizer." } ] } ] }, { "id": "UAIX.LmRuntime.Models.Llama", "types": [ { "name": "ArrayLlamaLayerWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides one array-backed LLaMA layer weight source.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.AttentionKey", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.AttentionNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionOutput", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.AttentionOutput", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.AttentionQuery", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.AttentionValue", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardDown", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.FeedForwardDown", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.FeedForwardGate", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.FeedForwardNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardUp", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.FeedForwardUp", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ArrayLlamaLayerWeightSource(int,UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayLlamaLayerWeightSource.#ctor(System.Int32,UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Initializes a new ArrayLlamaLayerWeightSource instance with validated dependencies and operational bounds.", "remarks": "ArrayLlamaLayerWeightSource.ArrayLlamaLayerWeightSource establishes the invariants required by this contract: Initializes a new ArrayLlamaLayerWeightSource instance with validated dependencies and operational bounds. It evaluates blockIndex, weights, and config before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "blockIndex": "The zero-based block index; it must identify an existing position within the relevant validated range.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation.", "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "" } ] }, { "name": "ArrayLlamaModelWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Adapts the v1.8.0 float-array model to the storage-neutral v1.9.0 execution contracts.", "remarks": "", "members": [ { "kind": "property", "name": "Layers", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.Layers", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.ManagedCopiedByteCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.OutputNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.OutputProjection", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.StorageSummary", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.TokenEmbeddings", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesTiedOutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.UsesTiedOutputProjection", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ArrayLlamaModelWeightSource(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.#ctor(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights)", "summary": "Initializes a new ArrayLlamaModelWeightSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied config and the supplied weights before the ArrayLlamaModelWeightSource instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "" }, { "kind": "method", "name": "Create(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayLlamaModelWeightSource.Create(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights)", "summary": "Creates an array-backed source after validating its complete model contract.", "remarks": "ArrayLlamaModelWeightSource.Create implements this contract: Creates an array-backed source after validating its complete model contract. It evaluates config and weights before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "The array-backed source, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "ArrayMatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.ArrayMatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides an immutable row-major array-backed matrix adapter for compatibility and deterministic fixtures.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.TensorName", "summary": "Gets the semantic tensor name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ArrayMatrixSource(string,float[],int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.#ctor(System.String,System.Single[],System.Int32,System.Int32)", "summary": "Initializes a new ArrayMatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied tensor name, the supplied values, the supplied row count, and the supplied column count before the ArrayMatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "tensorName": "The exact ordinal GGUF tensor catalog name used for lookup and diagnostics.", "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "rowCount": "The row count used to bound this operation; it must be nonnegative and within the supported range.", "columnCount": "The column count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "ArrayMatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayMatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "ArrayMatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "ArrayVectorSource", "full_name": "UAIX.LmRuntime.Models.Llama.ArrayVectorSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides an immutable array-backed vector adapter for compatibility and deterministic fixtures.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.Length", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.TensorName", "summary": "Gets the semantic tensor name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ArrayVectorSource(string,float[])", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.#ctor(System.String,System.Single[])", "summary": "Initializes a new ArrayVectorSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied tensor name and the supplied values before the ArrayVectorSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "tensorName": "The exact ordinal GGUF tensor catalog name used for lookup and diagnostics.", "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ArrayVectorSource.CopyTo(System.Span{System.Single})", "summary": "Copies the to into caller-owned storage after validating the requested range and capacity.", "remarks": "ArrayVectorSource.CopyTo implements this contract: Copies the to into caller-owned storage after validating the requested range and capacity. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "destination": "The destination buffer that receives the produced values." }, "returns": "" } ] }, { "name": "FixtureDirectoryVerifier", "full_name": "UAIX.LmRuntime.Models.Llama.FixtureDirectoryVerifier", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Verifies fixture manifests, artifact paths, digests, and basic loadability without network access.", "remarks": "", "members": [ { "kind": "method", "name": "Verify(string)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.FixtureDirectoryVerifier.Verify(System.String)", "summary": "Verifies the supplied fixture directory and returns bounded evidence only after every required check succeeds.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Count and range checks precede size-dependent allocation; local I/O remains bounded to the source or destination supplied by the caller.", "parameters": { "fixtureDirectory": "The directory containing a fixture manifest and GGUF artifact." }, "returns": "The FixtureVerificationResult result produced by FixtureDirectoryVerifier.Verify for this contract: Verifies the supplied fixture directory and returns bounded evidence only after every required check succeeds. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "FixtureVerificationDiagnostic", "full_name": "UAIX.LmRuntime.Models.Llama.FixtureVerificationDiagnostic", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents one diagnostic emitted while verifying a checked-in GGUF fixture directory.", "remarks": "", "members": [ { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationDiagnostic.Code", "summary": "Gets the stable diagnostic code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationDiagnostic.Message", "summary": "Gets the diagnostic message.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "FixtureVerificationResult", "full_name": "UAIX.LmRuntime.Models.Llama.FixtureVerificationResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents the result of bounded, offline fixture directory verification.", "remarks": "", "members": [ { "kind": "property", "name": "ArtifactPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationResult.ArtifactPath", "summary": "Gets the normalized GGUF artifact path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ArtifactSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationResult.ArtifactSha256", "summary": "Gets the verified SHA-256 digest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationResult.Diagnostics", "summary": "Gets verification diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FixtureDirectory", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationResult.FixtureDirectory", "summary": "Gets the normalized fixture directory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsValid", "xml_id": "P:UAIX.LmRuntime.Models.Llama.FixtureVerificationResult.IsValid", "summary": "Gets whether no verification diagnostics were emitted.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "GroupedQueryAttentionMap", "full_name": "UAIX.LmRuntime.Models.Llama.GroupedQueryAttentionMap", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Maps query heads to grouped key/value heads.", "remarks": "", "members": [ { "kind": "method", "name": "MapHead(int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.GroupedQueryAttentionMap.MapHead(System.Int32,System.Int32,System.Int32)", "summary": "Maps an attention query head to the corresponding KV head.", "remarks": "GroupedQueryAttentionMap.MapHead implements this contract: Maps an attention query head to the corresponding KV head. It evaluates queryHead, queryHeadCount, and keyValueHeadCount before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "queryHead": "The zero-based query-head index mapped deterministically to its corresponding key/value head.", "queryHeadCount": "The query head count used to bound this operation; it must be nonnegative and within the supported range.", "keyValueHeadCount": "The key value head count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The int value computed by GroupedQueryAttentionMap.MapHead for this contract: Maps an attention query head to the corresponding KV head. Range, finite-value, and overflow checks are completed before the value is returned." } ] }, { "name": "ILlamaLayerWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes immutable weights required by one LLaMA transformer block.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.AttentionKey", "summary": "Gets the key projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.AttentionNorm", "summary": "Gets the attention normalization vector.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionOutput", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.AttentionOutput", "summary": "Gets the attention output projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.AttentionQuery", "summary": "Gets the query projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.AttentionValue", "summary": "Gets the value projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardDown", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.FeedForwardDown", "summary": "Gets the feed-forward down projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.FeedForwardGate", "summary": "Gets the feed-forward gate projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.FeedForwardNorm", "summary": "Gets the feed-forward normalization vector.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardUp", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaLayerWeightSource.FeedForwardUp", "summary": "Gets the feed-forward up projection matrix.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ILlamaModelWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes immutable model weights required by the deterministic LLaMA reference session.", "remarks": "", "members": [ { "kind": "property", "name": "Layers", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.Layers", "summary": "Gets transformer-block weights in execution order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.ManagedCopiedByteCount", "summary": "Gets persistent managed model-weight bytes represented by this source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.OutputNorm", "summary": "Gets the final output normalization vector.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.OutputProjection", "summary": "Gets the output projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.StorageDiagnostics", "summary": "Gets storage diagnostics for every distinct semantic source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.StorageSummary", "summary": "Gets a stable summary of physical storage types used by the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.TokenEmbeddings", "summary": "Gets the token embedding table.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesTiedOutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource.UsesTiedOutputProjection", "summary": "Gets a value indicating whether output projection aliases token embeddings.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ILlamaSession", "full_name": "UAIX.LmRuntime.Models.Llama.ILlamaSession", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Defines the lifecycle for a LLaMA-family inference session.", "remarks": "", "members": [ { "kind": "method", "name": "DecodeAsync(int,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ILlamaSession.DecodeAsync(System.Int32,System.Threading.CancellationToken)", "summary": "Decodes the next token for the active sequence.", "remarks": "Implementations of ILlamaSession validate the supplied token identifier and the supplied cancellation token before completing DecodeAsync and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "An asynchronous ValueTask that completes with the result of ILlamaSession.DecodeAsync: Decodes the next token for the active sequence. Fault and cancellation states are propagated without a successful partial result." } ] }, { "name": "IReadOnlyMatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes an immutable logical row-major matrix without requiring a particular storage representation.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.ColumnCount", "summary": "Gets the logical column count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.DataType", "summary": "Gets the logical runtime data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.RowCount", "summary": "Gets the logical row count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.StorageDiagnostics", "summary": "Gets immutable storage diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.StorageType", "summary": "Gets the physical GGML storage type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies and, when required, dequantizes one logical row into a caller-owned float32 destination.", "remarks": "Implementations of IReadOnlyMatrixSource validate the supplied row index and the supplied destination before completing CopyRowTo and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReadOnlyMatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies this matrix by a float32 vector without materializing a complete float32 matrix.", "remarks": "Implementations of IReadOnlyMatrixSource validate the supplied vector and the supplied output before completing Multiply and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "vector": "The input vector with at least ColumnCount values.", "output": "The output buffer with at least RowCount values." }, "returns": "" } ] }, { "name": "IReadOnlyVectorSource", "full_name": "UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes an immutable logical vector without requiring a particular storage representation.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource.DataType", "summary": "Gets the logical runtime data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource.Length", "summary": "Gets the logical vector length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource.StorageDiagnostics", "summary": "Gets immutable storage diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource.StorageType", "summary": "Gets the physical GGML storage type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReadOnlyVectorSource.CopyTo(System.Span{System.Single})", "summary": "Copies every vector value into a caller-owned float32 destination.", "remarks": "Implementations of IReadOnlyVectorSource validate the supplied destination before completing CopyTo and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "destination": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "IReferenceKvCache", "full_name": "UAIX.LmRuntime.Models.Llama.IReferenceKvCache", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Defines a typed, deterministic key/value cache contract for the scalar LLaMA reference runtime.", "remarks": "", "members": [ { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.ConfigurationFingerprint", "summary": "Gets the configuration fingerprint required by compatible snapshots.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.ContextLength", "summary": "Gets the maximum sequence capacity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HeadWidth", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.HeadWidth", "summary": "Gets the float width of one key/value head.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KeyValueHeadCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.KeyValueHeadCount", "summary": "Gets the number of key/value heads per layer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LayerCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.LayerCount", "summary": "Gets the number of transformer layers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsedTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.UsedTokenCount", "summary": "Gets the highest contiguous token position written plus one.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WriteBehavior", "xml_id": "P:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.WriteBehavior", "summary": "Gets the deterministic append-versus-overwrite behavior.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CreateSnapshot", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.CreateSnapshot", "summary": "Creates a bounded snapshot for tiny-fixture testing and replay.", "remarks": "Implementations of IReferenceKvCache validate the instance's existing state before completing CreateSnapshot and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": {}, "returns": "The immutable cache snapshot, with ownership and disposal obligations defined by the returned type and the CreateSnapshot contract." }, { "kind": "method", "name": "GetKey(int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.GetKey(System.Int32,System.Int32,System.Int32)", "summary": "Retrieves the key from the current cache state after validating the requested access.", "remarks": "Implementations of IReferenceKvCache validate the supplied layer index, the supplied position, and the supplied head index before completing GetKey and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "headIndex": "The zero-based head index; it must identify an existing position within the relevant validated range." }, "returns": "The bounded ReadOnlySpan view produced by IReferenceKvCache.GetKey: Retrieves the key from the current cache state after validating the requested access. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "GetValue(int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.GetValue(System.Int32,System.Int32,System.Int32)", "summary": "Retrieves the value from the current cache state after validating the requested access.", "remarks": "Implementations of IReferenceKvCache validate the supplied layer index, the supplied position, and the supplied head index before completing GetValue and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "headIndex": "The zero-based head index; it must identify an existing position within the relevant validated range." }, "returns": "The bounded ReadOnlySpan view produced by IReferenceKvCache.GetValue: Retrieves the value from the current cache state after validating the requested access. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.Reset", "summary": "Resets the requested state to its validated initial state without publishing partial state.", "remarks": "Implementations of IReferenceKvCache validate the instance's existing state before completing Reset and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot)", "summary": "Restores the supplied snapshot from a validated persisted representation.", "remarks": "Implementations of IReferenceKvCache validate the supplied snapshot before completing Restore and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases." }, "returns": "" }, { "kind": "method", "name": "Write(int,int,System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.IReferenceKvCache.Write(System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single})", "summary": "Appends or replaces one layer's key and value vectors at a sequence position.", "remarks": "Implementations of IReferenceKvCache validate the supplied layer index, the supplied position, the supplied key, and the supplied value before completing Write and may publish a result only after the declared contract is satisfied. Ordering, nullability, ownership, validation failures, and caller-provided cancellation remain part of the observable contract whenever the signature exposes them.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "key": "The flattened key vector for all key/value heads.", "value": "The flattened value vector for all key/value heads." }, "returns": "" } ] }, { "name": "LlamaBoundLayerWeightSet", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents the mapped tensors required by one LLaMA transformer block.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.AttentionKey", "summary": "Gets the key projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.AttentionNorm", "summary": "Gets the attention normalization tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionOutput", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.AttentionOutput", "summary": "Gets the attention output projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.AttentionQuery", "summary": "Gets the query projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.AttentionValue", "summary": "Gets the value projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BlockIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.BlockIndex", "summary": "Gets the zero-based transformer block index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardDown", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.FeedForwardDown", "summary": "Gets the feed-forward down projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.FeedForwardGate", "summary": "Gets the feed-forward gate projection tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.FeedForwardNorm", "summary": "Gets the feed-forward normalization tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardUp", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet.FeedForwardUp", "summary": "Gets the feed-forward up projection tensor.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaBoundTensor", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaBoundTensor", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents one semantic LLaMA weight bound to mapped model storage.", "remarks": "", "members": [ { "kind": "property", "name": "Binding", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundTensor.Binding", "summary": "Gets the validated binding manifest entry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BlockIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundTensor.BlockIndex", "summary": "Gets the optional transformer block index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundTensor.Role", "summary": "Gets the semantic tensor role.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundTensor.StorageMode", "summary": "Gets the storage mode represented by this binding.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "View", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundTensor.View", "summary": "Gets the borrowed mapped tensor view.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaBoundWeightSet", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Resolves a complete LLaMA binding manifest into stable mapped tensor views.", "remarks": "This object does not own the operating-system mapping. Every view borrows storage from the supplied UAIX.LmRuntime.Gguf.MappedGgufFile and becomes invalid when that mapping is disposed.", "members": [ { "kind": "property", "name": "Bindings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Bindings", "summary": "Gets all semantic mapped tensor bindings.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Configuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Configuration", "summary": "Gets the validated model configuration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Layers", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Layers", "summary": "Gets the block-local mapped weight sets.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Manifest", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Manifest", "summary": "Gets the complete tensor binding manifest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Mapping", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Mapping", "summary": "Gets the mapping that owns all borrowed tensor bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Output", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Output", "summary": "Gets the output projection tensor or tied embedding alias.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.OutputNorm", "summary": "Gets the final output normalization tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.TokenEmbeddings", "summary": "Gets the token embedding tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Get(UAIX.LmRuntime.Models.Llama.LlamaTensorRole,System.Nullable)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.Get(UAIX.LmRuntime.Models.Llama.LlamaTensorRole,System.Nullable{System.Int32})", "summary": "Retrieves the llama bound tensor from the current LlamaBoundWeightSet state after validating the requested access.", "remarks": "LlamaBoundWeightSet.Get implements this contract: Retrieves the llama bound tensor from the current LlamaBoundWeightSet state after validating the requested access. It evaluates role and blockIndex before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "role": "The semantic LLaMA tensor role used to select the required bound tensor from the validated manifest.", "blockIndex": "The zero-based block index; it must identify an existing position within the relevant validated range." }, "returns": "The LlamaBoundTensor result produced by LlamaBoundWeightSet.Get for this contract: Retrieves the llama bound tensor from the current LlamaBoundWeightSet state after validating the requested access. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "LlamaBoundWeightSet(UAIX.LmRuntime.Gguf.MappedGgufFile,UAIX.LmRuntime.Models.Llama.TensorBindingManifest,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.#ctor(UAIX.LmRuntime.Gguf.MappedGgufFile,UAIX.LmRuntime.Models.Llama.TensorBindingManifest,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Initializes a mapped LLaMA weight set from a complete binding manifest.", "remarks": "Construction validates and records the supplied mapping, the supplied manifest, and the supplied config before the LlamaBoundWeightSet instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "mapping": "The mapped GGUF file that owns tensor storage.", "manifest": "The validated manifest that binds tensor requirements, model identity, and storage diagnostics used by the operation.", "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "" }, { "kind": "method", "name": "MaterializeFloat32ReferenceWeights(int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet.MaterializeFloat32ReferenceWeights(System.Int32)", "summary": "Materializes bounded float32 arrays for the scalar correctness runtime.", "remarks": "LlamaBoundWeightSet.MaterializeFloat32ReferenceWeights implements this contract: Materializes bounded float32 arrays for the scalar correctness runtime. It evaluates maximumCopiedBytes before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "maximumCopiedBytes": "The maximum total bytes that may be copied from mapped storage." }, "returns": "The immutable reference weights and explicit copy ledger." } ] }, { "name": "LlamaGeneratedToken", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Describes one token selected during deterministic greedy generation.", "remarks": "The value contains only a zero-based sequence number, token identifier, and selected logit. It does not contain prompt text, decoded output, model bytes, file paths, persistent state, or provider information.", "members": [ { "kind": "property", "name": "SelectedLogit", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken.SelectedLogit", "summary": "Gets the selected token's deterministic argmax logit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Sequence", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken.Sequence", "summary": "Gets the zero-based token-selection sequence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken.TokenId", "summary": "Gets the selected model vocabulary identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "LlamaGeneratedToken(int,int,float)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken.#ctor(System.Int32,System.Int32,System.Single)", "summary": "Initializes a new LlamaGeneratedToken instance with validated dependencies and operational bounds.", "remarks": "Construction performs no I/O and retains no reference to model, session, prompt, or generated-text state.", "parameters": { "sequence": "The zero-based selection sequence within the current generation operation.", "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "selectedLogit": "The deterministic selected logit at this generation sequence position. NaN is rejected; infinities remain valid because UAIX.LmRuntime.Sampling.GreedySampler compares them using the same deterministic ordering as finite values." }, "returns": "" } ] }, { "name": "LlamaGenerationStopReason", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies why deterministic greedy generation stopped.", "remarks": "", "members": [ { "kind": "field", "name": "Cancelled", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason.Cancelled", "summary": "Cooperative cancellation was observed between committed inference steps.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ContextCapacity", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason.ContextCapacity", "summary": "The model context window could not accept another evaluated token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "EndOfSequence", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason.EndOfSequence", "summary": "The configured end-of-sequence token was selected.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MaximumTokens", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason.MaximumTokens", "summary": "The requested maximum number of tokens was produced.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "StopToken", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaGenerationStopReason.StopToken", "summary": "A caller-configured stop token was selected.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaGreedyGenerationOptions", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Defines allocation-bounded deterministic greedy generation controls.", "remarks": "", "members": [ { "kind": "property", "name": "EndOfSequenceTokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions.EndOfSequenceTokenId", "summary": "Gets the optional end-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumTokens", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions.MaximumTokens", "summary": "Gets the maximum number of generated tokens.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResetSession", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions.ResetSession", "summary": "Gets whether the session is reset before prompt prefill.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions.StopTokenIds", "summary": "Gets additional token identifiers that terminate generation after being emitted.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaGreedyGenerationResult", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Describes an allocation-bounded greedy generation operation.", "remarks": "", "members": [ { "kind": "property", "name": "FinalSelectedLogit", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult.FinalSelectedLogit", "summary": "Gets the selected logit of the final generated token, or negative infinity when none was generated.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult.GeneratedTokenCount", "summary": "Gets the number of generated token identifiers written to the caller buffer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult.Position", "summary": "Gets the next sequence position maintained by the session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult.PromptTokenCount", "summary": "Gets the number of prompt tokens evaluated for this operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopReason", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationResult.StopReason", "summary": "Gets the deterministic stop reason.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaGreedyTokenResult", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents exactly one greedily selected token produced by the reference runtime.", "remarks": "", "members": [ { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult.Position", "summary": "Gets the zero-based position whose logits selected this token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult.PromptTokenCount", "summary": "Gets the number of prompt tokens evaluated.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedLogit", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult.SelectedLogit", "summary": "Gets the selected token logit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult.TokenId", "summary": "Gets the selected token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenText", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaGreedyTokenResult.TokenText", "summary": "Gets the selected token text when a tokenizer is attached.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaLayerWeights", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaLayerWeights", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents one transformer block's reference weights.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLayerWeights.AttentionKey", "summary": "Gets the attention key projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLayerWeights.AttentionQuery", "summary": "Gets the attention query projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLayerWeights.AttentionValue", "summary": "Gets the attention value projection matrix.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaLogitComparator", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaLogitComparator", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Compares deterministic next-token vectors without widening caller-provided tolerances.", "remarks": "", "members": [ { "kind": "method", "name": "Compare(System.Collections.Generic.IReadOnlyList,System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Models.Llama.LlamaParityTolerance)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaLogitComparator.Compare(System.Collections.Generic.IReadOnlyList{System.Single},System.Collections.Generic.IReadOnlyList{System.Single},UAIX.LmRuntime.Models.Llama.LlamaParityTolerance)", "summary": "Compares two logit vectors using absolute-or-relative error acceptance.", "remarks": "LlamaLogitComparator.Compare implements this contract: Compares two logit vectors using absolute-or-relative error acceptance. It evaluates reference, candidate, and tolerance before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "reference": "The reference sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "candidate": "The candidate sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "tolerance": "The tolerance input of type LlamaParityTolerance read by LlamaLogitComparator.Compare; it must satisfy the member-specific nullability, identity, range, and ownership rules before dependent work begins." }, "returns": "The LlamaLogitComparison result produced by LlamaLogitComparator.Compare for this contract: Compares two logit vectors using absolute-or-relative error acceptance. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaLogitComparison", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaLogitComparison", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Summarizes a deterministic comparison of two next-token logit vectors.", "remarks": "", "members": [ { "kind": "property", "name": "FirstFailingCandidateValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.FirstFailingCandidateValue", "summary": "Gets the candidate value at the first failing index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FirstFailingIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.FirstFailingIndex", "summary": "Gets the first failing logit index, or when none failed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FirstFailingReferenceValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.FirstFailingReferenceValue", "summary": "Gets the reference value at the first failing index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsWithinTolerance", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.IsWithinTolerance", "summary": "Gets whether every compared logit satisfies the configured tolerance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumAbsoluteError", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.MaximumAbsoluteError", "summary": "Gets the largest absolute logit difference.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MeanAbsoluteError", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaLogitComparison.MeanAbsoluteError", "summary": "Gets the arithmetic mean absolute logit difference.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaLogitComputer", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaLogitComputer", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Computes reference logits from a hidden state and output projection.", "remarks": "", "members": [ { "kind": "method", "name": "ComputeLogits(System.ReadOnlySpan,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaLogitComputer.ComputeLogits(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Computes logits from a hidden vector and a row-major projection matrix.", "remarks": "LlamaLogitComputer.ComputeLogits implements this contract: Computes logits from a hidden vector and a row-major projection matrix. It evaluates hiddenState, projection, and logits before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "hiddenState": "The hidden state sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "projection": "The projection sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "LlamaMappedGreedyTokenResult", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents an end-to-end prompt-to-one-token result from a mapped GGUF model.", "remarks": "", "members": [ { "kind": "property", "name": "Architecture", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Architecture", "summary": "Gets the model architecture identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Evidence", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Evidence", "summary": "Gets evidence statements for the deterministic one-token operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FinishReason", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.FinishReason", "summary": "Gets the deterministic finish reason.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KeyValueCacheTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.KeyValueCacheTokenCount", "summary": "Gets the resulting key/value cache token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Logits", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Logits", "summary": "Gets the complete next-token logits for parity diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedAllocatedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.ManagedAllocatedByteCount", "summary": "Gets managed bytes allocated on the current thread during the measured operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedModelWeightCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.ManagedModelWeightCopiedByteCount", "summary": "Gets the managed model-weight bytes copied by the session path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.ModelName", "summary": "Gets the model display name declared by GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.ModelPath", "summary": "Gets the normalized GGUF model path used for the operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.ModelSha256", "summary": "Gets the optional complete-file model digest computed during load.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Position", "summary": "Gets the sequence position that produced the logits.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Prompt", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Prompt", "summary": "Gets the input prompt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.PromptTokenIds", "summary": "Gets the exact prompt token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.RuntimeMode", "summary": "Gets the runtime mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedLogit", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.SelectedLogit", "summary": "Gets the selected token logit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.StorageSummary", "summary": "Gets the mapped storage-type summary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Timings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.Timings", "summary": "Gets measured operation timings.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.TokenId", "summary": "Gets the selected token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerTrace", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.TokenizerTrace", "summary": "Gets tokenizer trace events when requested.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenText", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedGreedyTokenResult.TokenText", "summary": "Gets the selected token text.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaMappedModel", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedModel", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Owns a mapped GGUF artifact and immutable LLaMA runtime composition.", "remarks": "", "members": [ { "kind": "property", "name": "BindingManifest", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.BindingManifest", "summary": "Gets the tensor binding manifest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Configuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Configuration", "summary": "Gets the validated LLaMA configuration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.IsDisposed", "summary": "Gets whether the model has been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Manifest", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Manifest", "summary": "Gets the immutable load evidence manifest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Mapping", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Mapping", "summary": "Gets the mapped model storage owner.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Options", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Options", "summary": "Gets the load options retained for deterministic session creation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokenizer", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Tokenizer", "summary": "Gets the exact metadata-driven tokenizer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerMetadata", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.TokenizerMetadata", "summary": "Gets validated GGUF tokenizer metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Weights", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Weights", "summary": "Gets the mapped semantic weight set.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightSource", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.WeightSource", "summary": "Gets the direct mapped execution weight source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CreateMaterializedReferenceSession", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.CreateMaterializedReferenceSession", "summary": "Creates an independent compatibility session over explicitly materialized float32 arrays.", "remarks": "LlamaMappedModel.CreateMaterializedReferenceSession implements this contract: Creates an independent compatibility session over explicitly materialized float32 arrays. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The materialized compatibility session, with ownership and disposal obligations defined by the returned type and the CreateMaterializedReferenceSession contract." }, { "kind": "method", "name": "CreateReferenceSession", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.CreateReferenceSession", "summary": "Creates an independent scalar reference session with its own key/value state.", "remarks": "LlamaMappedModel.CreateReferenceSession implements this contract: Creates an independent scalar reference session with its own key/value state. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The new mapped reference session, with ownership and disposal obligations defined by the returned type and the CreateReferenceSession contract." }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.Dispose", "summary": "Releases resources owned by LlamaMappedModel and transitions it to the disposed state.", "remarks": "The lifecycle transition releases only resources owned by this instance and prevents subsequent operations from observing partially disposed state. State changes are limited to fields explicitly updated by this operation.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GetReferenceMaterialization", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedModel.GetReferenceMaterialization", "summary": "Gets the bounded reference materialization evidence, creating it on first use.", "remarks": "LlamaMappedModel.GetReferenceMaterialization implements this contract: Gets the bounded reference materialization evidence, creating it on first use. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The LlamaReferenceWeightMaterialization result produced by LlamaMappedModel.GetReferenceMaterialization for this contract: Gets the bounded reference materialization evidence, creating it on first use. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaMappedModelLoader", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoader", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Loads a local GGUF artifact into a mapped, tokenizer-aware LLaMA model composition.", "remarks": "", "members": [ { "kind": "method", "name": "Load(string,UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoader.Load(System.String,UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions)", "summary": "Loads and validates one mapped local model.", "remarks": "Parsing and read-only mapping must agree on the complete file length before composition. When digest evidence is requested, SHA-256 is computed in bounded segments directly from the published mapping rather than by reopening the path. The manifest therefore binds its byte count, digest, tensor views, and runtime weights to the same operating-system mapping. Local I/O remains bounded to the caller-supplied local artifact.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional LlamaMappedModelLoadOptions controlling Load; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The owned mapped model, with ownership and disposal obligations defined by the returned type and the Load contract." } ] }, { "name": "LlamaMappedModelLoadOptions", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures loading of a mapped LLaMA GGUF artifact.", "remarks": "", "members": [ { "kind": "property", "name": "BindingOptions", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions.BindingOptions", "summary": "Gets semantic tensor binding validation options.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ComputeModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions.ComputeModelSha256", "summary": "Gets whether a SHA-256 digest of the complete artifact should be computed during load.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumReferenceMaterializationBytes", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions.MaximumReferenceMaterializationBytes", "summary": "Gets the maximum bytes that scalar reference sessions may copy from mapped F32 weights.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseOptions", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions.ParseOptions", "summary": "Gets GGUF parser safety limits.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadOptions.RuntimeMode", "summary": "Gets the runtime mode.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaMappedModelLoadTimings", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Records measured stages of mapped model loading.", "remarks": "", "members": [ { "kind": "property", "name": "CompositionDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings.CompositionDuration", "summary": "Gets architecture, tokenizer, and binding composition duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HashDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings.HashDuration", "summary": "Gets optional complete-file digest duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MapDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings.MapDuration", "summary": "Gets operating-system memory-map creation duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings.ParseDuration", "summary": "Gets metadata and tensor catalog parse duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TotalDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelLoadTimings.TotalDuration", "summary": "Gets total load duration.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaMappedModelManifest", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Describes the immutable evidence produced while loading a mapped LLaMA model.", "remarks": "", "members": [ { "kind": "property", "name": "Architecture", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.Architecture", "summary": "Gets the architecture identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BoundTensorCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.BoundTensorCount", "summary": "Gets the bound tensor count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Evidence", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.Evidence", "summary": "Gets load evidence messages.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgufVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.GgufVersion", "summary": "Gets the GGUF version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedModelWeightCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.ManagedModelWeightCopiedByteCount", "summary": "Gets the managed model-weight byte count copied by the default execution path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.ModelByteCount", "summary": "Gets the exact mapped GGUF file length observed during parsing.", "remarks": "The value is captured from the same parsed artifact used to create the read-only mapping. Callers can bind it to independently reviewed file-length evidence without reusing or exposing the private model path.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.ModelName", "summary": "Gets the model display name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.ModelPath", "summary": "Gets the normalized model path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.ModelSha256", "summary": "Gets the optional complete-file SHA-256 digest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.RuntimeMode", "summary": "Gets the selected execution mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.StorageSummary", "summary": "Gets the physical tensor storage summary used by direct mapped execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Timings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.Timings", "summary": "Gets load-stage timings.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokenizer", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedModelManifest.Tokenizer", "summary": "Gets the tokenizer implementation name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaMappedReferenceSession", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Combines exact GGUF tokenization with an independent scalar reference session.", "remarks": "", "members": [ { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.IsDisposed", "summary": "Gets whether this session has released its state.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KvCache", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.KvCache", "summary": "Gets the typed session-local key/value cache.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.Position", "summary": "Gets the current next-token sequence position.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "DecodeOneGreedy(string,UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.DecodeOneGreedy(System.String,UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions)", "summary": "Tokenizes a prompt, executes prefill, selects argmax, and decodes exactly one token.", "remarks": "LlamaMappedReferenceSession.DecodeOneGreedy implements this contract: Tokenizes a prompt, executes prefill, selects argmax, and decodes exactly one token. It evaluates prompt and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "prompt": "The prompt processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "options": "The optional LlamaOneTokenOptions controlling DecodeOneGreedy; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The LlamaMappedGreedyTokenResult result produced by LlamaMappedReferenceSession.DecodeOneGreedy for this contract: Tokenizes a prompt, executes prefill, selects argmax, and decodes exactly one token. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.Dispose", "summary": "Releases resources owned by LlamaMappedReferenceSession and transitions it to the disposed state.", "remarks": "The lifecycle transition releases only resources owned by this instance and prevents subsequent operations from observing partially disposed state. State changes are limited to fields explicitly updated by this operation.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ExportState(UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.ExportState(UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "summary": "Exports complete deterministic state with model, configuration, tokenizer, and cache-layout identities.", "remarks": "LlamaMappedReferenceSession.ExportState implements this contract: Exports complete deterministic state with model, configuration, tokenizer, and cache-layout identities. It evaluates options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "options": "Optional persistence metadata. Empty identity fields are resolved from the mapped model." }, "returns": "A newly allocated byte[] containing the ordered result of LlamaMappedReferenceSession.ExportState: Exports complete deterministic state with model, configuration, tokenizer, and cache-layout identities. The caller owns the returned array and later mutation cannot alter the source object." }, { "kind": "method", "name": "GenerateGreedy(string,System.Span,System.Span,UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,UAIX.LmRuntime.Tokenization.TokenizationOptions,System.Action,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.GenerateGreedy(System.String,System.Span{System.Int32},System.Span{System.Single},UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,UAIX.LmRuntime.Tokenization.TokenizationOptions,System.Action{UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken},System.Threading.CancellationToken)", "summary": "Tokenizes a prompt, generates greedy token identifiers, and reports each selected token synchronously.", "remarks": "The observer executes on the caller's generation thread. It is not retained by the mapped model or session, and any observer exception propagates without selecting another token.", "parameters": { "prompt": "The prompt processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "generatedTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "finalLogits": "The final logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "generationOptions": "The generation options that define validation limits and execution behavior; required values are checked before use.", "tokenizationOptions": "The tokenization options that define validation limits and execution behavior; required values are checked before use.", "tokenObserver": "The optional observer invoked once for each selected token.", "cancellationToken": "A token observed before selection and before the next committed model step." }, "returns": "The LlamaGreedyGenerationResult result produced by LlamaMappedReferenceSession.GenerateGreedy for this contract: Tokenizes a prompt, generates greedy token identifiers, and reports each selected token synchronously. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "GenerateGreedy(string,System.Span,System.Span,UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,UAIX.LmRuntime.Tokenization.TokenizationOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.GenerateGreedy(System.String,System.Span{System.Int32},System.Span{System.Single},UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,UAIX.LmRuntime.Tokenization.TokenizationOptions,System.Threading.CancellationToken)", "summary": "Tokenizes a prompt and generates greedy token identifiers into caller-owned buffers.", "remarks": "The overload performs no callback and preserves the original allocation-bounded generation contract. The returned value is produced only after the method's complete processing path succeeds.", "parameters": { "prompt": "The prompt processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "generatedTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "finalLogits": "The final logits sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "generationOptions": "The generation options that define validation limits and execution behavior; required values are checked before use.", "tokenizationOptions": "The tokenization options that define validation limits and execution behavior; required values are checked before use.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The LlamaGreedyGenerationResult result produced by LlamaMappedReferenceSession.GenerateGreedy for this contract: Tokenizes a prompt and generates greedy token identifiers into caller-owned buffers. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "LoadState(string,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.LoadState(System.String,System.Int32)", "summary": "Loads and restores complete deterministic state from a local artifact.", "remarks": "LlamaMappedReferenceSession.LoadState implements this contract: Loads and restores complete deterministic state from a local artifact. It evaluates path and maximumByteCount before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The verified artifact, with ownership and disposal obligations defined by the returned type and the LoadState contract." }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.Reset", "summary": "Resets this session's sequence and key/value state.", "remarks": "LlamaMappedReferenceSession.Reset implements this contract: Resets this session's sequence and key/value state. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "RestoreState(System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.RestoreState(System.ReadOnlySpan{System.Byte},System.Int32)", "summary": "Restores verified complete state after enforcing mapped model and tokenizer identities.", "remarks": "LlamaMappedReferenceSession.RestoreState implements this contract: Restores verified complete state after enforcing mapped model and tokenizer identities. It evaluates bytes and maximumByteCount before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The LlamaSessionArtifact result produced by LlamaMappedReferenceSession.RestoreState for this contract: Restores verified complete state after enforcing mapped model and tokenizer identities. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "SaveState(string,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaMappedReferenceSession.SaveState(System.String,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "summary": "Saves complete deterministic state to a local artifact.", "remarks": "The method writes the canonical local representation in deterministic order and propagates storage failures without reporting a completed result. The returned value is produced only after the method's complete processing path succeeds.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "options": "The optional LlamaSessionPersistenceOptions controlling SaveState; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The LlamaSessionArtifact result produced by LlamaMappedReferenceSession.SaveState for this contract: Saves complete deterministic state to a local artifact. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaModelConfig", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaModelConfig", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents LLaMA-family transformer configuration reconstructed from GGUF metadata.", "remarks": "", "members": [ { "kind": "property", "name": "Architecture", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.Architecture", "summary": "Gets the architecture name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionHeadCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.AttentionHeadCount", "summary": "Gets the attention head count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionKeyValueHeadCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.AttentionKeyValueHeadCount", "summary": "Gets the attention key/value head count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BlockCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.BlockCount", "summary": "Gets the transformer block count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.ContextLength", "summary": "Gets the training context length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EmbeddingLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.EmbeddingLength", "summary": "Gets the embedding length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.FeedForwardLength", "summary": "Gets the feed-forward hidden length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HeadDimension", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.HeadDimension", "summary": "Gets the dimension of one query attention head.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KeyValueDimension", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.KeyValueDimension", "summary": "Gets the flattened key/value projection dimension.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.ModelName", "summary": "Gets the optional model display name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RmsNormEpsilon", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.RmsNormEpsilon", "summary": "Gets the RMSNorm epsilon.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RopeDimensionCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.RopeDimensionCount", "summary": "Gets the RoPE dimension count per attention head.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RopeFrequencyBase", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.RopeFrequencyBase", "summary": "Gets the RoPE frequency base.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsTiedOutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.SupportsTiedOutputProjection", "summary": "Gets whether the loader may use token embeddings as the output projection when output.weight is absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VocabularySize", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.VocabularySize", "summary": "Gets the vocabulary size.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "FromGguf(UAIX.LmRuntime.Gguf.GgufModel)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.FromGguf(UAIX.LmRuntime.Gguf.GgufModel)", "summary": "Creates a LLaMA-family configuration from GGUF metadata.", "remarks": "LlamaModelConfig.FromGguf implements this contract: Creates a LLaMA-family configuration from GGUF metadata. It evaluates model before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation." }, "returns": "The LlamaModelConfig result produced by LlamaModelConfig.FromGguf for this contract: Creates a LLaMA-family configuration from GGUF metadata. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Validate", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaModelConfig.Validate", "summary": "Validates architectural invariants required by the scalar LLaMA runtime.", "remarks": "LlamaModelConfig.Validate implements this contract: Validates architectural invariants required by the scalar LLaMA runtime. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "" } ] }, { "name": "LlamaOneTokenFinishReason", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaOneTokenFinishReason", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies why a bounded one-token generation operation ended.", "remarks": "", "members": [ { "kind": "field", "name": "OneTokenCompleted", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaOneTokenFinishReason.OneTokenCompleted", "summary": "Exactly one greedy token was selected as requested.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaOneTokenOptions", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures one deterministic mapped-model greedy-token operation.", "remarks": "", "members": [ { "kind": "property", "name": "AddSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions.AddSpecialTokens", "summary": "Gets whether model-defined BOS/EOS behavior should be applied.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EmitTokenizerTrace", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions.EmitTokenizerTrace", "summary": "Gets whether tokenizer trace events should be captured.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions.ParseSpecialTokens", "summary": "Gets whether raw special-token text should be recognized.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResetSession", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenOptions.ResetSession", "summary": "Gets whether the session should reset before prompt evaluation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaOneTokenTimings", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaOneTokenTimings", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Records measured stages of exactly one mapped-model greedy decode operation.", "remarks": "", "members": [ { "kind": "property", "name": "PrefillDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenTimings.PrefillDuration", "summary": "Gets prompt prefill duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectionDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenTimings.SelectionDuration", "summary": "Gets greedy selection and token decode duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizationDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenTimings.TokenizationDuration", "summary": "Gets prompt tokenization duration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TotalDuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaOneTokenTimings.TotalDuration", "summary": "Gets total operation duration.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaParityTolerance", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaParityTolerance", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures exact token and explicit floating-point tolerance checks for cross-storage parity.", "remarks": "", "members": [ { "kind": "property", "name": "AbsoluteTolerance", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaParityTolerance.AbsoluteTolerance", "summary": "Gets the absolute per-logit tolerance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RelativeTolerance", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaParityTolerance.RelativeTolerance", "summary": "Gets the relative per-logit tolerance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Validate", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaParityTolerance.Validate", "summary": "Validates the absolute and relative parity tolerances used for numerical comparison.", "remarks": "LlamaParityTolerance.Validate implements this contract: Validates the absolute and relative parity tolerances used for numerical comparison. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "" } ] }, { "name": "LlamaReferenceAttention", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceAttention", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides reference causal attention behavior.", "remarks": "", "members": [ { "kind": "method", "name": "ApplyCausal(System.ReadOnlySpan,System.ReadOnlySpan,System.ReadOnlySpan,int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceAttention.ApplyCausal(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Int32,System.Span{System.Single})", "summary": "Applies a minimal causal attention score computation.", "remarks": "LlamaReferenceAttention.ApplyCausal implements this contract: Applies a minimal causal attention score computation. It evaluates query, keys, values, headSize, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "query": "The query sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "keys": "The keys sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "headSize": "The numeric head size consumed by ApplyCausal; it must satisfy the member's documented range, geometry, and finite-value requirements.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "LlamaReferenceExecutor", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceExecutor", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides scalar/reference execution anchors for LLaMA-family graphs.", "remarks": "", "members": [ { "kind": "method", "name": "Forward(System.ReadOnlySpan,UAIX.LmRuntime.Models.Llama.LlamaWeights,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceExecutor.Forward(System.ReadOnlySpan{System.Single},UAIX.LmRuntime.Models.Llama.LlamaWeights,System.Span{System.Single})", "summary": "Executes a minimal reference forward pass over hidden-state logits.", "remarks": "LlamaReferenceExecutor.Forward implements this contract: Executes a minimal reference forward pass over hidden-state logits. It evaluates hiddenState, weights, and logits before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "hiddenState": "The hidden state sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "weights": "The LLaMA weights used by the reference path.", "logits": "The logits sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "LlamaReferenceFixture", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a deterministic tiny reference fixture with one transformer block.", "remarks": "", "members": [ { "kind": "property", "name": "Configuration", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture.Configuration", "summary": "Gets the fixture model configuration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture.PromptTokenIds", "summary": "Gets the canonical fixture prompt tokens.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokenizer", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture.Tokenizer", "summary": "Gets the fixture tokenizer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Weights", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture.Weights", "summary": "Gets the fixture model weights.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CreateSession", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixture.CreateSession", "summary": "Creates the session from the validated inputs required by LlamaReferenceFixture.", "remarks": "LlamaReferenceFixture.CreateSession implements this contract: Creates the session from the validated inputs required by LlamaReferenceFixture. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "A session with empty key/value cache state." } ] }, { "name": "LlamaReferenceFixtureFactory", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceFixtureFactory", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Creates deterministic tiny fixtures used by reference-runtime tests and examples.", "remarks": "", "members": [ { "kind": "method", "name": "CreateDeterministic", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceFixtureFactory.CreateDeterministic", "summary": "Creates a one-block, five-token deterministic LLaMA fixture.", "remarks": "LlamaReferenceFixtureFactory.CreateDeterministic implements this contract: Creates a one-block, five-token deterministic LLaMA fixture. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The fixture configuration, weights, tokenizer, and prompt, with ownership and disposal obligations defined by the returned type and the CreateDeterministic contract." } ] }, { "name": "LlamaReferenceForwardPass", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceForwardPass", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides tiny reference building blocks for LLaMA-family correctness tests.", "remarks": "", "members": [ { "kind": "method", "name": "ApplyRope(System.Span,System.ReadOnlySpan,System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceForwardPass.ApplyRope(System.Span{System.Single},System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Int32)", "summary": "Applies LLaMA-style RoPE to a query or key vector in place.", "remarks": "LlamaReferenceForwardPass.ApplyRope implements this contract: Applies LLaMA-style RoPE to a query or key vector in place. It evaluates vector, cos, sin, and ropeDimensions before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "cos": "The cos sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "sin": "The sin sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "ropeDimensions": "The even number of leading head dimensions transformed by rotary positional encoding." }, "returns": "" }, { "kind": "method", "name": "RmsNorm(System.ReadOnlySpan,System.ReadOnlySpan,System.Span,float)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceForwardPass.RmsNorm(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Single)", "summary": "Applies the LLaMA RMSNorm operation through the CPU reference kernel.", "remarks": "LlamaReferenceForwardPass.RmsNorm implements this contract: Applies the LLaMA RMSNorm operation through the CPU reference kernel. It evaluates input, weight, output, and epsilon before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "input": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "weight": "The weight sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "epsilon": "The positive normalization epsilon added to the mean-square term to avoid division by zero while preserving deterministic numerical behavior." }, "returns": "" } ] }, { "name": "LlamaReferenceLayerWeights", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Stores immutable float32 weights for one scalar/reference LLaMA transformer block.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.AttentionKey", "summary": "Gets the key projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.AttentionNorm", "summary": "Gets the attention RMSNorm scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionOutput", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.AttentionOutput", "summary": "Gets the attention output projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.AttentionQuery", "summary": "Gets the query projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.AttentionValue", "summary": "Gets the value projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardDown", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.FeedForwardDown", "summary": "Gets the feed-forward down projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.FeedForwardGate", "summary": "Gets the feed-forward gate projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.FeedForwardNorm", "summary": "Gets the feed-forward RMSNorm scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardUp", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceLayerWeights.FeedForwardUp", "summary": "Gets the feed-forward up projection matrix in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaReferenceMaterializationRecord", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Records one explicit managed copy made for the bounded scalar reference runtime.", "remarks": "", "members": [ { "kind": "property", "name": "BlockIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord.BlockIndex", "summary": "Gets the optional transformer block index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord.CopiedByteCount", "summary": "Gets the copied byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord.Role", "summary": "Gets the semantic tensor role.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord.StorageMode", "summary": "Gets the resulting storage mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceMaterializationRecord.TensorName", "summary": "Gets the source tensor name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaReferenceModelWeights", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Stores immutable float32 weights for the deterministic LLaMA reference runtime.", "remarks": "", "members": [ { "kind": "property", "name": "Layers", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights.Layers", "summary": "Gets transformer block weights in execution order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights.OutputNorm", "summary": "Gets the final RMSNorm scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights.OutputProjection", "summary": "Gets the output projection matrix in row-major logical order. An empty value means tied embeddings.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights.TokenEmbeddings", "summary": "Gets the token embedding table in row-major logical order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Validate(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights.Validate(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Validates all reference-weight shapes against a LLaMA configuration.", "remarks": "LlamaReferenceModelWeights.Validate implements this contract: Validates all reference-weight shapes against a LLaMA configuration. It evaluates config before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "" } ] }, { "name": "LlamaReferenceRmsNorm", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceRmsNorm", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides reference RMSNorm behavior.", "remarks": "", "members": [ { "kind": "method", "name": "Apply(System.ReadOnlySpan,System.ReadOnlySpan,System.Span,float)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceRmsNorm.Apply(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single},System.Single)", "summary": "Applies the supplied input to the supplied values while preserving the operation's numeric and shape invariants.", "remarks": "LlamaReferenceRmsNorm.Apply implements this contract: Applies the supplied input to the supplied values while preserving the operation's numeric and shape invariants. It evaluates input, weights, output, and epsilon before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "input": "The source data consumed by the operation; caller-owned storage is not retained after the method returns.", "weights": "The weights sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs.", "epsilon": "The positive normalization epsilon added to the mean-square term to avoid division by zero while preserving deterministic numerical behavior." }, "returns": "" } ] }, { "name": "LlamaReferenceRope", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceRope", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides reference RoPE behavior.", "remarks": "", "members": [ { "kind": "method", "name": "Apply(System.Span,int,float)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceRope.Apply(System.Span{System.Single},System.Int32,System.Single)", "summary": "Applies rotary position embedding to adjacent hidden-state pairs.", "remarks": "LlamaReferenceRope.Apply implements this contract: Applies rotary position embedding to adjacent hidden-state pairs. It evaluates values, position, and theta before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "values": "The values sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "theta": "The rotary angle in radians applied to the paired vector components at the addressed position." }, "returns": "" } ] }, { "name": "LlamaReferenceSession", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceSession", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Executes a deterministic, scalar-first LLaMA forward path for tiny correctness fixtures.", "remarks": "This class is the numerical correctness anchor for later optimized kernels. It is intentionally limited to batch size one and F32, Q8_0, or Q4_0 mapped or array-backed weights. It performs no governance or adaptive policy operations and therefore belongs exclusively to deterministic parity mode.", "members": [ { "kind": "property", "name": "ContextCapacity", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.ContextCapacity", "summary": "Gets the configured sequence capacity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KvCache", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.KvCache", "summary": "Gets the typed key/value cache owned by this session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.Position", "summary": "Gets the next sequence position to be evaluated.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VocabularySize", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.VocabularySize", "summary": "Gets the configured vocabulary size.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WeightSource", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.WeightSource", "summary": "Gets the immutable model weight source used by this session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CaptureState", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.CaptureState", "summary": "Captures complete deterministic session state without serializing live model pointers.", "remarks": "LlamaReferenceSession.CaptureState implements this contract: Captures complete deterministic session state without serializing live model pointers. It evaluates its explicitly owned state before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": {}, "returns": "The LlamaReferenceSessionSnapshot result produced by LlamaReferenceSession.CaptureState for this contract: Captures complete deterministic session state without serializing live model pointers. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "CopyLastLogitsTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.CopyLastLogitsTo(System.Span{System.Single})", "summary": "Copies the most recently computed logits to a caller-provided destination.", "remarks": "LlamaReferenceSession.CopyLastLogitsTo implements this contract: Copies the most recently computed logits to a caller-provided destination. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "destination": "The destination with room for the configured vocabulary." }, "returns": "" }, { "kind": "method", "name": "DecodeOneGreedy(System.Collections.Generic.IReadOnlyList,bool)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.DecodeOneGreedy(System.Collections.Generic.IReadOnlyList{System.Int32},System.Boolean)", "summary": "Evaluates a prompt and returns exactly one greedily selected next token.", "remarks": "LlamaReferenceSession.DecodeOneGreedy implements this contract: Evaluates a prompt and returns exactly one greedily selected next token. It evaluates promptTokenIds and resetSession before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "promptTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "resetSession": "Whether existing key/value state should be cleared first." }, "returns": "The LlamaGreedyTokenResult result produced by LlamaReferenceSession.DecodeOneGreedy for this contract: Evaluates a prompt and returns exactly one greedily selected next token. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "GenerateGreedy(System.Collections.Generic.IReadOnlyList,System.Span,System.Span,UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,System.Action,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.GenerateGreedy(System.Collections.Generic.IReadOnlyList{System.Int32},System.Span{System.Int32},System.Span{System.Single},UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,System.Action{UAIX.LmRuntime.Models.Llama.LlamaGeneratedToken},System.Threading.CancellationToken)", "summary": "Generates deterministic greedy token identifiers and reports each selection to a synchronous observer.", "remarks": "The observer is invoked synchronously after the selected identifier has been written to the caller buffer and before the selected token is evaluated for a subsequent step. Observer exceptions propagate immediately and no further token is selected. The runtime retains neither the delegate nor any observer-produced state.", "parameters": { "promptTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "generatedTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "finalLogits": "The caller-owned destination for the final available logits.", "options": "The optional LlamaGreedyGenerationOptions controlling GenerateGreedy; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "tokenObserver": "The optional synchronous observer invoked once after each token is selected.", "cancellationToken": "A token observed before selection and before the next committed model step." }, "returns": "The LlamaGreedyGenerationResult result produced by LlamaReferenceSession.GenerateGreedy for this contract: Generates deterministic greedy token identifiers and reports each selection to a synchronous observer. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "GenerateGreedy(System.Collections.Generic.IReadOnlyList,System.Span,System.Span,UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.GenerateGreedy(System.Collections.Generic.IReadOnlyList{System.Int32},System.Span{System.Int32},System.Span{System.Single},UAIX.LmRuntime.Models.Llama.LlamaGreedyGenerationOptions,System.Threading.CancellationToken)", "summary": "Generates deterministic greedy token identifiers into caller-owned buffers.", "remarks": "A selected terminal token is written to generatedTokenIds but is not evaluated through another forward step. Cancellation never interrupts a tensor kernel; it is observed only before selection or before evaluating the next selected token, leaving the cache at the last fully committed sequence position.", "parameters": { "promptTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "generatedTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "finalLogits": "The caller-owned destination for the final available logits.", "options": "The optional LlamaGreedyGenerationOptions controlling GenerateGreedy; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated.", "cancellationToken": "The caller-provided token used to cancel the operation before additional work or results are published." }, "returns": "The LlamaGreedyGenerationResult result produced by LlamaReferenceSession.GenerateGreedy for this contract: Generates deterministic greedy token identifiers into caller-owned buffers. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "LlamaReferenceSession(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource,UAIX.LmRuntime.Tokenization.IGgufTokenizer)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.#ctor(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource,UAIX.LmRuntime.Tokenization.IGgufTokenizer)", "summary": "Initializes a reference session over immutable array-backed or direct mapped weight sources.", "remarks": "Construction validates and records the supplied config, the supplied weights, and the supplied tokenizer before the LlamaReferenceSession instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation.", "tokenizer": "The optional tokenizer used only to decode the selected token text." }, "returns": "" }, { "kind": "method", "name": "LlamaReferenceSession(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights,UAIX.LmRuntime.Tokenization.IGgufTokenizer)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.#ctor(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.LlamaReferenceModelWeights,UAIX.LmRuntime.Tokenization.IGgufTokenizer)", "summary": "Initializes a reference session through the v1.8.0 array-backed compatibility path.", "remarks": "LlamaReferenceSession.LlamaReferenceSession establishes the invariants required by this contract: Initializes a reference session through the v1.8.0 array-backed compatibility path. It evaluates config, weights, and tokenizer before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation.", "tokenizer": "The optional tokenizer used only to decode the selected token text." }, "returns": "" }, { "kind": "method", "name": "Prefill(System.Collections.Generic.IReadOnlyList,bool)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.Prefill(System.Collections.Generic.IReadOnlyList{System.Int32},System.Boolean)", "summary": "Evaluates every prompt token and leaves the final logits available for deterministic selection.", "remarks": "LlamaReferenceSession.Prefill implements this contract: Evaluates every prompt token and leaves the final logits available for deterministic selection. It evaluates promptTokenIds and resetSession before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "promptTokenIds": "The ordered token identifiers to process; sequence order is preserved and each identifier is validated where required.", "resetSession": "Whether existing sequence and cache state should be cleared first." }, "returns": "" }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.Reset", "summary": "Clears sequence state and all key/value cache contents.", "remarks": "LlamaReferenceSession.Reset implements this contract: Clears sequence state and all key/value cache contents. It evaluates its explicitly owned state before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "RestoreState(UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.RestoreState(UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot)", "summary": "Restores complete deterministic state after validating sequence, vocabulary, and cache identities.", "remarks": "LlamaReferenceSession.RestoreState implements this contract: Restores complete deterministic state after validating sequence, vocabulary, and cache identities. It evaluates snapshot before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases." }, "returns": "" }, { "kind": "method", "name": "RunStep(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.RunStep(System.Int32,System.Span{System.Single})", "summary": "Evaluates one input token and writes next-token logits.", "remarks": "LlamaReferenceSession.RunStep implements this contract: Evaluates one input token and writes next-token logits. It evaluates tokenId and logits before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "logits": "The destination buffer with at least vocabulary-size elements." }, "returns": "" }, { "kind": "method", "name": "SelectGreedyToken(int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaReferenceSession.SelectGreedyToken(System.Int32)", "summary": "Selects and decodes one greedy token from the current logits.", "remarks": "LlamaReferenceSession.SelectGreedyToken implements this contract: Selects and decodes one greedy token from the current logits. It evaluates promptTokenCount before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "promptTokenCount": "The number of prompt tokens associated with the current logits." }, "returns": "The LlamaGreedyTokenResult result produced by LlamaReferenceSession.SelectGreedyToken for this contract: Selects and decodes one greedy token from the current logits. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaReferenceSessionSnapshot", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Captures complete deterministic reference-session state without retaining live model pointers.", "remarks": "", "members": [ { "kind": "property", "name": "KeyValueCache", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot.KeyValueCache", "summary": "Gets complete capacity-shaped key/value state.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LastLogits", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot.LastLogits", "summary": "Gets the most recently computed logits.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot.Position", "summary": "Gets the next sequence position.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SchemaVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot.SchemaVersion", "summary": "Gets the in-memory snapshot schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenHistory", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot.TokenHistory", "summary": "Gets committed input token identifiers in sequence order.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaReferenceWeightMaterialization", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaReferenceWeightMaterialization", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Contains immutable float32 weights and copy evidence for the scalar reference runtime.", "remarks": "", "members": [ { "kind": "property", "name": "Records", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceWeightMaterialization.Records", "summary": "Gets every bounded copy made while materializing the fixture.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TotalCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceWeightMaterialization.TotalCopiedByteCount", "summary": "Gets the total number of copied bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Weights", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaReferenceWeightMaterialization.Weights", "summary": "Gets the immutable reference weights.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaRequiredTensorRegistry", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaRequiredTensorRegistry", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Builds the required LLaMA-family tensor registry from model configuration.", "remarks": "", "members": [ { "kind": "method", "name": "Build(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaRequiredTensorRegistry.Build(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Creates the required tensor list for the configuration.", "remarks": "LlamaRequiredTensorRegistry.Build implements this contract: Creates the required tensor list for the configuration. It evaluates config before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "An ordered read-only IReadOnlyList result from LlamaRequiredTensorRegistry.Build: Creates the required tensor list for the configuration. Mutable internal collection aliases are not exposed through the returned contract." } ] }, { "name": "LlamaRuntimeMode", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaRuntimeMode", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies the deterministic execution contract used by a mapped model session.", "remarks": "", "members": [ { "kind": "field", "name": "DeterministicParity", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaRuntimeMode.DeterministicParity", "summary": "Runs only deterministic parity behavior without adaptive governance.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaSessionArtifact", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Carries verified complete deterministic session state and compatibility identities.", "remarks": "", "members": [ { "kind": "property", "name": "CacheLayoutFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.CacheLayoutFingerprint", "summary": "Gets the cache-layout fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimStatus", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.ClaimStatus", "summary": "Gets the evidence claim status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.ConfigurationFingerprint", "summary": "Gets the model configuration fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContentSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.ContentSha256", "summary": "Gets the SHA-256 of every serialized byte preceding the digest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EndOfSequenceTokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.EndOfSequenceTokenId", "summary": "Gets the optional end-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedUtc", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.GeneratedUtc", "summary": "Gets the artifact generation time in UTC.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumCompatiblePackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.MaximumCompatiblePackageVersion", "summary": "Gets the newest supported package version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumCompatiblePackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.MinimumCompatiblePackageVersion", "summary": "Gets the oldest supported package version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.ModelSha256", "summary": "Gets the complete model artifact SHA-256.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.PackageVersion", "summary": "Gets the package version that emitted the artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SamplerMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.SamplerMode", "summary": "Gets the sampler mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SchemaVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.SchemaVersion", "summary": "Gets the portable schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Snapshot", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.Snapshot", "summary": "Gets the complete session snapshot.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.StopTokenIds", "summary": "Gets configured stop-token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifact.TokenizerFingerprint", "summary": "Gets the tokenizer fingerprint.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaSessionArtifactSerializer", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Serializes complete deterministic reference-session state in bounded little-endian form.", "remarks": "", "members": [ { "kind": "field", "name": "SchemaVersion", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer.SchemaVersion", "summary": "Gets the supported artifact schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Deserialize(System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer.Deserialize(System.ReadOnlySpan{System.Byte},System.Int32)", "summary": "Deserializes the llama session artifact from the validated persisted representation.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Caller-owned spans are bounds-checked and do not escape the call; count and range checks precede size-dependent allocation.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The LlamaSessionArtifact result produced by LlamaSessionArtifactSerializer.Deserialize for this contract: Deserializes the llama session artifact from the validated persisted representation. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Load(string,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer.Load(System.String,System.Int32)", "summary": "Reads and verifies a complete artifact from a local file.", "remarks": "LlamaSessionArtifactSerializer.Load implements this contract: Reads and verifies a complete artifact from a local file. It evaluates path and maximumByteCount before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The verified artifact, with ownership and disposal obligations defined by the returned type and the Load contract." }, { "kind": "method", "name": "Save(string,UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer.Save(System.String,UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "summary": "Writes a complete artifact to a local file.", "remarks": "The method writes the canonical local representation in deterministic order and propagates storage failures without reporting a completed result. The returned value is produced only after the method's complete processing path succeeds.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases.", "options": "The optional LlamaSessionPersistenceOptions controlling Save; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The LlamaSessionArtifact result produced by LlamaSessionArtifactSerializer.Save for this contract: Writes a complete artifact to a local file. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Serialize(UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaSessionArtifactSerializer.Serialize(UAIX.LmRuntime.Models.Llama.LlamaReferenceSessionSnapshot,UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions)", "summary": "Serializes complete session state and appends a SHA-256 digest.", "remarks": "The method writes the canonical local representation in deterministic order and propagates storage failures without reporting a completed result. Returned or retained collections are snapshotted where stable ownership is required; count and range checks precede size-dependent allocation.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases.", "options": "The optional LlamaSessionPersistenceOptions controlling Serialize; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "A newly allocated byte[] containing the ordered result of LlamaSessionArtifactSerializer.Serialize: Serializes complete session state and appends a SHA-256 digest. The caller owns the returned array and later mutation cannot alter the source object." } ] }, { "name": "LlamaSessionPersistenceOptions", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures digest-bound complete session serialization.", "remarks": "", "members": [ { "kind": "property", "name": "CacheLayoutFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.CacheLayoutFingerprint", "summary": "Gets the persistent cache-layout identity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimStatus", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.ClaimStatus", "summary": "Gets the evidence claim status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.ConfigurationFingerprint", "summary": "Gets the LLaMA configuration fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EndOfSequenceTokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.EndOfSequenceTokenId", "summary": "Gets the optional end-of-sequence token identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedUtc", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.GeneratedUtc", "summary": "Gets the UTC generation time.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.MaximumByteCount", "summary": "Gets the maximum accepted artifact byte count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumCompatiblePackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.MaximumCompatiblePackageVersion", "summary": "Gets the newest supported package version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MinimumCompatiblePackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.MinimumCompatiblePackageVersion", "summary": "Gets the oldest supported package version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.ModelSha256", "summary": "Gets the complete model artifact SHA-256.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.PackageVersion", "summary": "Gets the package version that emitted the artifact.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SamplerMode", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.SamplerMode", "summary": "Gets the deterministic sampler mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.StopTokenIds", "summary": "Gets configured stop-token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaSessionPersistenceOptions.TokenizerFingerprint", "summary": "Gets the GGUF tokenizer fingerprint.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaStorageParityCandidateResult", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents one candidate model's parity result against a selected reference model.", "remarks": "", "members": [ { "kind": "property", "name": "LogitComparison", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.LogitComparison", "summary": "Gets the detailed logit comparison.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.ModelPath", "summary": "Gets the candidate model path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.ModelSha256", "summary": "Gets the candidate model SHA-256.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OneTokenResult", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.OneTokenResult", "summary": "Gets the complete candidate one-token result.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Passed", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.Passed", "summary": "Gets whether both exact-token and floating-point contracts passed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.StorageSummary", "summary": "Gets the candidate storage summary.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenMatches", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityCandidateResult.TokenMatches", "summary": "Gets whether the selected token identifier exactly equals the reference identifier.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaStorageParityResult", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaStorageParityResult", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a cross-storage one-token parity run.", "remarks": "", "members": [ { "kind": "property", "name": "Candidates", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityResult.Candidates", "summary": "Gets candidate results in caller order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Passed", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityResult.Passed", "summary": "Gets whether every candidate passed the explicit parity contract.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Prompt", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityResult.Prompt", "summary": "Gets the prompt used for every model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ReferenceResult", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaStorageParityResult.ReferenceResult", "summary": "Gets the reference one-token result.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaStorageParityRunner", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaStorageParityRunner", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Executes bounded offline one-token parity comparisons across local GGUF storage variants.", "remarks": "", "members": [ { "kind": "method", "name": "Run(string,System.Collections.Generic.IReadOnlyList,string,UAIX.LmRuntime.Models.Llama.LlamaParityTolerance)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaStorageParityRunner.Run(System.String,System.Collections.Generic.IReadOnlyList{System.String},System.String,UAIX.LmRuntime.Models.Llama.LlamaParityTolerance)", "summary": "Runs one reference model and one or more candidate models with identical prompt settings.", "remarks": "LlamaStorageParityRunner.Run implements this contract: Runs one reference model and one or more candidate models with identical prompt settings. It evaluates referenceModelPath, candidateModelPaths, prompt, and tolerance before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "referenceModelPath": "The local file-system reference model path processed by this operation; it must satisfy the containing component's path and scope policy.", "candidateModelPaths": "The local file-system candidate model paths processed by this operation; it must satisfy the containing component's path and scope policy.", "prompt": "The prompt processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "tolerance": "The tolerance input of type LlamaParityTolerance read by LlamaStorageParityRunner.Run; it must satisfy the member-specific nullability, identity, range, and ownership rules before dependent work begins." }, "returns": "The LlamaStorageParityResult result produced by LlamaStorageParityRunner.Run for this contract: Runs one reference model and one or more candidate models with identical prompt settings. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaSwiGluReference", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaSwiGluReference", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Provides reference SwiGLU behavior.", "remarks": "", "members": [ { "kind": "method", "name": "Apply(System.ReadOnlySpan,System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaSwiGluReference.Apply(System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Applies the SwiGLU activation to validated gate and up-projection vectors.", "remarks": "LlamaSwiGluReference.Apply implements this contract: Applies the SwiGLU activation to validated gate and up-projection vectors. It evaluates gate, up, and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "gate": "The gate sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "up": "The up sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "LlamaTensorBinder", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaTensorBinder", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Binds and validates LLaMA-family GGUF tensors as a schema-validation phase.", "remarks": "", "members": [ { "kind": "method", "name": "Bind(UAIX.LmRuntime.Gguf.GgufModel,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaTensorBinder.Bind(UAIX.LmRuntime.Gguf.GgufModel,UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Binds required tensors from a parsed GGUF artifact using default validation options.", "remarks": "LlamaTensorBinder.Bind implements this contract: Binds required tensors from a parsed GGUF artifact using default validation options. It evaluates model and config before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "The TensorBindingManifest result produced by LlamaTensorBinder.Bind for this contract: Binds required tensors from a parsed GGUF artifact using default validation options. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Bind(UAIX.LmRuntime.Gguf.GgufModel,UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.TensorBindingOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaTensorBinder.Bind(UAIX.LmRuntime.Gguf.GgufModel,UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.TensorBindingOptions)", "summary": "Binds required tensors from a parsed GGUF artifact.", "remarks": "LlamaTensorBinder.Bind implements this contract: Binds required tensors from a parsed GGUF artifact. It evaluates model, config, and options before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "model": "The parsed GGUF model whose validated metadata and tensor catalog are consumed by this operation.", "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "options": "The optional TensorBindingOptions controlling Bind; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The TensorBindingManifest result produced by LlamaTensorBinder.Bind for this contract: Binds required tensors from a parsed GGUF artifact. It is published only after all documented validation and ownership transitions succeed." } ] }, { "name": "LlamaTensorRequirement", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Describes one required LLaMA tensor contract.", "remarks": "", "members": [ { "kind": "property", "name": "BlockIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.BlockIndex", "summary": "Gets the optional block index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedLogicalDimensions", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.ExpectedLogicalDimensions", "summary": "Gets dimensions in logical row-major order for diagnostics and manifests.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedRank", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.ExpectedRank", "summary": "Gets the expected rank.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedStorageDimensions", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.ExpectedStorageDimensions", "summary": "Gets dimensions in GGUF storage order, where dimension zero is the row width.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsOptional", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.IsOptional", "summary": "Gets whether the tensor may be satisfied by an explicit alias rule.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Name", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.Name", "summary": "Gets the required tensor name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaTensorRequirement.Role", "summary": "Gets the tensor role.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaTensorRole", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaTensorRole", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies semantic roles for LLaMA-family tensors.", "remarks": "", "members": [ { "kind": "field", "name": "AttentionKey", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.AttentionKey", "summary": "Per-block key projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "AttentionNorm", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.AttentionNorm", "summary": "Per-block attention normalization scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "AttentionOutput", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.AttentionOutput", "summary": "Per-block attention output projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "AttentionQuery", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.AttentionQuery", "summary": "Per-block query projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "AttentionValue", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.AttentionValue", "summary": "Per-block value projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "FeedForwardDown", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.FeedForwardDown", "summary": "Per-block feed-forward down projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "FeedForwardGate", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.FeedForwardGate", "summary": "Per-block feed-forward gate projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "FeedForwardNorm", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.FeedForwardNorm", "summary": "Per-block feed-forward normalization scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "FeedForwardUp", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.FeedForwardUp", "summary": "Per-block feed-forward up projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Output", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.Output", "summary": "Output projection matrix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "OutputNorm", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.OutputNorm", "summary": "Final output normalization scale.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TokenEmbedding", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaTensorRole.TokenEmbedding", "summary": "Token embedding table.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaWeights", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaWeights", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents model-level LLaMA weights used by reference execution.", "remarks": "", "members": [ { "kind": "property", "name": "OutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaWeights.OutputProjection", "summary": "Gets the output projection matrix in row-major order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.LlamaWeights.TokenEmbeddings", "summary": "Gets token embedding weights.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LlamaWeightSourceValidator", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaWeightSourceValidator", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Validates storage-neutral LLaMA weight sources before deterministic execution begins.", "remarks": "", "members": [ { "kind": "method", "name": "Validate(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.LlamaWeightSourceValidator.Validate(UAIX.LmRuntime.Models.Llama.LlamaModelConfig,UAIX.LmRuntime.Models.Llama.ILlamaModelWeightSource)", "summary": "Validates every global and block-local source against the configured model geometry.", "remarks": "LlamaWeightSourceValidator.Validate implements this contract: Validates every global and block-local source against the configured model geometry. It evaluates config and weights before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation.", "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "" } ] }, { "name": "LlamaWeightStorageMode", "full_name": "UAIX.LmRuntime.Models.Llama.LlamaWeightStorageMode", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies how a bound tensor participates in reference execution.", "remarks": "", "members": [ { "kind": "field", "name": "Alias", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaWeightStorageMode.Alias", "summary": "The tensor aliases another mapped tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "CopiedForReference", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaWeightStorageMode.CopiedForReference", "summary": "The tensor was explicitly copied into a bounded float32 reference buffer.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Mapped", "xml_id": "F:UAIX.LmRuntime.Models.Llama.LlamaWeightStorageMode.Mapped", "summary": "The tensor remains a borrowed view over the mapped GGUF file.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "MappedBFloat16MatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies a brain-float16 matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedBFloat16MatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedBFloat16MatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedBFloat16MatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedBFloat16MatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedBFloat16MatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedBFloat16MatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedBFloat16VectorSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads a brain-float16 vector directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.Length", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.CopyTo(System.Span{System.Single})", "summary": "Copies the to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedBFloat16VectorSource.CopyTo implements this contract: Copies the to into caller-owned storage after validating the requested range and capacity. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedBFloat16VectorSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedBFloat16VectorSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedBFloat16VectorSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedBFloat16VectorSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" } ] }, { "name": "MappedFloat16MatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies an IEEE float16 matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedFloat16MatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedFloat16MatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedFloat16MatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedFloat16MatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat16MatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedFloat16MatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedFloat16VectorSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads an IEEE float16 vector directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.Length", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.CopyTo(System.Span{System.Single})", "summary": "Copies the to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedFloat16VectorSource.CopyTo implements this contract: Copies the to into caller-owned storage after validating the requested range and capacity. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedFloat16VectorSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat16VectorSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedFloat16VectorSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedFloat16VectorSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" } ] }, { "name": "MappedFloat32MatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies an F32 matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedFloat32MatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedFloat32MatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedFloat32MatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedFloat32MatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat32MatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedFloat32MatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedFloat32VectorSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads a float32 vector directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Length", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.Length", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyTo(System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.CopyTo(System.Span{System.Single})", "summary": "Copies the to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedFloat32VectorSource.CopyTo implements this contract: Copies the to into caller-owned storage after validating the requested range and capacity. It evaluates destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedFloat32VectorSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedFloat32VectorSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedFloat32VectorSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedFloat32VectorSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" } ] }, { "name": "MappedLlamaLayerWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes one mapped LLaMA transformer block through storage-neutral execution contracts.", "remarks": "", "members": [ { "kind": "property", "name": "AttentionKey", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.AttentionKey", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.AttentionNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionOutput", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.AttentionOutput", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionQuery", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.AttentionQuery", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AttentionValue", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.AttentionValue", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardDown", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.FeedForwardDown", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.FeedForwardGate", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.FeedForwardNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FeedForwardUp", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.FeedForwardUp", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "MappedLlamaLayerWeightSource(UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedLlamaLayerWeightSource.#ctor(UAIX.LmRuntime.Models.Llama.LlamaBoundLayerWeightSet)", "summary": "Initializes a new MappedLlamaLayerWeightSource instance with validated dependencies and operational bounds.", "remarks": "MappedLlamaLayerWeightSource.MappedLlamaLayerWeightSource establishes the invariants required by this contract: Initializes a new MappedLlamaLayerWeightSource instance with validated dependencies and operational bounds. It evaluates weights before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "" } ] }, { "name": "MappedLlamaModelWeightSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Exposes a complete mapped LLaMA model through storage-neutral execution contracts.", "remarks": "", "members": [ { "kind": "property", "name": "Layers", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.Layers", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.ManagedCopiedByteCount", "summary": "Gets the total number of persistent managed model-weight bytes copied by this source.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputNorm", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.OutputNorm", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "OutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.OutputProjection", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.StorageSummary", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenEmbeddings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.TokenEmbeddings", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesTiedOutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.UsesTiedOutputProjection", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Create(UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.Create(UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet)", "summary": "Creates and validates a complete mapped model weight source.", "remarks": "MappedLlamaModelWeightSource.Create implements this contract: Creates and validates a complete mapped model weight source. It evaluates weights before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "The validated mapped model weight source, with ownership and disposal obligations defined by the returned type and the Create contract." }, { "kind": "method", "name": "MappedLlamaModelWeightSource(UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedLlamaModelWeightSource.#ctor(UAIX.LmRuntime.Models.Llama.LlamaBoundWeightSet)", "summary": "Initializes a new MappedLlamaModelWeightSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied weights before the MappedLlamaModelWeightSource instance becomes observable to callers. Caller-provided collections or buffers are snapshotted where the implementation requires stable ownership, preventing later external mutation from changing established state.", "parameters": { "weights": "The validated model-weight source or bound weight set consumed read-only by the deterministic reference operation." }, "returns": "" } ] }, { "name": "MappedMatrixSourceFactory", "full_name": "UAIX.LmRuntime.Models.Llama.MappedMatrixSourceFactory", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Creates supported matrix sources over mapped tensor views.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedMatrixSourceFactory.Create(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Creates a direct mapped source for supported scalar and quantized storage.", "remarks": "MappedMatrixSourceFactory.Create implements this contract: Creates a direct mapped source for supported scalar and quantized storage. It evaluates view before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "The storage-specific matrix source, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "MappedQ4_0MatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies a Q4_0 matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedQ4_0MatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedQ4_0MatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedQ4_0MatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedQ4_0MatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_0MatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedQ4_0MatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedQ4_KMatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies a Q4_K matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedQ4_KMatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedQ4_KMatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedQ4_KMatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedQ4_KMatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ4_KMatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedQ4_KMatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedQ6_KMatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies a Q6_K matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedQ6_KMatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedQ6_KMatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedQ6_KMatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedQ6_KMatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ6_KMatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedQ6_KMatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedQ8_0MatrixSource", "full_name": "UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Reads and multiplies a Q8_0 matrix directly from a mapped GGUF tensor view.", "remarks": "", "members": [ { "kind": "property", "name": "ColumnCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.ColumnCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.DataType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RowCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.RowCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.StorageDiagnostics", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.StorageType", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CopyRowTo(int,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.CopyRowTo(System.Int32,System.Span{System.Single})", "summary": "Copies the row to into caller-owned storage after validating the requested range and capacity.", "remarks": "MappedQ8_0MatrixSource.CopyRowTo implements this contract: Copies the row to into caller-owned storage after validating the requested range and capacity. It evaluates rowIndex and destination before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "rowIndex": "The zero-based row index; it must identify an existing position within the relevant validated range.", "destination": "The destination buffer that receives the produced values." }, "returns": "" }, { "kind": "method", "name": "MappedQ8_0MatrixSource(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.#ctor(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Initializes a new MappedQ8_0MatrixSource instance with validated dependencies and operational bounds.", "remarks": "Construction validates and records the supplied view before the MappedQ8_0MatrixSource instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "" }, { "kind": "method", "name": "Multiply(System.ReadOnlySpan,System.Span)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedQ8_0MatrixSource.Multiply(System.ReadOnlySpan{System.Single},System.Span{System.Single})", "summary": "Multiplies the supplied vector by the supplied vector without changing logical row order.", "remarks": "MappedQ8_0MatrixSource.Multiply implements this contract: Multiplies the supplied vector by the supplied vector without changing logical row order. It evaluates vector and output before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "vector": "The vector sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "output": "The caller-owned destination buffer that receives the result; required capacity is validated before any write occurs." }, "returns": "" } ] }, { "name": "MappedVectorSourceFactory", "full_name": "UAIX.LmRuntime.Models.Llama.MappedVectorSourceFactory", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Selects a mapped scalar vector implementation from GGML storage metadata.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Gguf.MappedTensorView)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.MappedVectorSourceFactory.Create(UAIX.LmRuntime.Gguf.MappedTensorView)", "summary": "Creates the read only vector source from the validated inputs required by MappedVectorSourceFactory.", "remarks": "MappedVectorSourceFactory.Create implements this contract: Creates the read only vector source from the validated inputs required by MappedVectorSourceFactory. It evaluates view before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "view": "The bounded tensor view whose descriptor, shape, byte order, and mapped payload are read without transferring ownership of the underlying mapping." }, "returns": "The storage-specific vector source, with ownership and disposal obligations defined by the returned type and the Create contract." } ] }, { "name": "RealModelPathPolicy", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelPathPolicy", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Resolves local model paths under an optional root without following hidden network or download behavior.", "remarks": "", "members": [ { "kind": "method", "name": "Resolve(string,string,long)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.RealModelPathPolicy.Resolve(System.String,System.String,System.Int64)", "summary": "Resolves and validates one local model path.", "remarks": "RealModelPathPolicy.Resolve implements this contract: Resolves and validates one local model path. It evaluates path, allowedRoot, and maximumFileByteCount before publishing state or a return value. Filesystem access is restricted to the caller-selected local path after format, containment, and size checks; the method performs no network or provider access.", "parameters": { "path": "The local file-system path processed by this operation; it must satisfy the containing component's path and scope policy.", "allowedRoot": "The normalized caller-authorized directory boundary, or null when no containment root was configured for the operation.", "maximumFileByteCount": "The optional explicit file-size limit; zero disables it." }, "returns": "The text produced by RealModelPathPolicy.Resolve for this contract: Resolves and validates one local model path. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "RealModelSmokeArtifact", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a versioned, machine-readable real-model smoke artifact.", "remarks": "", "members": [ { "kind": "property", "name": "Alignment", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.Alignment", "summary": "Gets the effective GGUF tensor alignment.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Architecture", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.Architecture", "summary": "Gets the model architecture.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BindingDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.BindingDiagnostics", "summary": "Gets binding diagnostic messages.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ClaimStatus", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ClaimStatus", "summary": "Gets the evidence claim status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CommandIdentity", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.CommandIdentity", "summary": "Gets the non-secret command identity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CommitIdentity", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.CommitIdentity", "summary": "Gets the source/commit identity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CompletedStage", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.CompletedStage", "summary": "Gets the deepest completed stage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.Diagnostics", "summary": "Gets bounded workflow diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnvironmentVariableNames", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.EnvironmentVariableNames", "summary": "Gets environment-variable names used by the workflow without values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedOneTokenMatched", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ExpectedOneTokenMatched", "summary": "Gets whether the optional expected one-token evidence matched.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedTokenIdsMatched", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ExpectedTokenIdsMatched", "summary": "Gets whether the optional expected token-identifier evidence matched.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FileByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.FileByteCount", "summary": "Gets the model file length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedUtc", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.GeneratedUtc", "summary": "Gets the generation time in UTC.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgufVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.GgufVersion", "summary": "Gets the parsed GGUF version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LicenseReviewStatus", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.LicenseReviewStatus", "summary": "Gets the operator-supplied license review status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ModelPath", "summary": "Gets the normalized local model path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ModelSha256", "summary": "Gets the optional complete-file SHA-256.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.PackageVersion", "summary": "Gets the package version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.PromptSha256", "summary": "Gets the SHA-256 of the prompt text rather than requiring publication of the raw prompt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenIds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.PromptTokenIds", "summary": "Gets exact prompt token identifiers when tokenization completed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProvenanceLabel", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.ProvenanceLabel", "summary": "Gets the operator-supplied provenance label.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Schema", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.Schema", "summary": "Gets the artifact schema identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedTokenId", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.SelectedTokenId", "summary": "Gets the selected one-token identifier when execution completed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SelectedTokenText", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.SelectedTokenText", "summary": "Gets the selected token text when execution completed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StageEvidence", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.StageEvidence", "summary": "Gets stage timing and current-thread allocation measurements.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageTypeCounts", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.StorageTypeCounts", "summary": "Gets physical tensor counts by GGML storage name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Succeeded", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.Succeeded", "summary": "Gets whether the requested stage completed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerFamily", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.TokenizerFamily", "summary": "Gets the tokenizer family.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnsupportedDiagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeArtifact.UnsupportedDiagnostics", "summary": "Gets exact unsupported execution diagnostics.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RealModelSmokeEnvironment", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeEnvironment", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Creates explicit local smoke options from the documented environment-variable contract.", "remarks": "", "members": [ { "kind": "method", "name": "Load(UAIX.LmRuntime.Models.Llama.RealModelSmokeStage)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.RealModelSmokeEnvironment.Load(UAIX.LmRuntime.Models.Llama.RealModelSmokeStage)", "summary": "Reads the local real-model smoke configuration from environment variables.", "remarks": "RealModelSmokeEnvironment.Load implements this contract: Reads the local real-model smoke configuration from environment variables. It evaluates stage before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "stage": "The explicitly selected real-model smoke stage or stage implementation executed by the controlled pipeline." }, "returns": "The local smoke options, with ownership and disposal obligations defined by the returned type and the Load contract." } ] }, { "name": "RealModelSmokeOptions", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures an explicitly local, opt-in GGUF smoke inspection.", "remarks": "", "members": [ { "kind": "property", "name": "AllowedRoot", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.AllowedRoot", "summary": "Gets an optional root that the resolved model path must remain under.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CommitIdentity", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.CommitIdentity", "summary": "Gets a commit or source identity supplied by the operator.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ComputeModelSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.ComputeModelSha256", "summary": "Gets whether the complete model SHA-256 should be computed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EnvironmentGateName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.EnvironmentGateName", "summary": "Gets the environment variable that enables real-model execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedOneTokenPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.ExpectedOneTokenPath", "summary": "Gets an optional local JSON file containing the expected one-token result.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedTokenIdsPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.ExpectedTokenIdsPath", "summary": "Gets an optional local JSON file containing expected prompt token identifiers.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LicenseReviewStatus", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.LicenseReviewStatus", "summary": "Gets the operator-supplied license review status.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumFileByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.MaximumFileByteCount", "summary": "Gets an optional explicit maximum file length; zero disables this limit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.ModelPath", "summary": "Gets the local GGUF path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PackageVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.PackageVersion", "summary": "Gets the package version recorded in evidence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Prompt", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.Prompt", "summary": "Gets the prompt used by the one-token stage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProvenanceLabel", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.ProvenanceLabel", "summary": "Gets an operator-supplied provenance label.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RedactModelPath", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.RedactModelPath", "summary": "Gets whether the artifact model path is reduced to its file name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RequireEnvironmentGate", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.RequireEnvironmentGate", "summary": "Gets whether the explicit environment gate is required.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Stage", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions.Stage", "summary": "Gets the deepest smoke stage to execute.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RealModelSmokeRunner", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeRunner", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Executes staged, offline real-model validation and emits a bounded evidence artifact.", "remarks": "", "members": [ { "kind": "method", "name": "Run(UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.RealModelSmokeRunner.Run(UAIX.LmRuntime.Models.Llama.RealModelSmokeOptions)", "summary": "Runs the requested local smoke stages in their required order.", "remarks": "The runner is intentionally an orchestration boundary. Validation, stage behavior, measurements, expected evidence parsing, and artifact construction are delegated to focused collaborators so each responsibility can evolve independently without changing the public workflow contract.", "parameters": { "options": "The explicit local smoke options and evidence boundaries." }, "returns": "A bounded machine-readable artifact describing the deepest completed stage." } ] }, { "name": "RealModelSmokeStage", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeStage", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies the deepest stage requested from the local real-model smoke workflow.", "remarks": "", "members": [ { "kind": "field", "name": "OneToken", "xml_id": "F:UAIX.LmRuntime.Models.Llama.RealModelSmokeStage.OneToken", "summary": "Also executes one deterministic greedy token when every storage contract is supported.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ParseOnly", "xml_id": "F:UAIX.LmRuntime.Models.Llama.RealModelSmokeStage.ParseOnly", "summary": "Parses and validates the GGUF container only.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "TensorBinding", "xml_id": "F:UAIX.LmRuntime.Models.Llama.RealModelSmokeStage.TensorBinding", "summary": "Also reconstructs LLaMA geometry and validates required tensor bindings.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "Tokenizer", "xml_id": "F:UAIX.LmRuntime.Models.Llama.RealModelSmokeStage.Tokenizer", "summary": "Also constructs and validates the metadata-driven tokenizer.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RealModelSmokeStageEvidence", "full_name": "UAIX.LmRuntime.Models.Llama.RealModelSmokeStageEvidence", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Records one real-model workflow stage duration and current-thread allocation delta.", "remarks": "", "members": [ { "kind": "property", "name": "ElapsedStopwatchTicks", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeStageEvidence.ElapsedStopwatchTicks", "summary": "Gets elapsed stopwatch ticks.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedAllocatedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeStageEvidence.ManagedAllocatedByteCount", "summary": "Gets managed bytes allocated on the measuring thread.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Stage", "xml_id": "P:UAIX.LmRuntime.Models.Llama.RealModelSmokeStageEvidence.Stage", "summary": "Gets the stage name.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReferenceKvCache", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvCache", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Stores reference key/value state in two contiguous arrays without per-token dictionaries.", "remarks": "", "members": [ { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.ConfigurationFingerprint", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.ContextLength", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HeadWidth", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.HeadWidth", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KeyValueHeadCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.KeyValueHeadCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LayerCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.LayerCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsedTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.UsedTokenCount", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WriteBehavior", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.WriteBehavior", "summary": "", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CreateDiagnosticSnapshot", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.CreateDiagnosticSnapshot", "summary": "Creates a small diagnostic snapshot without exposing mutable key/value arrays.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Caller-owned spans are bounds-checked and do not escape the call.", "parameters": {}, "returns": "The bounded diagnostic snapshot, with ownership and disposal obligations defined by the returned type and the CreateDiagnosticSnapshot contract." }, { "kind": "method", "name": "CreateSnapshot", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.CreateSnapshot", "summary": "Creates the snapshot from the validated inputs required by ReferenceKvCache.", "remarks": "ReferenceKvCache.CreateSnapshot implements this contract: Creates the snapshot from the validated inputs required by ReferenceKvCache. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "The ReferenceKvCacheSnapshot result produced by ReferenceKvCache.CreateSnapshot for this contract: Creates the snapshot from the validated inputs required by ReferenceKvCache. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "GetKey(int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.GetKey(System.Int32,System.Int32,System.Int32)", "summary": "Retrieves the key from the current cache state after validating the requested access.", "remarks": "ReferenceKvCache.GetKey implements this contract: Retrieves the key from the current cache state after validating the requested access. It evaluates layerIndex, position, and headIndex before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "headIndex": "The zero-based head index; it must identify an existing position within the relevant validated range." }, "returns": "The bounded ReadOnlySpan view produced by ReferenceKvCache.GetKey: Retrieves the key from the current cache state after validating the requested access. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "GetValue(int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.GetValue(System.Int32,System.Int32,System.Int32)", "summary": "Retrieves the value from the current cache state after validating the requested access.", "remarks": "ReferenceKvCache.GetValue implements this contract: Retrieves the value from the current cache state after validating the requested access. It evaluates layerIndex, position, and headIndex before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "headIndex": "The zero-based head index; it must identify an existing position within the relevant validated range." }, "returns": "The bounded ReadOnlySpan view produced by ReferenceKvCache.GetValue: Retrieves the value from the current cache state after validating the requested access. Its lifetime and ownership remain tied to the owner identified by the containing type; no out-of-range region is exposed." }, { "kind": "method", "name": "ReferenceKvCache(int,int,int,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.#ctor(System.Int32,System.Int32,System.Int32,System.Int32)", "summary": "Initializes a reference key/value cache with a geometry-derived compatibility fingerprint.", "remarks": "ReferenceKvCache.ReferenceKvCache establishes the invariants required by this contract: Initializes a reference key/value cache with a geometry-derived compatibility fingerprint. It evaluates layerCount, contextLength, keyValueHeadCount, and headWidth before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "layerCount": "The layer count used to bound this operation; it must be nonnegative and within the supported range.", "contextLength": "The context length that supplies session-scoped identity and boundary state; it is validated before dependent work begins.", "keyValueHeadCount": "The number of key/value heads per layer.", "headWidth": "The positive number of scalar values stored for each attention head in one cache position." }, "returns": "" }, { "kind": "method", "name": "ReferenceKvCache(int,int,int,int,string)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.#ctor(System.Int32,System.Int32,System.Int32,System.Int32,System.String)", "summary": "Initializes a reference key/value cache with an explicit model/configuration fingerprint.", "remarks": "Construction validates and records the supplied layer count, the supplied context length, the supplied key value head count, the supplied head width, and the supplied configuration fingerprint before the ReferenceKvCache instance becomes observable to callers. Only the fields explicitly initialized by this constructor become part of the instance state; later operations continue to enforce their own lifecycle and bounds checks.", "parameters": { "layerCount": "The layer count used to bound this operation; it must be nonnegative and within the supported range.", "contextLength": "The context length that supplies session-scoped identity and boundary state; it is validated before dependent work begins.", "keyValueHeadCount": "The number of key/value heads per layer.", "headWidth": "The positive number of scalar values stored for each attention head in one cache position.", "configurationFingerprint": "The configuration fingerprint text consumed by ReferenceKvCache.ReferenceKvCache; null, emptiness, length, encoding, identifier, or path rules are enforced as documented, and the value is not persisted by this operation." }, "returns": "" }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.Reset", "summary": "Resets the reference KV cache contents and logical sequence position to their initial state.", "remarks": "ReferenceKvCache.Reset implements this contract: Resets the reference KV cache contents and logical sequence position to their initial state. It evaluates its explicitly owned state before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot)", "summary": "Restores the supplied snapshot from a validated persisted representation.", "remarks": "ReferenceKvCache.Restore implements this contract: Restores the supplied snapshot from a validated persisted representation. It evaluates snapshot before publishing state or a return value. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases." }, "returns": "" }, { "kind": "method", "name": "Write(int,int,System.ReadOnlySpan,System.ReadOnlySpan)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCache.Write(System.Int32,System.Int32,System.ReadOnlySpan{System.Single},System.ReadOnlySpan{System.Single})", "summary": "Writes the supplied layer index to the current cache state using the component's canonical representation.", "remarks": "ReferenceKvCache.Write implements this contract: Writes the supplied layer index to the current cache state using the component's canonical representation. It evaluates layerIndex, position, key, and value before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract. Mutation is confined to instance-owned fields and begins only after caller-controlled values satisfy the documented invariants.", "parameters": { "layerIndex": "The zero-based layer index; it must identify an existing position within the relevant validated range.", "position": "The zero-based sequence or cache position addressed by the operation; it must lie within the allocated context and readable or writable range.", "key": "The key sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "value": "The value sequence used by this operation; its required length, ordering, and element bounds are validated before access." }, "returns": "" } ] }, { "name": "ReferenceKvCacheDiagnosticSnapshot", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvCacheDiagnosticSnapshot", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a bounded, non-mutable diagnostic view of reference cache state.", "remarks": "", "members": [ { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheDiagnosticSnapshot.ConfigurationFingerprint", "summary": "Gets the configuration fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContentSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheDiagnosticSnapshot.ContentSha256", "summary": "Gets the SHA-256 of the used key/value prefix.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsedTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheDiagnosticSnapshot.UsedTokenCount", "summary": "Gets the used token count.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReferenceKvCacheFingerprint", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvCacheFingerprint", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Computes stable fingerprints for model configurations that own reference key/value cache snapshots.", "remarks": "", "members": [ { "kind": "method", "name": "Create(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheFingerprint.Create(UAIX.LmRuntime.Models.Llama.LlamaModelConfig)", "summary": "Creates a SHA-256 fingerprint from the configuration fields that determine cache geometry and semantics.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Count and range checks precede size-dependent allocation.", "parameters": { "config": "The validated LLaMA model configuration defining context capacity, vocabulary size, tensor geometry, and attention dimensions for the operation." }, "returns": "The text produced by ReferenceKvCacheFingerprint.Create for this contract: Creates a SHA-256 fingerprint from the configuration fields that determine cache geometry and semantics. The returned string is detached from mutable caller storage and is not persisted by the operation." } ] }, { "name": "ReferenceKvCacheSerializer", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Serializes only logically used key/value positions in stable layer-position-head order.", "remarks": "Schema version two is additive and does not change the in-memory version-one snapshot contract retained for source compatibility. Unused capacity is reconstructed as zero during deserialization.", "members": [ { "kind": "field", "name": "DefaultMaximumByteCount", "xml_id": "F:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer.DefaultMaximumByteCount", "summary": "Gets the default maximum serialized snapshot size.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "SchemaVersion", "xml_id": "F:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer.SchemaVersion", "summary": "Gets the portable snapshot schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Deserialize(System.ReadOnlySpan,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer.Deserialize(System.ReadOnlySpan{System.Byte},System.Int32)", "summary": "Deserializes and verifies a portable key/value-cache snapshot.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Caller-owned spans are bounds-checked and do not escape the call; count and range checks precede size-dependent allocation.", "parameters": { "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The ReferenceKvPortableSnapshot result produced by ReferenceKvCacheSerializer.Deserialize for this contract: Deserializes and verifies a portable key/value-cache snapshot. It is published only after all documented validation and ownership transitions succeed." }, { "kind": "method", "name": "Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCache,System.ReadOnlySpan,string,string)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer.Restore(UAIX.LmRuntime.Models.Llama.ReferenceKvCache,System.ReadOnlySpan{System.Byte},System.String,System.String)", "summary": "Restores verified portable bytes into a cache after validating model and layout identities.", "remarks": "ReferenceKvCacheSerializer.Restore implements this contract: Restores verified portable bytes into a cache after validating model and layout identities. It evaluates cache, bytes, expectedModelArtifactFingerprint, and expectedCacheLayoutFingerprint before publishing state or a return value. Caller-owned memory is bounds-checked before access and is not retained beyond the lifetime stated by the return or owner contract.", "parameters": { "cache": "The validated ReferenceKvCache dependency consumed by Restore; ownership and lifetime remain with the caller unless this member explicitly documents a transfer.", "bytes": "The bytes sequence used by this operation; its required length, ordering, and element bounds are validated before access.", "expectedModelArtifactFingerprint": "The expected artifact identity, or an empty string to accept an empty serialized identity.", "expectedCacheLayoutFingerprint": "The required cache-layout fingerprint against which the serialized state is compared before restoration." }, "returns": "" }, { "kind": "method", "name": "Serialize(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot,string,string,int)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSerializer.Serialize(UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot,System.String,System.String,System.Int32)", "summary": "Serializes a bounded cache snapshot in deterministic little-endian form.", "remarks": "The digest is computed from the exact ordered input representation, making repeated evaluation deterministic for byte-identical inputs. Count and range checks precede size-dependent allocation.", "parameters": { "snapshot": "The immutable state snapshot being validated, serialized, restored, or analyzed without retaining caller-owned mutable aliases.", "modelArtifactFingerprint": "The stable model-artifact fingerprint that binds the serialized state to the exact reviewed model identity.", "cacheLayoutFingerprint": "The stable cache-layout fingerprint used to reject state created for incompatible tensor geometry or storage layout.", "maximumByteCount": "The maximum byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "The serialized snapshot bytes including a trailing SHA-256." } ] }, { "name": "ReferenceKvCacheSnapshot", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents an immutable snapshot of a tiny reference key/value cache.", "remarks": "", "members": [ { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.ConfigurationFingerprint", "summary": "Gets the model/configuration fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.ContextLength", "summary": "Gets the context capacity in the snapshot.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HeadWidth", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.HeadWidth", "summary": "Gets the per-head width.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Keys", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.Keys", "summary": "Gets a copy of all key values.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "KeyValueHeadCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.KeyValueHeadCount", "summary": "Gets the key/value head count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LayerCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.LayerCount", "summary": "Gets the number of layers in the snapshot.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SchemaVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.SchemaVersion", "summary": "Gets the snapshot schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsedTokenCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.UsedTokenCount", "summary": "Gets the used token count.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Values", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvCacheSnapshot.Values", "summary": "Gets a copy of all value values.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReferenceKvPortableSnapshot", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Carries a deterministic portable key/value-cache snapshot and its compatibility identities.", "remarks": "", "members": [ { "kind": "property", "name": "CacheLayoutFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.CacheLayoutFingerprint", "summary": "Gets the cache-layout fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ConfigurationFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.ConfigurationFingerprint", "summary": "Gets the model-configuration fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContentSha256", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.ContentSha256", "summary": "Gets the SHA-256 of the serialized bytes preceding the digest field.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelArtifactFingerprint", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.ModelArtifactFingerprint", "summary": "Gets the optional model-artifact fingerprint.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SchemaVersion", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.SchemaVersion", "summary": "Gets the portable schema version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Snapshot", "xml_id": "P:UAIX.LmRuntime.Models.Llama.ReferenceKvPortableSnapshot.Snapshot", "summary": "Gets the restored capacity-shaped snapshot.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "ReferenceKvWriteBehavior", "full_name": "UAIX.LmRuntime.Models.Llama.ReferenceKvWriteBehavior", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies the deterministic write semantics used by the scalar reference key/value cache.", "remarks": "", "members": [ { "kind": "field", "name": "AppendOrOverwrite", "xml_id": "F:UAIX.LmRuntime.Models.Llama.ReferenceKvWriteBehavior.AppendOrOverwrite", "summary": "Writes append new positions and deterministically overwrite already written positions.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorBindingDiagnostic", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingDiagnostic", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a tensor binding diagnostic.", "remarks": "", "members": [ { "kind": "property", "name": "BlockIndex", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingDiagnostic.BlockIndex", "summary": "Gets the optional transformer block index.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Code", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingDiagnostic.Code", "summary": "Gets the diagnostic code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Message", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingDiagnostic.Message", "summary": "Gets the diagnostic message.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingDiagnostic.TensorName", "summary": "Gets the tensor name associated with the diagnostic.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorBindingEntry", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingEntry", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents one bound tensor entry.", "remarks": "", "members": [ { "kind": "property", "name": "AbsoluteOffset", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.AbsoluteOffset", "summary": "Gets the absolute source-file offset.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ByteLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.ByteLength", "summary": "Gets the physical storage byte length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.DataType", "summary": "Gets the mapped runtime data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Descriptor", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.Descriptor", "summary": "Gets the GGUF tensor descriptor supplying storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsAlias", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.IsAlias", "summary": "Gets whether this binding aliases another tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LogicalDimensions", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.LogicalDimensions", "summary": "Gets the normalized logical dimensions.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Ownership", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.Ownership", "summary": "Gets the ownership contract.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Requirement", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.Requirement", "summary": "Gets the tensor requirement.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SourceTensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.SourceTensorName", "summary": "Gets the source tensor name when this binding is an alias.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageKind", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingEntry.StorageKind", "summary": "Gets the storage kind.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorBindingException", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingException", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents a failed LLaMA tensor schema binding operation.", "remarks": "", "members": [ { "kind": "property", "name": "Manifest", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingException.Manifest", "summary": "Gets the failed binding manifest.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "TensorBindingException(UAIX.LmRuntime.Models.Llama.TensorBindingManifest)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.TensorBindingException.#ctor(UAIX.LmRuntime.Models.Llama.TensorBindingManifest)", "summary": "Initializes a binding exception from a failed manifest.", "remarks": "TensorBindingException.TensorBindingException establishes the invariants required by this contract: Initializes a binding exception from a failed manifest. It evaluates manifest before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "manifest": "The validated manifest that binds tensor requirements, model identity, and storage diagnostics used by the operation." }, "returns": "" } ] }, { "name": "TensorBindingManifest", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingManifest", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Represents the result of LLaMA tensor binding.", "remarks": "", "members": [ { "kind": "property", "name": "Bindings", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingManifest.Bindings", "summary": "Gets bound tensor entries.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Diagnostics", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingManifest.Diagnostics", "summary": "Gets binding diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsComplete", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingManifest.IsComplete", "summary": "Gets a value indicating whether every required tensor was bound without diagnostics.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ThrowIfIncomplete", "xml_id": "M:UAIX.LmRuntime.Models.Llama.TensorBindingManifest.ThrowIfIncomplete", "summary": "Throws when the manifest contains one or more diagnostics.", "remarks": "TensorBindingManifest.ThrowIfIncomplete implements this contract: Throws when the manifest contains one or more diagnostics. It evaluates its explicitly owned state before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "TryGetBinding(UAIX.LmRuntime.Models.Llama.LlamaTensorRole,System.Nullable,UAIX.LmRuntime.Models.Llama.TensorBindingEntry@)", "xml_id": "M:UAIX.LmRuntime.Models.Llama.TensorBindingManifest.TryGetBinding(UAIX.LmRuntime.Models.Llama.LlamaTensorRole,System.Nullable{System.Int32},UAIX.LmRuntime.Models.Llama.TensorBindingEntry@)", "summary": "Attempts to find one bound tensor by semantic role and optional block index.", "remarks": "TensorBindingManifest.TryGetBinding implements this contract: Attempts to find one bound tensor by semantic role and optional block index. It evaluates role, blockIndex, and entry before publishing state or a return value. Caller-controlled ranges and identities are validated before dependent work, and failure does not expose a partially accepted result or retain mutable input aliases.", "parameters": { "role": "The semantic LLaMA tensor role used to select the required bound tensor from the validated manifest.", "blockIndex": "The zero-based block index; it must identify an existing position within the relevant validated range.", "entry": "When the method returns, contains the entry produced by the operation when successful; otherwise contains the type's default value." }, "returns": "True when try get binding succeeds for the supplied values; otherwise, false." } ] }, { "name": "TensorBindingOptions", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingOptions", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Configures semantic validation performed by UAIX.LmRuntime.Models.Llama.LlamaTensorBinder.", "remarks": "", "members": [ { "kind": "property", "name": "AllowTiedOutputProjection", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingOptions.AllowTiedOutputProjection", "summary": "Gets whether a missing output.weight may alias token_embd.weight.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ValidateByteLengths", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingOptions.ValidateByteLengths", "summary": "Gets whether physical byte lengths must match the registered tensor type traits.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ValidateFileBounds", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingOptions.ValidateFileBounds", "summary": "Gets whether tensor ranges must fit inside the parsed source file length when available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ValidateSemanticShapes", "xml_id": "P:UAIX.LmRuntime.Models.Llama.TensorBindingOptions.ValidateSemanticShapes", "summary": "Gets whether dimensions derived from model metadata must match the GGUF storage shape.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorBindingOwnership", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingOwnership", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies ownership for a bound tensor payload.", "remarks": "", "members": [ { "kind": "field", "name": "BorrowedAlias", "xml_id": "F:UAIX.LmRuntime.Models.Llama.TensorBindingOwnership.BorrowedAlias", "summary": "The binding borrows storage through another tensor binding.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "BorrowedModelStorage", "xml_id": "F:UAIX.LmRuntime.Models.Llama.TensorBindingOwnership.BorrowedModelStorage", "summary": "The binding borrows storage owned by the loaded model.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "TensorBindingStorageKind", "full_name": "UAIX.LmRuntime.Models.Llama.TensorBindingStorageKind", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Identifies where a bound tensor payload is stored.", "remarks": "", "members": [ { "kind": "field", "name": "Alias", "xml_id": "F:UAIX.LmRuntime.Models.Llama.TensorBindingStorageKind.Alias", "summary": "The tensor is an alias of another bound tensor.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MemoryMappedFile", "xml_id": "F:UAIX.LmRuntime.Models.Llama.TensorBindingStorageKind.MemoryMappedFile", "summary": "The tensor remains in the GGUF memory-mapped artifact.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "WeightSourceStorageDiagnostics", "full_name": "UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics", "namespace": "UAIX.LmRuntime.Models.Llama", "summary": "Describes immutable storage used by one deterministic reference weight source.", "remarks": "", "members": [ { "kind": "property", "name": "ByteLength", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.ByteLength", "summary": "Gets the physical byte length.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DataType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.DataType", "summary": "Gets the logical runtime data type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsAlias", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.IsAlias", "summary": "Gets a value indicating whether this source aliases another semantic binding.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsMemoryMapped", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.IsMemoryMapped", "summary": "Gets a value indicating whether the source borrows memory-mapped storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ManagedCopiedByteCount", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.ManagedCopiedByteCount", "summary": "Gets the number of bytes copied into persistent managed model-weight storage.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageType", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.StorageType", "summary": "Gets the GGML physical storage type.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TensorName", "xml_id": "P:UAIX.LmRuntime.Models.Llama.WeightSourceStorageDiagnostics.TensorName", "summary": "Gets the semantic tensor name.", "remarks": "", "parameters": {}, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Backends.CpuManaged", "types": [ { "name": "CpuManagedRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.CpuManaged", "summary": "Reports the UAIX managed CPU backend to the acceleration registry.", "remarks": "This backend represents compatibility required for systems without GPUs. It does not require GPU hardware, GPU drivers, native runtime libraries, provider APIs, subprocess execution, or model downloads.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.Capabilities", "summary": "Gets the backend capability declaration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "DisplayName", "xml_id": "P:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.DisplayName", "summary": "Gets the human-readable backend name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Id", "xml_id": "P:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.Id", "summary": "Gets the stable backend identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Kind", "xml_id": "P:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.Kind", "summary": "Gets the backend kind.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CpuManagedRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.Backends.CpuManaged.CpuManagedRuntimeBackend.ProbeAsync(UAIX.LmRuntime.Acceleration.RuntimeBackendOptions,System.Threading.CancellationToken)", "summary": "Probes the managed.NET backend for local execution availability.", "remarks": "The managed.NET backend is available when the package is loaded because the system-without-GPUs compatibility lane has no GPU, driver, or native asset dependency.", "parameters": { "options": "The caller-supplied probing and selection options.", "cancellationToken": "A token that cancels the probe." }, "returns": "The available CPU probe result." } ] }, { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.CpuManaged.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.CpuManaged", "summary": "Provides registration helpers for the managed CPU backend.", "remarks": "Hosts can call this helper to make CPU fallback explicit in the acceleration registry.", "members": [ { "kind": "method", "name": "AddUaixCpuManagedBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.CpuManaged.RuntimeBackendRegistryExtensions.AddUaixCpuManagedBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX managed CPU backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] } ] }, { "id": "UAIX.LmRuntime.Backends.Cuda", "types": [ { "name": "CudaRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.Cuda.CudaRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.Cuda", "summary": "Reports CUDA backend compatibility and diagnostics to the acceleration registry.", "remarks": "This package does not contain hidden CUDA inference binaries. Native assets and device proof must come from a declared native package or host adapter before CUDA execution can be selected.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.Cuda.CudaRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CudaRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.Cuda.CudaRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.Cuda.CudaRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.Cuda.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.Cuda", "summary": "Provides registration helpers for the CUDA backend.", "remarks": "Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.", "members": [ { "kind": "method", "name": "AddUaixCudaBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.Cuda.RuntimeBackendRegistryExtensions.AddUaixCudaBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX CUDA backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] } ] }, { "id": "UAIX.LmRuntime.Backends.DirectML", "types": [ { "name": "DirectMlRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.DirectML.DirectMlRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.DirectML", "summary": "Reports DirectML backend compatibility and diagnostics to the acceleration registry.", "remarks": "DirectML support is declared as a package-visible compatibility path for Windows hosts. This package performs no hidden native inference and reports unavailable until a host supplies native runtime and device evidence.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.DirectML.DirectMlRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "DirectMlRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.DirectML.DirectMlRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.DirectML.DirectMlRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.DirectML.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.DirectML", "summary": "Provides registration helpers for the DirectML backend.", "remarks": "Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.", "members": [ { "kind": "method", "name": "AddUaixDirectMlBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.DirectML.RuntimeBackendRegistryExtensions.AddUaixDirectMlBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX DirectML backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] } ] }, { "id": "UAIX.LmRuntime.Backends.Vulkan", "types": [ { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.Vulkan.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.Vulkan", "summary": "Provides registration helpers for the Vulkan backend.", "remarks": "Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.", "members": [ { "kind": "method", "name": "AddUaixVulkanBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.Vulkan.RuntimeBackendRegistryExtensions.AddUaixVulkanBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX Vulkan backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] }, { "name": "VulkanRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.Vulkan.VulkanRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.Vulkan", "summary": "Reports Vulkan backend compatibility and diagnostics to the acceleration registry.", "remarks": "Vulkan support is declared for vendor-diverse hardware. This package does not contain hidden Vulkan inference binaries and reports unavailable until runtime and device evidence exists.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.Vulkan.VulkanRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "VulkanRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.Vulkan.VulkanRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.Vulkan.VulkanRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" } ] } ] }, { "id": "UAIX.LmRuntime.Backends.Rocm", "types": [ { "name": "RocmRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.Rocm.RocmRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.Rocm", "summary": "Reports ROCm backend compatibility and diagnostics to the acceleration registry.", "remarks": "ROCm support is declared for AMD GPU systems. This package does not contain hidden ROCm inference binaries and reports unavailable until runtime and device evidence exists.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.Rocm.RocmRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "RocmRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.Rocm.RocmRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.Rocm.RocmRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.Rocm.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.Rocm", "summary": "Provides registration helpers for the ROCm backend.", "remarks": "Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.", "members": [ { "kind": "method", "name": "AddUaixRocmBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.Rocm.RuntimeBackendRegistryExtensions.AddUaixRocmBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX ROCm backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] } ] }, { "id": "UAIX.LmRuntime.Backends.Metal", "types": [ { "name": "MetalRuntimeBackend", "full_name": "UAIX.LmRuntime.Backends.Metal.MetalRuntimeBackend", "namespace": "UAIX.LmRuntime.Backends.Metal", "summary": "Reports Metal backend compatibility and diagnostics to the acceleration registry.", "remarks": "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.", "members": [ { "kind": "field", "name": "BackendId", "xml_id": "F:UAIX.LmRuntime.Backends.Metal.MetalRuntimeBackend.BackendId", "summary": "The stable backend identifier used by selection policies.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "MetalRuntimeBackend", "xml_id": "M:UAIX.LmRuntime.Backends.Metal.MetalRuntimeBackend.#ctor", "summary": "Initializes a new instance of the UAIX.LmRuntime.Backends.Metal.MetalRuntimeBackend class.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "RuntimeBackendRegistryExtensions", "full_name": "UAIX.LmRuntime.Backends.Metal.RuntimeBackendRegistryExtensions", "namespace": "UAIX.LmRuntime.Backends.Metal", "summary": "Provides registration helpers for the Metal backend.", "remarks": "Registration only exposes diagnostics and selection metadata. It does not authorize hidden native execution.", "members": [ { "kind": "method", "name": "AddUaixMetalBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "xml_id": "M:UAIX.LmRuntime.Backends.Metal.RuntimeBackendRegistryExtensions.AddUaixMetalBackend(UAIX.LmRuntime.Acceleration.IRuntimeBackendRegistry)", "summary": "Adds the UAIX Metal backend to a registry.", "remarks": "", "parameters": { "registry": "The registry to update." }, "returns": "The same registry instance for fluent configuration." } ] } ] }, { "id": "UAIX.LmRuntime.Backends.Cuda.Native.win-x64", "types": [] }, { "id": "UAIX.LmRuntime.Backends.Cuda.LegacyK80.win-x64", "types": [] }, { "id": "UAIX.LmRuntime.LocalEndpoint", "types": [ { "name": "LocalGgufAssociatedArtifactIdentity", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactIdentity", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents the path-free verified identity of one associated model artifact.", "remarks": "The identity is constructed only after the runtime verifies the current associated artifact file under the same local path, containment, reparse-point, stable-length, byte-count, and SHA-256 rules used for primary model admission. It deliberately omits private paths, file bytes, prompt content, generated content, UAIX content, registry state, and audit state.", "members": [ { "kind": "property", "name": "ArtifactByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactIdentity.ArtifactByteCount", "summary": "Gets the verified current associated-artifact file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ArtifactSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactIdentity.ArtifactSha256", "summary": "Gets the normalized lowercase SHA-256 digest verified from current associated-artifact bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FileName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactIdentity.FileName", "summary": "Gets the reviewed associated-artifact leaf file name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactIdentity.Role", "summary": "Gets the caller-owned artifact role label copied into path-free evidence.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufAssociatedArtifactLoadInput", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Supplies one LocalEndpoint-reviewed associated artifact for verification by the managed runtime facade.", "remarks": "The private path is accepted only as an input needed to verify current local bytes. The returned verification identity omits the path and contains only display-safe role, file name, SHA-256, and byte-count evidence.", "members": [ { "kind": "property", "name": "ArtifactByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.ArtifactByteCount", "summary": "Gets the required current associated artifact file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ArtifactPath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.ArtifactPath", "summary": "Gets the private direct-local path to the associated artifact file that LocalEndpoint already reviewed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ArtifactSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.ArtifactSha256", "summary": "Gets the required SHA-256 digest for the current associated artifact file.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FileName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.FileName", "summary": "Gets the reviewed leaf file name expected at UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.ArtifactPath.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Role", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput.Role", "summary": "Gets the caller-owned role label for the associated artifact.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufExecutionLimits", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufExecutionLimits", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Defines caller-visible resource ceilings for one verified model owner.", "remarks": "The limits are enforced before large generation buffers are allocated. They supplement, but do not replace, the model context-window checks performed by the underlying deterministic runtime.", "members": [ { "kind": "property", "name": "MaximumGeneratedTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufExecutionLimits.MaximumGeneratedTokens", "summary": "Gets the maximum generated-token buffer length permitted for one operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumPromptCharacters", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufExecutionLimits.MaximumPromptCharacters", "summary": "Gets the maximum accepted prepared-prompt length in.NET UTF-16 code units.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumStopTokenCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufExecutionLimits.MaximumStopTokenCount", "summary": "Gets the maximum number of caller-defined stop-token identifiers permitted for one operation.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufFileExpectation", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Declares the path-free model-file evidence that LocalEndpoint requires before loading or reusing a model.", "remarks": "The contract contains only a SHA-256 digest and byte count. It intentionally excludes the private model path, model bytes, prompt content, generated content, registry state, audit state, and UAIX package data. Runtime entry points validate both values against current file bytes before model parsing or cached-model reuse.", "members": [ { "kind": "property", "name": "ModelByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation.ModelByteCount", "summary": "Gets the required current model file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation.ModelSha256", "summary": "Gets the required SHA-256 digest for the current local model file.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufFileIdentity", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufFileIdentity", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents the verified content identity of one current local GGUF file.", "remarks": "The result contains only a digest and byte count. It deliberately omits the local path, model bytes, prompt content, generated content, UAIX state, and caller policy so it can be copied into LocalEndpoint evidence without expanding the runtime's persistence or trust responsibilities.", "members": [ { "kind": "property", "name": "ModelByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufFileIdentity.ModelByteCount", "summary": "Gets the verified current file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufFileIdentity.ModelSha256", "summary": "Gets the normalized lowercase SHA-256 digest verified from current file bytes.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufGeneratedToken", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Describes one generated token selected by the managed runtime for caller-owned streaming.", "remarks": "The value intentionally excludes prompt text, decoded output, model paths, UAIX content, registry state, audit state, and transport details. LocalEndpoint remains responsible for detokenization policy, worker-event mapping, terminal-event policy, and persistence boundaries.", "members": [ { "kind": "property", "name": "SelectedLogit", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken.SelectedLogit", "summary": "Gets the deterministic argmax logit associated with the selected token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Sequence", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken.Sequence", "summary": "Gets the zero-based selection sequence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken.TokenId", "summary": "Gets the selected model vocabulary identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "LocalGgufGeneratedToken(int,int,float)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken.#ctor(System.Int32,System.Int32,System.Single)", "summary": "Initializes a new LocalGgufGeneratedToken instance with validated dependencies and operational bounds.", "remarks": "The constructor performs no I/O and retains no reference to the model, session, callback, or caller state.", "parameters": { "sequence": "The zero-based selection sequence within the current generation operation.", "tokenId": "The token identifier to process; it must fall within the validated vocabulary and operation-specific range.", "selectedLogit": "The deterministic argmax logit associated with the selected token. NaN is rejected; positive and negative infinity are retained because the lower-level greedy sampler compares infinities deterministically and the runtime verifies the exact observed value against the completed generation result." }, "returns": "" } ] }, { "name": "LocalGgufGenerationRequest", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Defines one bounded deterministic greedy-generation request.", "remarks": "The request contains only in-memory generation controls. It does not define persistence, network, provider, process, server, telemetry, or model-download behavior.", "members": [ { "kind": "property", "name": "AddSpecialTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.AddSpecialTokens", "summary": "Gets whether model-defined special-token insertion is enabled for the prompt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CleanSpaces", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.CleanSpaces", "summary": "Gets whether tokenizer-defined spacing cleanup is applied during detokenization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EmitTokenizerTrace", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.EmitTokenizerTrace", "summary": "Gets whether tokenizer trace entries are captured for the prompt.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EndOfSequenceTokenId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.EndOfSequenceTokenId", "summary": "Gets the optional explicit end-of-sequence token identifier; when omitted, model metadata is used.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "InvalidUtf16Policy", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.InvalidUtf16Policy", "summary": "Gets the invalid UTF-16 handling policy used during tokenization.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.MaximumTokens", "summary": "Gets the positive maximum number of tokens to generate.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.ParseSpecialTokens", "summary": "Gets whether special-token text embedded in the prompt is parsed as a special token.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Prompt", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.Prompt", "summary": "Gets the exact prepared prompt to tokenize in memory.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RemoveSpecialTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.RemoveSpecialTokens", "summary": "Gets whether special tokens are removed from decoded generated text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ResetSession", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.ResetSession", "summary": "Gets whether the session is reset before prompt prefill.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopTokenIds", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.StopTokenIds", "summary": "Gets additional token identifiers that terminate generation after being emitted.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnparseSpecialTokens", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest.UnparseSpecialTokens", "summary": "Gets whether special tokens are emitted as their raw token text when they are not removed.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufGenerationResult", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents deterministic generated token identifiers and their decoded text.", "remarks": "", "members": [ { "kind": "property", "name": "FinalSelectedLogit", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.FinalSelectedLogit", "summary": "Gets the selected logit of the final generated token, or negative infinity when no token was generated.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedText", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.GeneratedText", "summary": "Gets the decoded generated text.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GeneratedTokenIds", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.GeneratedTokenIds", "summary": "Gets the generated token identifiers in selection order.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.Position", "summary": "Gets the next sequence position retained by the isolated session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PromptTokenCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.PromptTokenCount", "summary": "Gets the number of prompt tokens evaluated for the operation.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StopReason", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationResult.StopReason", "summary": "Gets the deterministic generation stop reason.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufModel", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufModel", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Owns one verified mapped GGUF model and creates isolated deterministic inference sessions.", "remarks": "", "members": [ { "kind": "property", "name": "ActiveSessionCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.ActiveSessionCount", "summary": "Gets the number of caller-owned sessions that have not yet been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExecutionLimits", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.ExecutionLimits", "summary": "Gets the immutable prompt and generation ceilings copied when this model was loaded.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.IsDisposed", "summary": "Gets a value indicating whether this model owner has been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Metadata", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.Metadata", "summary": "Gets verified model and runtime metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scope", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.Scope", "summary": "Gets the opaque application scope and optional legacy package label associated with this model owner.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerMetadata", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.TokenizerMetadata", "summary": "Gets the bounded tokenizer metadata projection.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "CreateSession", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.CreateSession", "summary": "Rejects creation of a LocalEndpoint inference session when required UAIX load-session context is absent.", "remarks": "The parameterless member remains as a fail-closed source-compatibility boundary for earlier integrations. New callers must use CreateSession(LocalGgufSessionContext). Model loading and model caching may occur independently, but inference-session creation cannot proceed without an isolated profile/load-session identity.", "parameters": {}, "returns": "No value is returned; this compatibility member always throws to require an explicit session-scoped UAIX context." }, { "kind": "method", "name": "CreateSession(UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.CreateSession(UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext)", "summary": "Creates a new inference session with independent sequence state and validated UAIX load-session evidence.", "remarks": "Validation performs no.uaix,.uai, or wiki file access. The returned session retains only the validated worker session identifier and path-relative context evidence. Separate sessions may carry different LocalEndpoint profiles without creating process-global profile state.", "parameters": { "sessionContext": "The LocalEndpoint worker session identifier and display-safe UAIX context." }, "returns": "An isolated deterministic session owned by the caller." }, { "kind": "method", "name": "Decode(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.Decode(System.Collections.Generic.IReadOnlyList{System.Int32},UAIX.LmRuntime.Tokenization.MetadataDrivenGgufTokenizerDetokenizationOptions)", "summary": "Decodes token identifiers using the tokenizer metadata from the verified GGUF artifact.", "remarks": "The method snapshots and validates the complete caller-owned sequence before entering the model lifecycle lock. The private snapshot is cleared after every successful decode, tokenizer failure, lifecycle rejection, or disposal race. Only the returned immutable System.String remains caller-visible; the runtime does not persist the token sequence or decoded text.", "parameters": { "tokenIds": "The token identifiers to decode in sequence order.", "options": "The optional MetadataDrivenGgufTokenizerDetokenizationOptions controlling Decode; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The decoded text produced from the validated token sequence in the original sequence order." }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.Dispose", "summary": "Releases the memory-mapped model after all child sessions have been disposed.", "remarks": "Disposal is idempotent and serialized with direct tokenization and detokenization. A failed underlying dispose leaves the wrapper undisposed so the caller may retain an accurate lifecycle state and retry cleanup.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Tokenize(string,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.Tokenize(System.String,UAIX.LmRuntime.Tokenization.TokenizationOptions)", "summary": "Tokenizes text using exact metadata loaded from the verified GGUF artifact.", "remarks": "LocalGgufModel.Tokenize implements this contract: Tokenizes text using exact metadata loaded from the verified GGUF artifact. It evaluates text and options before publishing state or a return value. Concurrency-sensitive state transitions use the existing synchronization boundary and do not publish an intermediate lifecycle state.", "parameters": { "text": "The text processed by the configured encoding or normalization rules; it must satisfy the declared nullability contract.", "options": "The optional TokenizationOptions controlling Tokenize; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "The exact integer token identifiers and optional trace." } ] }, { "name": "LocalGgufModelLoadOptions", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Configures loading of one trusted local GGUF artifact through the LocalEndpoint-facing managed runtime surface.", "remarks": "The options govern local file validation and bounded managed execution only. They do not enable downloading, remote inference, process launch, telemetry, server hosting, or persistent runtime state.", "members": [ { "kind": "property", "name": "AllowedRootDirectory", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.AllowedRootDirectory", "summary": "Gets the optional normalized directory that must contain the resolved GGUF file.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BindingOptions", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.BindingOptions", "summary": "Gets semantic LLaMA tensor-binding validation controls.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExecutionLimits", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.ExecutionLimits", "summary": "Gets the prompt, generated-token, and stop-token ceilings enforced by sessions created from the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumModelBytes", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.MaximumModelBytes", "summary": "Gets the maximum accepted model file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MaximumReferenceMaterializationBytes", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.MaximumReferenceMaterializationBytes", "summary": "Gets the maximum number of bytes that compatibility-only float32 materialization may allocate.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParseOptions", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.ParseOptions", "summary": "Gets GGUF parser safety limits.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RejectReparsePoints", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions.RejectReparsePoints", "summary": "Gets a value indicating whether symbolic links and reparse points are rejected before the file is opened.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufModelMetadata", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Describes the verified model and execution metadata exposed to the LocalEndpoint worker adapter.", "remarks": "", "members": [ { "kind": "property", "name": "Architecture", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.Architecture", "summary": "Gets the model architecture identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AssociatedArtifacts", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.AssociatedArtifacts", "summary": "Gets the verified path-free identities of associated model artifacts supplied by LocalEndpoint.", "remarks": "The collection contains no local paths and does not imply that companion artifacts changed token generation. LocalEndpoint remains responsible for deciding which artifacts are meaningful for a model family and for preserving registry, audit, and worker evidence.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BoundTensorCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.BoundTensorCount", "summary": "Gets the number of tensors accepted by semantic binding.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextLength", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.ContextLength", "summary": "Gets the configured context length in tokens.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "GgufVersion", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.GgufVersion", "summary": "Gets the GGUF container version.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.ModelByteCount", "summary": "Gets the verified model file length in bytes.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.ModelName", "summary": "Gets the optional model display name from GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ModelSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.ModelSha256", "summary": "Gets the lowercase SHA-256 digest verified before model loading.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "StorageSummary", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.StorageSummary", "summary": "Gets the mapped storage summary used by the managed reference runtime.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Tokenizer", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.Tokenizer", "summary": "Gets the exact tokenizer implementation name selected from GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VocabularySize", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufModelMetadata.VocabularySize", "summary": "Gets the configured vocabulary size.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufRuntime", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Loads verified local GGUF files into isolated pure-managed LLaMA runtime models.", "remarks": "This type performs local file validation and direct managed model loading only. It contains no subprocess, network, provider, telemetry, server, downloader, command-dispatch, or persistent-profile behavior. The type holds no static mutable model, session, profile, or wiki state. Separate application instances can therefore load independent models and bind each inference session to a distinct LocalEndpoint-owned UAIX load session.", "members": [ { "kind": "property", "name": "Capabilities", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.Capabilities", "summary": "Gets the fixed local-only capability declaration.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Scope", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.Scope", "summary": "Gets the opaque caller-owned runtime scope.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "LoadVerifiedModel(string,string,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.LoadVerifiedModel(System.String,System.String,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Loads a local GGUF model only after its exact SHA-256 digest and file-policy constraints are verified.", "remarks": "The complete model digest is recomputed before loading and is also requested from the mapped loader. This prevents a caller from treating a path or manifest declaration as proof that current file bytes are trusted.", "parameters": { "modelPath": "The local file-system model path processed by this operation; it must satisfy the containing component's path and scope policy.", "expectedSha256": "The expected lowercase or uppercase 64-character SHA-256 digest used to authenticate the complete artifact; a mismatch fails the operation before a trusted result is published.", "options": "Optional bounded parser, binding, containment, and file-validation controls." }, "returns": "An owned mapped model that must be disposed after all child sessions are disposed." }, { "kind": "method", "name": "LoadVerifiedModel(string,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.LoadVerifiedModel(System.String,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput},UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Loads a local GGUF model after binding the primary artifact and associated artifacts to caller-owned evidence.", "remarks": "Associated artifact verification completes before GGUF parsing and before the mapped model owner is published. The runtime records only path-free associated-artifact identities in model metadata; companion artifacts do not alter token generation in this package slice.", "parameters": { "modelPath": "The local file-system model path processed by this operation; it must satisfy the containing component's path and scope policy.", "expectation": "The path-free digest and byte-count evidence required by LocalEndpoint for the primary GGUF artifact.", "associatedArtifacts": "The LocalEndpoint-reviewed associated artifacts to verify before the model is published.", "options": "Optional bounded parser, binding, containment, and file-validation controls." }, "returns": "An owned mapped model that must be disposed after all child sessions are disposed." }, { "kind": "method", "name": "LoadVerifiedModel(string,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.LoadVerifiedModel(System.String,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Loads a local GGUF model after binding current file bytes to caller-owned digest and byte-count evidence.", "remarks": "Both evidence values are validated before GGUF parsing. The mapped loader then recomputes the digest so a file change across the load boundary remains fail closed. The private path is never exposed by the returned model.", "parameters": { "modelPath": "The local file-system model path processed by this operation; it must satisfy the containing component's path and scope policy.", "expectation": "The path-free digest and byte-count evidence required by LocalEndpoint.", "options": "Optional bounded parser, binding, containment, and file-validation controls." }, "returns": "An owned mapped model that must be disposed after all child sessions are disposed." }, { "kind": "method", "name": "LocalGgufRuntime", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.#ctor", "summary": "Initializes an unscoped model facade for compatibility with callers that do not require application labels.", "remarks": "The default scope is an in-memory label only. UAIX profile and load-session metadata is still mandatory when creating an inference session through LocalGgufModel.CreateSession(LocalGgufSessionContext).", "parameters": {}, "returns": "" }, { "kind": "method", "name": "LocalGgufRuntime(UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.#ctor(UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope)", "summary": "Initializes a runtime facade for one LocalEndpoint application instance and optional legacy package label.", "remarks": "Scope values are retained in memory only. They are not used as an active profile, load session, wiki route, or authority source and are never used to open, parse, persist, or synchronize UAIX files.", "parameters": { "scope": "The immutable runtime scope whose name and instance identifier are validated once and then retained as path-free correlation evidence for model verification operations." }, "returns": "" }, { "kind": "method", "name": "VerifyAssociatedArtifacts(System.Collections.Generic.IReadOnlyList,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.VerifyAssociatedArtifacts(System.Collections.Generic.IReadOnlyList{UAIX.LmRuntime.LocalEndpoint.LocalGgufAssociatedArtifactLoadInput},UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Verifies LocalEndpoint-reviewed associated artifacts without exposing private local paths.", "remarks": "The runtime validates role labels, leaf file names, direct-local paths, allowed-root containment, reparse-point policy, byte-count evidence, stable file length, and SHA-256 evidence. It does not parse the associated artifacts, persist evidence, alter generation behavior, open UAIX packages, read expanded memory files, call providers, start processes, access a network, or interpret the artifacts as policy.", "parameters": { "associatedArtifacts": "The LocalEndpoint-reviewed associated artifact load inputs to verify before model publication or worker execution proceeds.", "options": "Optional bounded parser, binding, containment, and file-validation controls shared with primary model verification." }, "returns": "Path-free associated-artifact identities sorted by role, file name, and SHA-256 digest." }, { "kind": "method", "name": "VerifyLocalModelFile(string,string,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.VerifyLocalModelFile(System.String,System.String,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Verifies the current bytes and file-policy boundaries of one local GGUF artifact without loading a model.", "remarks": "LocalEndpoint can call this operation immediately before reusing a cached model to prove that current on-disk bytes still match its registry and manifest evidence. The returned value contains no local path. Verification does not parse GGUF content, create a session, execute inference, start a process, access a network, or persist evidence. The caller remains responsible for binding this observation to its own evidence receipt and timing.", "parameters": { "modelPath": "The local file-system model path processed by this operation; it must satisfy the containing component's path and scope policy.", "expectedSha256": "The expected lowercase or uppercase 64-character SHA-256 digest used to authenticate the complete artifact; a mismatch fails the operation before a trusted result is published.", "options": "The optional LocalGgufModelLoadOptions controlling VerifyLocalModelFile; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "A path-free identity containing the verified digest and current byte count." }, { "kind": "method", "name": "VerifyLocalModelFile(string,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.VerifyLocalModelFile(System.String,UAIX.LmRuntime.LocalEndpoint.LocalGgufFileExpectation,UAIX.LmRuntime.LocalEndpoint.LocalGgufModelLoadOptions)", "summary": "Verifies current local model bytes against caller-owned digest and byte-count evidence without loading a model.", "remarks": "This overload binds both values supplied by LocalEndpoint readiness or manifest evidence to one current file observation. Verification remains path-free at the public boundary and performs no parsing or inference.", "parameters": { "modelPath": "The local file-system model path processed by this operation; it must satisfy the containing component's path and scope policy.", "expectation": "The path-free digest and byte-count evidence required by LocalEndpoint.", "options": "The optional LocalGgufModelLoadOptions controlling VerifyLocalModelFile; null selects the documented defaults, supplied limits are validated before allocation, and the instance is not mutated." }, "returns": "A path-free identity containing the verified digest and current byte count." }, { "kind": "method", "name": "VerifyUaixRuntimeContext(UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime.VerifyUaixRuntimeContext(UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext)", "summary": "Validates LocalEndpoint-supplied uaixRuntimeContext metadata without opening package or wiki files.", "remarks": "LocalEndpoint remains responsible for validating and importing the.uaix package, expanding accepted.uai files, selecting the Documents-backed wiki root, assembling the prompt, and applying every execution policy. This method performs no file I/O, package parsing, memory retrieval, persistence, command execution, network access, provider access, telemetry, export, or prompt transformation.", "parameters": { "context": "The display-safe profile, load-session, and long-term memory routing metadata." }, "returns": "An immutable path-relative evidence projection with a canonical context SHA-256." } ] }, { "name": "LocalGgufRuntimeCapabilities", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Declares the fixed local-only capabilities of the LocalEndpoint integration facade.", "remarks": "", "members": [ { "kind": "property", "name": "EmitsWorkerJsonlEvents", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.EmitsWorkerJsonlEvents", "summary": "Gets a value indicating whether this managed facade emits LocalEndpoint worker JSONL events.", "remarks": "The value is false because LocalEndpoint maps generated tokens and completion state to its own JSONL protocol.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "HostsServer", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.HostsServer", "summary": "Gets a value indicating whether the integration hosts a server or public listener.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "IsManagedExecution", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.IsManagedExecution", "summary": "Gets a value indicating whether model execution is implemented by managed project code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ParsesUaixPackages", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.ParsesUaixPackages", "summary": "Gets a value indicating whether the runtime opens or parses.uaix package containers.", "remarks": "LocalEndpoint owns package validation, import, expansion, profile selection, and load-session creation.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PersistsRuntimeContent", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.PersistsRuntimeContent", "summary": "Gets a value indicating whether the integration persists prompts, generated text, or session state.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsAssociatedArtifactVerification", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.SupportsAssociatedArtifactVerification", "summary": "Gets a value indicating whether callers can bind reviewed companion artifacts to path-free evidence.", "remarks": "The runtime verifies caller-supplied companion paths, digest evidence, byte-count evidence, root containment, and reparse-point policy without parsing the artifacts or assigning them authority.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsExplicitFileVerification", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.SupportsExplicitFileVerification", "summary": "Gets a value indicating whether callers can explicitly re-verify current model-file bytes before reuse.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsSynchronousTokenObservation", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.SupportsSynchronousTokenObservation", "summary": "Gets a value indicating whether caller-owned synchronous token observation is supported.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SupportsUaixRuntimeContextValidation", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.SupportsUaixRuntimeContextValidation", "summary": "Gets a value indicating whether the facade validates LocalEndpoint-supplied UAIX runtime context metadata.", "remarks": "Validation is structural and authority-free. The runtime does not read a.uaix archive, expanded.uai profile files, or Documents-backed wiki content.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UaixMemoryGrantsAuthority", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UaixMemoryGrantsAuthority", "summary": "Gets a value indicating whether UAIX memory metadata can grant runtime or external authority.", "remarks": "The value is false. Runtime execution, command execution, network access, provider access, website intake, telemetry, and export remain independent LocalEndpoint policy decisions.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesAssociatedArtifactsForGeneration", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesAssociatedArtifactsForGeneration", "summary": "Gets a value indicating whether associated artifacts alter managed token generation.", "remarks": "The value is false in this package slice. Associated artifacts are verified and surfaced as path-free evidence for LocalEndpoint, while prompt assembly, policy decisions, runtime routing, and generation behavior remain owned by the caller.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesGlobalUaixProfile", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesGlobalUaixProfile", "summary": "Gets a value indicating whether the runtime assumes one process-global active UAIX profile.", "remarks": "The value is false because each inference session receives its own profile and load-session evidence.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesGpuAcceleration", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesGpuAcceleration", "summary": "Gets a value indicating whether the integration uses GPU or CUDA execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesNativeInference", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesNativeInference", "summary": "Gets a value indicating whether model execution delegates to a native inference library.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesNetworkAccess", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesNetworkAccess", "summary": "Gets a value indicating whether the integration performs network access.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesSubprocesses", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesSubprocesses", "summary": "Gets a value indicating whether the integration starts subprocesses.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UsesTelemetry", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeCapabilities.UsesTelemetry", "summary": "Gets a value indicating whether the integration emits telemetry.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufRuntimeScope", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Identifies one caller-owned LocalEndpoint application scope and optional legacy UAIX package correlation label.", "remarks": "The values are opaque compatibility labels. They do not identify the active profile or per-application-instance load session; that evidence is supplied to UAIX.LmRuntime.LocalEndpoint.LocalGgufModel.CreateSession(UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext). The runtime never opens, interprets, persists, or synchronizes UAIX content.", "members": [ { "kind": "property", "name": "ApplicationInstanceId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope.ApplicationInstanceId", "summary": "Gets the LocalEndpoint application instance identifier.", "remarks": "UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime validates this caller-owned correlation label when the facade is constructed. The value must be trim-stable, bounded to 256 UTF-16 code units, well-formed Unicode text, and free of control, format, line-separator, and paragraph-separator code points. The runtime retains the accepted value only as opaque in-memory evidence and never interprets it as a path, profile selector, or execution authority.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UaixPackageId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope.UaixPackageId", "summary": "Gets an optional caller-owned legacy UAIX package correlation identifier.", "remarks": "UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntime applies the same bounded, trim-stable, well-formed Unicode correlation-text validation used for UAIX.LmRuntime.LocalEndpoint.LocalGgufRuntimeScope.ApplicationInstanceId. This value grants no authority and is not used as the active profile, load-session, wiki-root identity, package path, or policy input.", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufSession", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufSession", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Owns isolated deterministic sequence and key/value-cache state for one verified local model.", "remarks": "A session serializes generation, reset, and disposal transitions through one lifecycle authority. It stores no prompt, generated text, audit record, registry record, UAIX content, provider state, or network state.", "members": [ { "kind": "property", "name": "IsDisposed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.IsDisposed", "summary": "Gets a value indicating whether this session has been disposed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "Position", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.Position", "summary": "Gets the next sequence position retained by this isolated session.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "SessionId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.SessionId", "summary": "Gets the validated LocalEndpoint worker session identifier preserved for this inference session.", "remarks": "LocalEndpoint uses this value when mapping generated-token observations to JSONL events. The managed runtime does not create, replace, normalize, persist, or globally register the identifier.", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UaixRuntimeContextEvidence", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.UaixRuntimeContextEvidence", "summary": "Gets immutable, path-relative evidence for the profile and UAIX load session bound to this inference session.", "remarks": "The evidence contains no package bytes, profile content, wiki content, prompt text, generated text, absolute paths, or authority grants. It is safe for caller-owned correlation and bounded evidence receipts.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "Dispose", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.Dispose", "summary": "Releases isolated session state without disposing the shared model owner.", "remarks": "Disposal is idempotent. Releasing the final session permits the caller to dispose the mapped model owner.", "parameters": {}, "returns": "" }, { "kind": "method", "name": "GenerateGreedy(UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest,System.Action,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.GenerateGreedy(UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest,System.Action{UAIX.LmRuntime.LocalEndpoint.LocalGgufGeneratedToken},System.Threading.CancellationToken)", "summary": "Runs bounded deterministic greedy generation and synchronously reports each selected token.", "remarks": "The observer executes on the generation thread after each token is selected. It receives only sequence, token, and logit data and is not retained. LocalEndpoint remains responsible for decoding deltas, creating worker events, emitting exactly one terminal event, and preventing prompt or generated-text persistence. Exceptions from the observer propagate after operation ownership is released and no later token is selected.", "parameters": { "request": "The LocalGgufGenerationRequest containing the complete caller-owned inputs for GenerateGreedy; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "tokenObserver": "The caller-owned observer invoked once for each selected token.", "cancellationToken": "A token observed before work and between committed model steps." }, "returns": "The generated token identifiers, text, stop reason, position, and final selected logit." }, { "kind": "method", "name": "GenerateGreedy(UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest,System.Threading.CancellationToken)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.GenerateGreedy(UAIX.LmRuntime.LocalEndpoint.LocalGgufGenerationRequest,System.Threading.CancellationToken)", "summary": "Runs bounded deterministic greedy generation and returns exact token identifiers with decoded text.", "remarks": "Resource controls are validated before generated-token buffers are allocated. Stop-token values are copied into a private operation snapshot so caller mutation cannot alter an in-progress deterministic decision. The operation does not persist prompt text, generated text, token identifiers, session state, or UAIX data.", "parameters": { "request": "The LocalGgufGenerationRequest containing the complete caller-owned inputs for GenerateGreedy; required fields are validated and mutable collections are snapshotted before state changes or large allocations.", "cancellationToken": "A token observed before work and between committed model steps." }, "returns": "The generated token identifiers, text, stop reason, position, and final selected logit." }, { "kind": "method", "name": "Reset", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufSession.Reset", "summary": "Clears sequence position and key/value-cache state retained by this session.", "remarks": "Reset does not persist or expose prior token history. The operation is serialized with generation and disposal.", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufSessionContext", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents one worker session identity and its required UAIX boundary metadata.", "remarks": "LocalEndpoint creates this value after package import, profile loading, prompt assembly, and policy validation. The runtime snapshots the context for one isolated session and retains no global active profile.", "members": [ { "kind": "property", "name": "SessionId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext.SessionId", "summary": "Gets the LocalEndpoint worker session identifier that every mapped event must preserve.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UaixRuntimeContext", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufSessionContext.UaixRuntimeContext", "summary": "Gets the required display-safe UAIX profile and wiki routing metadata.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufTokenizerMetadata", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Provides a bounded tokenizer metadata projection for LocalEndpoint runtime readiness and diagnostics.", "remarks": "", "members": [ { "kind": "property", "name": "AddBos", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.AddBos", "summary": "Gets whether model metadata requests automatic beginning-of-sequence insertion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "AddEos", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.AddEos", "summary": "Gets whether model metadata requests automatic end-of-sequence insertion.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "BosTokenId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.BosTokenId", "summary": "Gets the beginning-of-sequence token identifier when defined.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ChatTemplate", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.ChatTemplate", "summary": "Gets the optional chat template declared by the model.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "EosTokenId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.EosTokenId", "summary": "Gets the end-of-sequence token identifier when defined.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "PreTokenizer", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.PreTokenizer", "summary": "Gets the optional pre-tokenizer identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TokenizerModel", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.TokenizerModel", "summary": "Gets the tokenizer family declared by GGUF metadata.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "UnknownTokenId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.UnknownTokenId", "summary": "Gets the unknown-token identifier when defined.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "VocabularySize", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufTokenizerMetadata.VocabularySize", "summary": "Gets the vocabulary size.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalGgufVerificationException", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents a local GGUF artifact verification failure.", "remarks": "", "members": [ { "kind": "property", "name": "ActualByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException.ActualByteCount", "summary": "Gets the observed current model byte count when available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ActualSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException.ActualSha256", "summary": "Gets the normalized observed SHA-256 value when available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedByteCount", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException.ExpectedByteCount", "summary": "Gets the required model byte count when supplied by caller-owned evidence.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ExpectedSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException.ExpectedSha256", "summary": "Gets the normalized expected SHA-256 value when available.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "method", "name": "LocalGgufVerificationException(string,string,string,System.Exception,System.Nullable,System.Nullable)", "xml_id": "M:UAIX.LmRuntime.LocalEndpoint.LocalGgufVerificationException.#ctor(System.String,System.String,System.String,System.Exception,System.Nullable{System.Int64},System.Nullable{System.Int64})", "summary": "Initializes a new LocalGgufVerificationException instance with validated dependencies and operational bounds.", "remarks": "Digest values may be retained as evidence because they contain no model bytes, prompt text, generated text, credentials, network data, or private runtime state.", "parameters": { "message": "The display-safe diagnostic message describing the failure without embedding prompt text, generated text, credentials, or private file contents.", "expectedSha256": "The expected lowercase or uppercase 64-character SHA-256 digest used to authenticate the complete artifact; a mismatch fails the operation before a trusted result is published.", "actualSha256": "The observed SHA-256 digest retained as path-free diagnostic evidence when available, or null when hashing did not complete.", "innerException": "The optional lower-level failure used only to select a bounded, path-free diagnostic category. The original exception object, message, stack trace, data, and file-name properties are never retained because they can contain private model paths or other caller-owned content.", "expectedByteCount": "The required file length when byte-count evidence is supplied.", "actualByteCount": "The actual byte count used to bound this operation; it must be nonnegative and within the supported range." }, "returns": "" } ] }, { "name": "LocalUaixLongTermMemoryMode", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalUaixLongTermMemoryMode", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Identifies the supported long-term memory routing modes for one validated UAIX load session.", "remarks": "The value describes a caller-owned memory route only. It does not authorize file access, runtime execution, command execution, network access, provider access, telemetry, export, or any other capability.", "members": [ { "kind": "field", "name": "Isolated", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixLongTermMemoryMode.Isolated", "summary": "Routes the load session to a profile-owned long-term memory root.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalUaixRuntimeContext", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents display-safe UAIX profile and long-term memory routing metadata supplied by LocalEndpoint.", "remarks": "This type mirrors the uaixRuntimeContext object in localendpoint.worker.request.v1. The runtime does not open or parse a.uaix archive, read.uai files, read wiki documents, expand a profile, choose a profile, or infer authority from this object. LocalEndpoint validates and imports packages, assembles the prompt, and supplies this metadata after its own policy gates. Every authority field must remain.", "members": [ { "kind": "property", "name": "AutoExportAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.AutoExportAllowed", "summary": "Gets a value that must remain false because UAIX memory does not authorize automatic export.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "CommandExecutionAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.CommandExecutionAllowed", "summary": "Gets a value that must remain false because command execution requires a separate user-approved gate.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixLoadSessionId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixLoadSessionId", "summary": "Gets the LocalEndpoint load-session identifier that bound this profile to one desktop application instance.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixProfileDisplayName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixProfileDisplayName", "summary": "Gets the display-safe name of the loaded UAIX profile.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixProfileId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixProfileId", "summary": "Gets the portable identifier of the loaded UAIX profile.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixProfilePresent", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixProfilePresent", "summary": "Gets a value indicating whether LocalEndpoint supplied one validated and loaded UAIX profile.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixSessionRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixSessionRelativePath", "summary": "Gets the app-local relative path to the LocalEndpoint load-session evidence record.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixUaiRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LoadedUaixUaiRelativePath", "summary": "Gets the app-local relative path to the expanded profile.uai root.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryMode", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LongTermMemoryMode", "summary": "Gets whether the selected long-term memory root is profile-isolated or deliberately shared.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryRootId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LongTermMemoryRootId", "summary": "Gets the portable identifier of the selected Documents-backed long-term memory root.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryRootRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.LongTermMemoryRootRelativePath", "summary": "Gets the path relative to Documents/LocalEndpoint/Wikis for the selected long-term memory root.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "MemoryCanOverridePolicy", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.MemoryCanOverridePolicy", "summary": "Gets a value that must remain false because memory cannot override LocalEndpoint policy.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "NetworkAccessAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.NetworkAccessAllowed", "summary": "Gets a value that must remain false because UAIX memory does not authorize network access.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ProviderApisAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.ProviderApisAllowed", "summary": "Gets a value that must remain false because UAIX memory does not authorize provider APIs.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "RuntimeExecutionAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.RuntimeExecutionAllowed", "summary": "Gets a value that must remain false because UAIX memory does not authorize model runtime execution.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "TelemetryEnabled", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.TelemetryEnabled", "summary": "Gets a value that must remain false because UAIX memory does not authorize telemetry.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "WebsitePromptIntakeAllowed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContext.WebsitePromptIntakeAllowed", "summary": "Gets a value that must remain false because UAIX memory does not authorize website prompt intake.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalUaixRuntimeContextEvidence", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents the immutable, path-relative evidence produced after UAIX runtime context validation.", "remarks": "The evidence contains no prompt, generated text, package bytes, wiki document content, model path, credential, command grant, network grant, provider grant, or execution grant. The SHA-256 binds a canonical field sequence for caller-owned registry and audit evidence without turning the context into authority.", "members": [ { "kind": "property", "name": "AuthorityBoundaryClosed", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.AuthorityBoundaryClosed", "summary": "Gets a value indicating that every UAIX authority field was verified false.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "ContextSha256", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.ContextSha256", "summary": "Gets the canonical lowercase SHA-256 for this validated context.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixLoadSessionId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LoadedUaixLoadSessionId", "summary": "Gets the validated LocalEndpoint load-session identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixProfileDisplayName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LoadedUaixProfileDisplayName", "summary": "Gets the validated display-safe profile name.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixProfileId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LoadedUaixProfileId", "summary": "Gets the validated loaded profile identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixSessionRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LoadedUaixSessionRelativePath", "summary": "Gets the validated app-local load-session relative path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LoadedUaixUaiRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LoadedUaixUaiRelativePath", "summary": "Gets the validated app-local profile.uai relative path.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryMode", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LongTermMemoryMode", "summary": "Gets the validated long-term memory routing mode.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryRootId", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LongTermMemoryRootId", "summary": "Gets the validated long-term memory root identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "LongTermMemoryRootRelativePath", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextEvidence.LongTermMemoryRootRelativePath", "summary": "Gets the validated Documents-backed wiki relative path.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalUaixRuntimeContextException", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextException", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Represents a fail-closed UAIX runtime context validation error.", "remarks": "The exception exposes a stable code and field name for bounded diagnostics. It does not include prompt text, generated text, profile file contents, wiki document contents, credentials, or private absolute paths.", "members": [ { "kind": "property", "name": "FailureCode", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextException.FailureCode", "summary": "Gets the stable fail-closed validation code.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "property", "name": "FieldName", "xml_id": "P:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextException.FieldName", "summary": "Gets the display-safe contract field associated with the failure.", "remarks": "", "parameters": {}, "returns": "" } ] }, { "name": "LocalUaixRuntimeContextFailureCode", "full_name": "UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode", "namespace": "UAIX.LmRuntime.LocalEndpoint", "summary": "Identifies the fail-closed reason produced while validating LocalEndpoint UAIX runtime context metadata.", "remarks": "Codes are stable, display-safe boundary identifiers. They do not include prompt text, generated text, private absolute paths, package bytes, wiki document contents, credentials, or unrestricted exception details.", "members": [ { "kind": "field", "name": "AuthorityEscalation", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.AuthorityEscalation", "summary": "One or more UAIX memory fields attempted to grant execution or external authority.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InvalidDisplayValue", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.InvalidDisplayValue", "summary": "A display-safe value contained unsupported control data or exceeded its limit.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InvalidIdentifier", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.InvalidIdentifier", "summary": "An identifier was outside the bounded portable identifier grammar.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InvalidRelativePath", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.InvalidRelativePath", "summary": "A relative path was absolute, traversing, malformed, or outside the supported portable form.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "InvalidWorkerSession", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.InvalidWorkerSession", "summary": "The worker session identifier was absent or malformed.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "LongTermMemoryPathMismatch", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.LongTermMemoryPathMismatch", "summary": "The long-term memory path did not match its declared mode and root identity.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MissingContext", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.MissingContext", "summary": "The required runtime context object was absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "MissingValue", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.MissingValue", "summary": "A required identifier or display-safe value was absent.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ProfileNotLoaded", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.ProfileNotLoaded", "summary": "The caller did not identify a loaded UAIX profile.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "ProfilePathMismatch", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.ProfilePathMismatch", "summary": "The profile-relative path did not match the declared profile identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "SessionPathMismatch", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.SessionPathMismatch", "summary": "The load-session-relative path did not match the declared load-session identifier.", "remarks": "", "parameters": {}, "returns": "" }, { "kind": "field", "name": "UnsupportedLongTermMemoryMode", "xml_id": "F:UAIX.LmRuntime.LocalEndpoint.LocalUaixRuntimeContextFailureCode.UnsupportedLongTermMemoryMode", "summary": "The long-term memory mode was not one of the explicitly supported values.", "remarks": "", "parameters": {}, "returns": "" } ] } ] } ] }