Skip to content

Commit

Permalink
Update knn orchestrator diagram
Browse files Browse the repository at this point in the history
  • Loading branch information
Sicheng Pan committed Dec 11, 2024
1 parent 512b7ef commit 8ac8713
Showing 1 changed file with 30 additions and 69 deletions.
99 changes: 30 additions & 69 deletions rust/worker/src/execution/orchestration/knn.rs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ use crate::{

use super::knn_filter::{KnnError, KnnFilterOutput, KnnResult};

/// The `knn` module contains two orchestrator: `KnnFilterOrchestrator` and `KnnOrchestrator`.
/// When used together, they carry out the evaluation of a `<collection>.query(...)` query
/// The `KnnOrchestrator` finds the nearest neighbor of a target embedding given the search domain.
/// When used together with `KnnFilterOrchestrator`, they evaluate a `<collection>.query(...)` query
/// for the user. We breakdown the evaluation into two parts because a `<collection>.query(...)`
/// is inherently multiple queries sharing the same filter criteria. Thus we first evaluate
/// the filter criteria with `KnnFilterOrchestrator`. Then we spawn a `KnnOrchestrator` for each
Expand All @@ -38,53 +38,23 @@ use super::knn_filter::{KnnError, KnnFilterOutput, KnnResult};
///
/// # Pipeline
/// ```text
/// │
/// │
/// │
/// ┌──────────────────────────── │ ───────────────────────────────┐
/// │ ▼ │
/// │ ┌────────────┐ KnnFilterOrchestrator │
/// │ │ │ │
/// │ ┌───────────┤ on_start ├────────────────┐ │
/// │ │ │ │ │ │
/// │ │ └────────────┘ │ │
/// │ │ │ │
/// │ ▼ ▼ │
/// │ ┌────────────────────┐ ┌────────────────────────┐ │
/// │ │ │ │ │ │
/// │ │ FetchLogOperator │ │ FetchSegmentOperator │ │
/// │ │ │ │ │ │
/// │ └────────┬───────────┘ └────────────────┬───────┘ │
/// │ │ │ │
/// │ │ │ │
/// │ │ ┌─────────────────────────────┐ │ │
/// │ │ │ │ │ │
/// │ └────►│ try_start_filter_operator │◄────┘ │
/// │ │ │ │
/// │ └────────────┬────────────────┘ │
/// │ │ │
/// │ ▼ │
/// │ ┌───────────────────┐ │
/// │ │ │ │
/// │ │ FilterOperator │ │
/// │ │ │ │
/// │ └─────────┬─────────┘ │
/// │ │ │
/// │ ▼ │
/// │ ┌──────────────────┐ │
/// │ │ │ │
/// │ │ result_channel │ │
/// │ │ │ │
/// │ └────────┬─────────┘ │
/// │ │ │
/// └──────────────────────────── │ ───────────────────────────────┘
/// │
/// │
/// │
/// ┌──────────────────────────────────┴─────────────────────────────────────┐
/// │ │
/// │ ... One branch per embedding ... │
/// │ │
/// │
/// │
/// │
/// │
/// ▼
/// ┌───────────────────────┐
/// │ │
/// │ KnnFilterOrchestrator │
/// │ │
/// └───────────┬───────────┘
/// │
/// │
/// │
/// ┌──────────────────────────────────┴─────────────────────────────────────┐
/// │ │
/// │ ... One branch per embedding ... │
/// │ │
/// ┌──────────────────── │ ─────────────────────┐ ┌──────────────────── │ ─────────────────────┐
/// │ ▼ │ │ ▼ │
/// │ ┌────────────┐ KnnOrchestrator │ │ ┌────────────┐ KnnOrchestrator │
Expand Down Expand Up @@ -129,27 +99,18 @@ use super::knn_filter::{KnnError, KnnFilterOutput, KnnResult};
/// │ └────────┬─────────┘ │ │ └────────┬─────────┘ │
/// │ │ │ │ │ │
/// └──────────────────── │ ─────────────────────┘ └──────────────────── │ ─────────────────────┘
/// │ │
/// │ │
/// │ │
/// │ ┌────────────────┐ │
/// │ │ │ │
/// └──────────────────────────►│ try_join_all │◄──────────────────────────┘
/// │ │
/// └───────┬────────┘
/// │
/// │
/// ▼
/// │ │
/// │ │
/// │ │
/// │ ┌────────────────┐ │
/// │ │ │ │
/// └──────────────────────────►│ try_join_all │◄──────────────────────────┘
/// │ │
/// └───────┬────────┘
/// │
/// │
/// ▼
/// ```
///
/// # State tracking
/// Similar to the `GetOrchestrator`, the `KnnFilterOrchestrator` need to keep track of the outputs from
/// `FetchLogOperator` and `FetchSegmentOperator`. For `KnnOrchestrator`, it needs to track the outputs from
/// `KnnLogOperator` and `KnnHnswOperator`. It invokes `try_start_knn_merge_operator` when it receives outputs
/// from either operators, and if both outputs are present it composes the input for `KnnMergeOperator` and
/// proceeds with execution. The outputs of other operators are directly forwarded without being tracked
/// by the orchestrator.
#[derive(Debug)]
pub struct KnnOrchestrator {
// Orchestrator parameters
Expand Down

0 comments on commit 8ac8713

Please sign in to comment.