Struct Provenance 

pub struct Provenance {
    pub model: String,
    pub parameters: Vec<(String, String)>,
    pub seed: Option<u64>,
    pub stream_scheme: Option<String>,
    pub versions: Vec<(String, String)>,
    pub input_hash: Option<String>,
}

Audit record carried by every crate::PredictiveDistribution, so a result can be traced to its model and replayed from its seed.

use prospicio_prob::Provenance;

let p = Provenance::new("odp_bootstrap").param("n_sims", 10_000);
assert_eq!(p.model, "odp_bootstrap");
assert_eq!(p.parameters, [("n_sims".to_string(), "10000".to_string())]);
assert_eq!(p.versions[0].0, "prospicio-prob");

Fields

model: String

Model that produced the result, e.g. "odp_bootstrap".

parameters: Vec<(String, String)>

Model parameters in the order the model reports them.

seed: Option<u64>

Seed of the simulation, if the result is simulated.

stream_scheme: Option<String>

Rule mapping simulations to streams, e.g. SIM_INDEX_SCHEME.

versions: Vec<(String, String)>

Crate versions involved, starting with prospicio-prob.

input_hash: Option<String>

Hash of the model’s canonical input, from InputHasher.

Implementations

impl Provenance

pub fn new(model: impl Into<String>) -> Self

Provenance for model, recording this crate’s version.

pub fn param(self, name: impl Into<String>, value: impl ToString) -> Self

Adds a model parameter.

pub fn version( self, krate: impl Into<String>, version: impl Into<String>, ) -> Self

Records the version of another crate involved, e.g. the model’s.

pub fn seed(self, seed: u64, stream_scheme: impl Into<String>) -> Self

Records the seed and the stream scheme it was used with.

pub fn input_hash(self, hash: impl Into<String>) -> Self

Records the hash of the model’s canonical input, normally InputHasher::finish.

Trait Implementations

impl Clone for Provenance

fn clone(&self) -> Provenance

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Provenance

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Eq for Provenance

impl PartialEq for Provenance

fn eq(&self, other: &Provenance) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for Provenance