Trait smartnoise_validator::components::Report

pub trait Report {
    fn summarize(
        &self, 
        node_id: u32, 
        component: &Component, 
        public_arguments: IndexMap<IndexKey, &Value>, 
        properties: NodeProperties, 
        release: &Value, 
        variable_names: Option<&Vec<IndexKey>>
    ) -> Result<Option<Vec<JSONRelease>>>;
}

Report component trait

Reportable components correspond to a computation that a researcher may want a JSON summary for

Required methods

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

Summarize the relevant metadata around a computation in a readable, JSON-serializable format.

Loading content...

Implementors

impl Report for Component

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

Utility implementation on the component.

This utility delegates evaluation to the concrete implementation of each component variant.

impl Report for DpCount

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    _properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpCovariance

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpGumbelMedian

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpHistogram

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpLinearRegression

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    _properties: NodeProperties,
    release: &Value,
    _variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpMaximum

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpMean

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

summarize results

Arguments

• &self - this
• node_id - identifier for node
• component - component from prototypes/components.proto
• public_arguments - HashMap of String, Value public arguments
• properties - NodeProperties
• release - JSONRelease containing DP release information

impl Report for DpMedian

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpMinimum

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpQuantile

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpRawMoment

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpSum

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

impl Report for DpVariance

fn summarize(
    &self,
    node_id: u32,
    component: &Component,
    _public_arguments: IndexMap<IndexKey, &Value>,
    properties: NodeProperties,
    release: &Value,
    variable_names: Option<&Vec<IndexKey>>
) -> Result<Option<Vec<JSONRelease>>>

Loading content...