common.rs 9.78 KB
Newer Older
1
2
3
// SPDX-FileCopyrightText: Copyright (c) 2024-2025 NVIDIA CORPORATION & AFFILIATES. All rights reserved.
// SPDX-License-Identifier: Apache-2.0

4
5
use std::pin::Pin;

6
use crate::{
7
    backend::{Backend, ExecutionContext},
8
    discovery::{ModelManager, ModelWatcher},
9
    engines::StreamingEngineAdapter,
10
    entrypoint::EngineConfig,
11
    kv_router::{KvPushRouter, KvRouter, PrefillRouter},
12
    migration::Migration,
13
    model_card::ModelDeploymentCard,
14
    preprocessor::{OpenAIPreprocessor, prompt::PromptFormatter},
15
    protocols::common::llm_backend::{BackendOutput, LLMEngineOutput, PreprocessedRequest},
16
    request_template::RequestTemplate,
17
    types::{
18
        Annotated,
19
20
21
22
23
24
        openai::chat_completions::{
            NvCreateChatCompletionRequest, NvCreateChatCompletionStreamResponse,
            OpenAIChatCompletionsStreamingEngine,
        },
    },
};
25

26
use dynamo_runtime::{
27
    DistributedRuntime,
28
    component::Client,
29
    engine::{AsyncEngineStream, Data},
30
31
32
33
    pipeline::{
        Context, ManyOut, Operator, PushRouter, RouterMode, SegmentSource, ServiceBackend,
        ServiceEngine, ServiceFrontend, SingleIn, Source,
    },
34
35
36
};
use std::sync::Arc;

37
38
39
40
pub struct PreparedEngine {
    pub service_name: String,
    pub engine: OpenAIChatCompletionsStreamingEngine,
    pub inspect_template: bool,
41
42
43
44
45
46
47
48
49
50
51
52
    pub card: Option<ModelDeploymentCard>,
    pub request_template: Option<RequestTemplate>,
}

impl PreparedEngine {
    pub fn has_tokenizer(&self) -> bool {
        if let Some(card) = self.card.as_ref() {
            card.has_tokenizer()
        } else {
            false
        }
    }
53
54
}

55
/// Turns an EngineConfig into an OpenAI chat-completions and completions supported StreamingEngine.
56
pub async fn prepare_engine(
57
    distributed_runtime: DistributedRuntime,
58
    engine_config: EngineConfig,
59
) -> anyhow::Result<PreparedEngine> {
60
    match engine_config {
61
        EngineConfig::Dynamic(local_model) => {
62
            let model_manager = Arc::new(ModelManager::new());
63
            let watch_obj = Arc::new(ModelWatcher::new(
64
                distributed_runtime.clone(),
65
66
                model_manager.clone(),
                dynamo_runtime::pipeline::RouterMode::RoundRobin,
67
                None,
68
                None,
69
            ));
70
71
72
73
74
75
76
            let discovery = distributed_runtime.discovery();
            let discovery_stream = discovery
                .list_and_watch(
                    dynamo_runtime::discovery::DiscoveryQuery::AllModels,
                    Some(distributed_runtime.primary_token().clone()),
                )
                .await?;
77
            let inner_watch_obj = watch_obj.clone();
78
            let _watcher_task = tokio::spawn(async move {
79
                inner_watch_obj.watch(discovery_stream, None).await;
80
            });
81
            tracing::info!("Waiting for remote model..");
82

83
84
85
86
87
            // TODO: We use the first model to appear, usually we have only one
            // We should add slash commands to text input `/model <name>` to choose,
            // '/models` to list, and notifications when models are added / removed.

            let model_service_name = watch_obj.wait_for_chat_model().await;
88
            tracing::info!("Connected to {model_service_name}");
89
            let engine = model_manager.get_chat_completions_engine(&model_service_name)?;
90
            Ok(PreparedEngine {
91
                service_name: model_service_name,
92
93
                engine,
                inspect_template: false,
94
95
                card: None,
                request_template: local_model.request_template(),
96
            })
97
        }
98
        EngineConfig::StaticFull { engine, model, .. } => {
99
            let service_name = model.service_name().to_string();
100
            tracing::debug!("Model: {service_name} with engine pre-processing");
101
            let engine = Arc::new(StreamingEngineAdapter::new(engine));
102
103
104
105
            Ok(PreparedEngine {
                service_name,
                engine,
                inspect_template: false,
106
107
                request_template: model.request_template(),
                card: Some(model.into_card()),
108
            })
109
110
111
        }
        EngineConfig::StaticCore {
            engine: inner_engine,
112
            model,
113
            ..
114
        } => {
115
116
117
            let pipeline = build_pipeline::<
                NvCreateChatCompletionRequest,
                NvCreateChatCompletionStreamResponse,
118
            >(model.card(), inner_engine, model.card().tokenizer_hf()?)
119
            .await?;
120

121
            let service_name = model.service_name().to_string();
122
123
124
125
126
            tracing::debug!("Model: {service_name} with Dynamo pre-processing");
            Ok(PreparedEngine {
                service_name,
                engine: pipeline,
                inspect_template: true,
127
128
                request_template: model.request_template(),
                card: Some(model.into_card()),
129
            })
130
131
132
        }
    }
}
133
134
135
136

pub async fn build_pipeline<Req, Resp>(
    card: &ModelDeploymentCard,
    engine: ExecutionContext,
137
    hf_tokenizer: tokenizers::Tokenizer,
138
139
140
141
142
) -> anyhow::Result<Arc<ServiceFrontend<SingleIn<Req>, ManyOut<Annotated<Resp>>>>>
where
    Req: Data,
    Resp: Data,
    OpenAIPreprocessor: Operator<
143
144
145
146
147
            Context<Req>,
            Pin<Box<dyn AsyncEngineStream<Annotated<Resp>>>>,
            Context<PreprocessedRequest>,
            Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>>>>,
        >,
148
149
{
    let frontend = ServiceFrontend::<SingleIn<Req>, ManyOut<Annotated<Resp>>>::new();
150
151
152
153
154
    let PromptFormatter::OAI(formatter) = PromptFormatter::from_mdc(card)?;
    let preprocessor =
        OpenAIPreprocessor::new_with_parts(card.clone(), formatter, hf_tokenizer.clone())?
            .into_operator();
    let backend = Backend::from_tokenizer(hf_tokenizer).into_operator();
155
156
157
158
159
160
161
162
163
164
165
    let engine = ServiceBackend::from_engine(engine);

    Ok(frontend
        .link(preprocessor.forward_edge())?
        .link(backend.forward_edge())?
        .link(engine)?
        .link(backend.backward_edge())?
        .link(preprocessor.backward_edge())?
        .link(frontend)?)
}

166
167
168
169
pub async fn build_routed_pipeline<Req, Resp>(
    card: &ModelDeploymentCard,
    client: &Client,
    router_mode: RouterMode,
170
    busy_threshold: Option<f64>,
171
    chooser: Option<Arc<KvRouter>>,
172
    hf_tokenizer: tokenizers::Tokenizer,
173
    prefill_chooser: Option<Arc<PrefillRouter>>,
174
) -> anyhow::Result<ServiceEngine<SingleIn<Req>, ManyOut<Annotated<Resp>>>>
175
176
177
178
179
180
181
182
183
184
where
    Req: Data,
    Resp: Data,
    OpenAIPreprocessor: Operator<
            Context<Req>,
            Pin<Box<dyn AsyncEngineStream<Annotated<Resp>>>>,
            Context<PreprocessedRequest>,
            Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>>>>,
        >,
{
185
186
187
    let PromptFormatter::OAI(formatter) = PromptFormatter::from_mdc(card)?;
    let preprocessor =
        OpenAIPreprocessor::new_with_parts(card.clone(), formatter, hf_tokenizer.clone())?;
188
189
190
191
192
193
194
    build_routed_pipeline_with_preprocessor(
        card,
        client,
        router_mode,
        busy_threshold,
        chooser,
        preprocessor,
195
        hf_tokenizer,
196
        prefill_chooser,
197
198
199
200
    )
    .await
}

201
#[allow(clippy::too_many_arguments)]
202
203
204
205
206
207
208
pub async fn build_routed_pipeline_with_preprocessor<Req, Resp>(
    card: &ModelDeploymentCard,
    client: &Client,
    router_mode: RouterMode,
    busy_threshold: Option<f64>,
    chooser: Option<Arc<KvRouter>>,
    preprocessor: Arc<OpenAIPreprocessor>,
209
    hf_tokenizer: tokenizers::Tokenizer,
210
    prefill_chooser: Option<Arc<PrefillRouter>>,
211
) -> anyhow::Result<ServiceEngine<SingleIn<Req>, ManyOut<Annotated<Resp>>>>
212
213
214
215
where
    Req: Data,
    Resp: Data,
    OpenAIPreprocessor: Operator<
216
217
218
219
220
            Context<Req>,
            Pin<Box<dyn AsyncEngineStream<Annotated<Resp>>>>,
            Context<PreprocessedRequest>,
            Pin<Box<dyn AsyncEngineStream<Annotated<BackendOutput>>>>,
        >,
221
222
{
    let frontend = SegmentSource::<SingleIn<Req>, ManyOut<Annotated<Resp>>>::new();
223
    let preprocessor_op = preprocessor.into_operator();
224
225
    let backend = Backend::from_tokenizer(hf_tokenizer).into_operator();
    let migration = Migration::from_mdc(card).into_operator();
226
227
228
229
230
231
232
233
234

    // Create worker monitor only if busy_threshold is set
    let worker_monitor = busy_threshold.map(|threshold| {
        Arc::new(crate::discovery::KvWorkerMonitor::new(
            Arc::new(client.clone()),
            threshold,
        )) as Arc<dyn dynamo_runtime::pipeline::WorkerLoadMonitor>
    });

235
236
237
238
239
    let router =
        PushRouter::<PreprocessedRequest, Annotated<LLMEngineOutput>>::from_client_with_threshold(
            client.clone(),
            router_mode,
            busy_threshold,
240
            worker_monitor,
241
242
        )
        .await?;
243

244
245
246
247
248
249
250
251
252
253
254
255
256
    let service_backend = match router_mode {
        RouterMode::Random | RouterMode::RoundRobin | RouterMode::Direct(_) => {
            ServiceBackend::from_engine(Arc::new(router))
        }
        RouterMode::KV => {
            let Some(chooser) = chooser else {
                anyhow::bail!("RouterMode::KV requires KVRouter to not be null");
            };
            let kv_push_router = KvPushRouter::new(router, chooser);
            ServiceBackend::from_engine(Arc::new(kv_push_router))
        }
    };

257
258
259
260
261
    // Use the provided prefill chooser, or create a disabled one if not provided
    let prefill_chooser = prefill_chooser.unwrap_or_else(|| PrefillRouter::disabled(router_mode));
    let prefill_op = prefill_chooser.into_operator();

    // Link with prefill chooser including backward edge for response flow
262
    let engine = frontend
263
        .link(preprocessor_op.forward_edge())?
264
265
        .link(backend.forward_edge())?
        .link(migration.forward_edge())?
266
        .link(prefill_op.forward_edge())?
267
        .link(service_backend)?
268
        .link(prefill_op.backward_edge())?
269
270
        .link(migration.backward_edge())?
        .link(backend.backward_edge())?
271
        .link(preprocessor_op.backward_edge())?
272
        .link(frontend)?;
273

274
275
    Ok(engine)
}