Skip to main content

orchard/
lib.rs

1//! Orchard - Rust client for high-performance LLM inference on Apple Silicon.
2
3mod defaults;
4pub mod error;
5
6pub mod client;
7pub mod engine;
8pub mod formatter;
9pub mod ipc;
10pub mod model;
11
12pub use error::{Error, Result};
13
14pub use ipc::client::{EventCallback, IPCClient, ResponseDelta, TokenLogProb};
15pub use ipc::endpoints;
16pub use ipc::serialization::{
17    build_batch_request_payload, CapabilityEntry, LayoutEntry, PromptPayload, RequestType,
18    SegmentType,
19};
20
21pub use engine::fetch::EngineFetcher;
22pub use engine::lifecycle::{EnginePaths, InferenceEngine};
23pub use engine::multiprocess;
24
25pub use model::registry::{ModelEntry, ModelInfo, ModelLoadState, ModelRegistry};
26pub use model::resolver::{ModelResolver, ResolvedModel};
27
28pub use formatter::control_tokens::{ControlTokens, Role, RoleTags};
29pub use formatter::multimodal::{
30    build_multimodal_layout, build_multimodal_messages, CapabilityInput, ContentType, LayoutSegment,
31};
32pub use formatter::ChatFormatter;
33
34pub use client::{
35    BatchChatResult, ChatResult, Client, ClientDelta, ClientResponse, ContentPartAddedEvent,
36    ContentPartDoneEvent, FunctionCallArgumentsDeltaEvent, FunctionCallArgumentsDoneEvent,
37    IncompleteDetails, InputTokensDetails, OutputFunctionCall, OutputItemAddedEvent,
38    OutputItemDoneEvent, OutputMessage, OutputReasoning, OutputStatus, OutputTextContent,
39    OutputTextDeltaEvent, OutputTextDoneEvent, OutputTokensDetails, ReasoningContent,
40    ReasoningDeltaEvent, ReasoningDoneEvent, ReasoningSummaryTextContent,
41    ReasoningSummaryTextDeltaEvent, ReasoningSummaryTextDoneEvent, ResponseCompletedEvent,
42    ResponseCreatedEvent, ResponseError, ResponseEvent, ResponseFailedEvent,
43    ResponseInProgressEvent, ResponseIncompleteEvent, ResponseInputItem, ResponseObject,
44    ResponseOutputItem, ResponseSnapshot, ResponseUsage, ResponsesInput, ResponsesRequest,
45    ResponsesResult, SamplingParams, StreamErrorDetail, StreamErrorEvent, UsageStats,
46};
47
48/// Library version
49pub const VERSION: &str = env!("CARGO_PKG_VERSION");