Skip to main content

eredu_core/
lib.rs

1//! Backend-neutral language-model contracts and orchestration.
2//!
3//! This crate deliberately contains no tensor runtime. Backends own tensors,
4//! streams, executable models, caches, and completion primitives; core owns
5//! validation, lifecycle state, scheduling, and portable schemas.
6
7#![forbid(unsafe_code)]
8#![warn(missing_docs)]
9
10/// Portable artifact inspection and model-preparation planning.
11pub mod artifact;
12/// Validated decoder attention schedules.
13pub mod attention;
14/// Backend-neutral automatic execution planning.
15pub mod automatic;
16/// High-level execution-backend contract.
17pub mod backend;
18/// Aggregate ownership and admission for backend-managed live caches.
19pub mod cache;
20/// Portable model capabilities, runtime-state accounting, and admission policy.
21pub mod capability;
22/// Neutral checkpoint tensor descriptions and validation.
23pub mod checkpoint;
24/// Backend-neutral distributed scheduler consensus.
25pub mod consensus;
26/// Portable execution plans, capabilities, and telemetry.
27pub mod execution;
28/// Backend-independent generation lifecycle and output events.
29pub mod generation;
30/// Portable identity for ordered, prepared model input.
31pub mod input;
32/// Portable model-artifact inspection results.
33pub mod inspection;
34/// Portable decoded-media requests and backend preparation inputs.
35pub mod media;
36/// Portable, explicitly requested execution observations.
37pub mod observation;
38/// Backend-generic realtime token-session execution and scheduling.
39pub mod realtime;
40/// Weight-residency ownership, capacity, and resource planning.
41pub mod residency;
42/// Transactional fair work scheduler.
43pub mod scheduler;
44/// High-level speculative execution contracts and orchestration.
45pub mod speculative;
46/// Parallel topology and placement planning.
47pub mod topology;
48
49pub use artifact::{
50    gguf_u32_metadata_values, inspect_artifact, plan_model_preparation, resolve_gguf_companions,
51    validate_preparation_policy, ArtifactFormat, ArtifactInspection, GgufCompanionEncoding,
52    GgufCompanionRequirement, GgufCompanionRole, LoadingProtocol, MaterializationRoute,
53    ModelArtifact, ModelConfiguration, ModelConfigurationResolver, ModelPreparationPlan,
54    PreparationPolicy, QuantizationRequest, ResidencyRequest, ResolvedModelConfiguration,
55    ValidatedGguf, ValidatedGgufCompanion,
56};
57pub use attention::{AttentionPolicy, LayerSchedule, LayerScheduleError};
58pub use automatic::{
59    realize_execution_plan_drafting, realize_execution_plan_target, AllocatorTelemetry,
60    AutomaticPlanRequest, AutomaticPlanner, AutomaticPlannerPolicy, AutomaticPlanningBackend,
61    AutomaticPlanningError, BoundedResidencyRequirement, CandidateAdmission, DurationSeconds,
62    ExecutionPlanBackendFactory, ExecutionPlanReport, ExecutionPlanTarget, ExecutionTelemetry,
63    ExpertCacheTelemetry, ExternalDraftArtifact, HardwareBackendProfile, HardwareDeviceProfile,
64    HardwareMemorySemantics, HardwareProfile, ModelResourceProfile, ObservationKind, Observed,
65    PlanExplanation, PlanExplanationEntry, PlanExplanationLevel, RealizedDrafting,
66    ResidencyTelemetry, SpeculativeDecodingTelemetry, TimingTelemetry, TokenizerCompatibilityError,
67    TokenizerCompatibilityProof, TransferTelemetry, AUTOMATIC_SCHEMA_VERSION,
68};
69pub use backend::{
70    load_model, prepare_inspected_model, BackendDescriptor, BackendError, BackendProvider,
71    BackendSession, CollectiveGroupDescriptor, CollectiveGroupId, CollectiveScope, Completion,
72    ControlledTextGeneration, ControlledTextGenerationError, ControlledToken, DeviceCapabilities,
73    DeviceDescriptor, DistributedBackend, DistributedCapabilities, DistributedSession,
74    DistributedSessionDescriptor, InspectableBackendSession, ModelCapabilityBackend,
75    ModelLoadError, ModelLoadingBackend, ModelRuntime, MultimodalPreparationBackend,
76    MultimodalPreparationFailure, PreparedModel, SessionCapabilities, SessionCapabilityError,
77    SpeculativeTokenFilterController, Submission, TextGeneration, TextGenerationBackend,
78    TextGenerationConfig, TextSamplingStrategy, TokenFilter, TokenFilterController,
79    TokenFilterError, TokenOutput, ValueDescriptor,
80};
81pub use capability::{
82    apply_admission_policy, estimate_runtime_state, Admission, AdmissionRejection,
83    AdmissionRequest, AdmissionResult, AvailableMemory, CacheStateStrategy, CapabilityError,
84    EstimationCompleteness, InputModalities, InputTokenCount, ModelCapabilities,
85    PhysicalMemorySemantics, RuntimeStateEstimate, SlidingWindowLayerCount, StateMemoryAssumptions,
86    StateMemoryLayout, StaticMemoryReport,
87};
88pub use execution::{
89    BackendId, DevicePlan, DraftPlacementPlan, DraftingPlan, ExecutionPlan, ExecutionPlanError,
90    ExpertCachePlan, ResidencyPlan, WeightTransformationPlan, DEFAULT_MAX_CACHED_SHARDS,
91    EXECUTION_PLAN_SCHEMA_VERSION,
92};
93pub use generation::{
94    resolve_generation_config, resolve_optimistic_reuse, CheckpointGenerationConfig, FinishReason,
95    GenerationCancellationToken, GenerationConfigOverrides, GenerationError, GenerationSequence,
96    OptimisticReuseDecision, ResolvedGenerationConfig, SemanticEvent,
97    SpeculativeCancellationDisposition, SpeculativeCommitPlan, SpeculativeConfig,
98    SpeculativeRequestId, SpeculativeRequestLifecycle, SpeculativeRequestStatus, SpeculativeRound,
99    SpeculativeSchedulerOptions, SpeculativeTail, TokenCommit, TokenTerminalSignals,
100};
101pub use input::{
102    InputExtent, InputMetadataKey, InputModality, InputPartDescriptor, InputPayloadKind,
103    InputTensorIdentity, PreparedInputError, PreparedInputIdentity,
104};
105pub use inspection::{
106    ArtifactModality, ArtifactTensorEncoding, InspectionIssue, InspectionIssueCode,
107    InspectionReadiness, InspectionRequirement, InspectionSeverity, ModelInspectionReport,
108};
109pub use media::{
110    Audio, Media, MediaBinding, MediaRequestError, MultimodalRequest, MultimodalSegment, RgbImage,
111    TokenizedMultimodalRequest, TokenizedMultimodalSegment, Video, VideoSampling,
112};
113pub use observation::{
114    InspectedOutput, ObservationError, ObservationRequest, ObservationSelector, ObservationSet,
115    ObservationValue, TensorObservation, TensorObservationData, MODEL_LOGITS_OBSERVATION_PATH,
116};
117pub use realtime::{
118    load_realtime_model, load_realtime_model_with_options, RealtimeBackend, RealtimeCompletedStep,
119    RealtimeConfigError, RealtimeDecisionDiagnostics, RealtimeError, RealtimeFrameConvention,
120    RealtimeFrameForcing, RealtimeFrameScheduleState, RealtimeFrameSlot, RealtimeFrameTransition,
121    RealtimeInputFrame, RealtimeModel, RealtimeModelLoadingBackend, RealtimeOutputFrame,
122    RealtimeSampling, RealtimeScheduleError, RealtimeScheduler, RealtimeSession,
123    RealtimeSlotCoordinate, RealtimeSlotOccupancy, RealtimeSpeechConfig, RealtimeTargetDecision,
124    RealtimeTargetSource, RealtimeTemporalSource, MAX_REALTIME_FRAME_DELAY,
125};
126pub use residency::{
127    BackgroundPrefetchReport, PrefetchAdmission, PrefetchCompletion, PrefetchDemandObservation,
128    PrefetchDemandResolution, PrefetchExecutionState, PrefetchStateError, PrefetchWork,
129};
130pub use speculative::{
131    cancel_pending_verification, propose_block, resolve_commit_and_publish,
132    resolve_optimistic_branch, resolve_round, submit_verification_transaction,
133    CompletedSpeculativeRequest, CompletedSpeculativeSchedule, PendingSpeculativeVerification,
134    PreparedSpeculativeLane, ProposalDecision, PublishedSpeculativeResult,
135    PublishedSpeculativeVerification, ResolvedSpeculativeRound, SamplingPlacement,
136    SpeculativeAction, SpeculativeCallbackPublisher, SpeculativeCandidate, SpeculativeCapability,
137    SpeculativeCommit, SpeculativeConstraint, SpeculativeContinuation, SpeculativeDraft,
138    SpeculativeDraftBlock, SpeculativeDraftSource, SpeculativeDriverError,
139    SpeculativeExecutionTopology, SpeculativeExecutor, SpeculativeGenerationBackend,
140    SpeculativeGenerationBatchOutput, SpeculativeGenerationBatchRequest, SpeculativeGenerationLane,
141    SpeculativeGenerationOutput, SpeculativeGenerationVisitor, SpeculativeOptimisticBranch,
142    SpeculativeOutputError, SpeculativeOutputRuntime, SpeculativePrefill, SpeculativeProposal,
143    SpeculativePublicationStatus, SpeculativePublisher, SpeculativeRandomness, SpeculativeRequest,
144    SpeculativeRequestTable, SpeculativeSampling, SpeculativeSchedule, SpeculativeSchedulerStats,
145    SpeculativeSemanticConstraint, SpeculativeSemanticState, SpeculativeStats,
146    SpeculativeTelemetry,
147};
148pub use topology::{
149    balanced_contiguous_range, ParallelAxis, ParallelCoordinates, ParallelRankTopology,
150    ParallelTopology, SubgroupMembership, TopologyError, TopologyPreflightReport,
151};