Struct Datasheet 

pub struct Datasheet {

    pub purpose: String,
    pub creators: Vec<String>,
    pub funding: Option<String>,
    pub instance_count: Option<u64>,
    pub features: HashMap<String, FeatureInfo>,
    pub sensitive_features: Vec<String>,
    pub collection_method: Option<String>,
    pub collection_start: Option<DateTime<Utc>>,
    pub collection_end: Option<DateTime<Utc>>,
    pub preprocessing: Vec<PreprocessingStep>,
    pub license: Option<String>,
    pub access_restrictions: Vec<String>,
    pub maintainer: Option<String>,
    pub update_frequency: Option<String>,
    pub deprecation_policy: Option<String>,
    pub extra: HashMap<String, Value>,
}

Datasheet with standardized dataset documentation.

Fields

purpose: String

Purpose of the dataset.

creators: Vec<String>

Creators of the dataset.

funding: Option<String>

Funding source.

instance_count: Option<u64>

Number of instances.

features: HashMap<String, FeatureInfo>

Feature descriptions.

sensitive_features: Vec<String>

Sensitive features that require special handling.

collection_method: Option<String>

How the data was collected.

collection_start: Option<DateTime<Utc>>

When the data collection started.

collection_end: Option<DateTime<Utc>>

When the data collection ended.

preprocessing: Vec<PreprocessingStep>

Preprocessing steps applied.

license: Option<String>

License for the dataset.

access_restrictions: Vec<String>

Access restrictions.

maintainer: Option<String>

Who maintains the dataset.

update_frequency: Option<String>

How often the dataset is updated.

deprecation_policy: Option<String>

Deprecation policy.

extra: HashMap<String, Value>

Additional metadata.

Implementations

impl Datasheet

pub fn builder() -> DatasheetBuilder

Create a new datasheet builder.

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

Create a minimal datasheet with just a purpose.

pub fn add_feature(&mut self, name: impl Into<String>, info: FeatureInfo)

Add a feature.

pub fn add_preprocessing(&mut self, step: PreprocessingStep)

Add a preprocessing step.

Trait Implementations

impl Clone for Datasheet

fn clone(&self) -> Datasheet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Datasheet

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

Formats the value using the given formatter.

impl Default for Datasheet

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Datasheet

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Datasheet

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.