inferlab-protocol 0.7.0

Wire types for the Inferlab framework-integration protocol: strict, versioned one-shot JSON adapter operations.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

mod wire;

use schemars::generate::SchemaSettings;

pub use wire::{
    AdapterError, AdapterErrorCode, AdapterProtocol, AdapterRequest, AdapterResponse,
    AdapterResult, AllocationLaunch, BenchCaseInput, BenchClientRequest, BenchClientResult,
    BenchDatasetCacheState, BenchDatasetCatalogInput, BenchDatasetInput,
    BenchDatasetPreparationRequest, BenchDatasetPreparationResult, BenchDefinitionInput,
    BenchLoadInput, BenchPopulationInput, BenchPrefixSharingInput, BenchRandomShapeInput,
    BenchRequestSloInput, BenchRequestSloResult, BenchRequestSourceInput, BenchTokenCountSummary,
    CaptureTargetRequirement, CaptureWindowControlEndpoint, CaptureWindowControlRequirement,
    ClientEndpointInput, ClientStatus, EndpointAssignment, EndpointProtocol, EndpointRequirement,
    EvalClientRequest, EvalClientResult, EvalDefinitionInput, EvalFailureKind,
    EvalMetricComparison, EvalMetricGate, EvalMetricGateConclusion, EvalNormalizedMetric,
    EvalTaskSourceInput, EvalTrialSummary, FrontendCoRendering, FrontendComponents,
    FrontendGatewayComponent, FrontendHandoff, FrontendPdRouterComponent, FrontendProcessRole,
    GatewayFrontendBinding, GatewayPdRouterFrontendBinding, GatewayPlan, GatewayTarget,
    HttpActionSpec, HttpMethod, HttpTargetRegistryReadiness, IntegrationIdentity,
    KvTransferMechanism, LaunchFileDeclaration, MeasurementModelInput, MeasurementProtocol,
    Parallelism, ParallelismAttention, ParallelismExperts, ParallelismOuter, PdRouterPlan,
    PdRoutingPolicies, PlanServeInput, PlanServeResult, ProcessSpec, ProtocolVersion, RawArtifact,
    ReadinessProbe, RenderInputDeclaration, RenderServeInput, RenderServeResult, RenderSource,
    RenderedServeProcess, ServeModelInput, ServeProcessAllocation, ServeReplicaRequirement,
    ServeRoleInput, ServeRoleKind, ServeRoleLink, ServeRoleResult, ServeTopology, SettingValue,
    SuppliedRenderInput, TargetEndpointScheme,
};

pub const PROTOCOL_SCHEMA_ID: &str = "https://inferlab.dev/schema/adapter-protocol/v7";
pub const MEASUREMENT_SCHEMA_ID: &str = "https://inferlab.dev/schema/measurement-protocol/v1";
pub const PROTOCOL_WIRE_SOURCE: &str = "crates/inferlab-protocol/src/wire.rs";

#[must_use]
pub fn protocol_schema() -> schemars::Schema {
    schema_for::<AdapterProtocol>(PROTOCOL_SCHEMA_ID)
}

#[must_use]
pub fn measurement_schema() -> schemars::Schema {
    schema_for::<MeasurementProtocol>(MEASUREMENT_SCHEMA_ID)
}

fn schema_for<T: schemars::JsonSchema>(id: &str) -> schemars::Schema {
    let mut schema = SchemaSettings::draft2020_12()
        .for_deserialize()
        .into_generator()
        .into_root_schema_for::<T>();
    schema.ensure_object().insert("$id".to_owned(), id.into());
    schema.ensure_object().insert(
        "$comment".to_owned(),
        format!("Generated from {PROTOCOL_WIRE_SOURCE}; do not edit.").into(),
    );
    schema
}