antecedent-data 0.2.0

Causal data views and Arrow-backed adapters for the Antecedent causal inference engine; start with the `antecedent` crate
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

//! Explicit materialization / copy diagnostics.
//!
//! SPDX-License-Identifier: MIT OR Apache-2.0

use antecedent_core::{Diagnostic, DiagnosticKind, DiagnosticSeverity};

/// Why a buffer was materialized.
#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
pub enum MaterializationReason {
    /// Caller requested an owned contiguous copy.
    ExplicitCopy,
    /// Layout incompatible with the requested kernel (e.g. non-contiguous).
    LayoutIncompatible,
    /// Arrow / foreign buffer could not be borrowed zero-copy.
    ForeignBufferIncompatible,
}

/// Record a materialization as an execution diagnostic.
#[must_use]
pub fn materialization_diagnostic(reason: MaterializationReason, bytes: u64) -> Diagnostic {
    let code = match reason {
        MaterializationReason::ExplicitCopy => "exec.materialize.explicit_copy",
        MaterializationReason::LayoutIncompatible => "exec.materialize.layout",
        MaterializationReason::ForeignBufferIncompatible => "exec.materialize.foreign",
    };
    let mut d = Diagnostic::new(
        code,
        DiagnosticKind::Execution,
        DiagnosticSeverity::Info,
        format!("materialized {bytes} bytes ({reason:?})"),
    );
    d.fields = std::sync::Arc::from([(
        std::sync::Arc::<str>::from("bytes"),
        std::sync::Arc::<str>::from(bytes.to_string()),
    )]);
    d
}