deep_causality_discovery 0.3.3

Causality discovery DSL for the DeepCausality project.
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

/*
 * SPDX-License-Identifier: MIT
 * Copyright (c) 2023 - 2026. The DeepCausality Authors and Contributors. All Rights Reserved.
 */

use crate::{PreprocessConfig, PreprocessError};
use deep_causality_tensor::CausalTensor;

/// Defines the contract for data pre-processing steps.
///
/// Implementors of this trait provide specific data transformation logic, such as
/// discretization or missing value imputation, which can be applied as part of a
/// CDL pipeline.
pub trait DataPreprocessor {
    /// Processes the input tensor according to the provided configuration.
    ///
    /// # Arguments
    ///
    /// * `tensor` - The input `CausalTensor<f64>` to be processed.
    /// * `config` - A `PreprocessConfig` containing the settings for this
    ///   processing step.
    ///
    /// # Returns
    ///
    /// A `Result` containing a new, processed `CausalTensor<f64>` on success.
    ///
    /// # Errors
    ///
    /// Returns a `PreprocessError` if the processing fails, for example due to an
    /// invalid configuration or an issue with the data itself.
    fn process(
        &self,
        tensor: CausalTensor<f64>,
        config: &PreprocessConfig,
    ) -> Result<CausalTensor<f64>, PreprocessError>;
}