Struct StratifiedSplit 

#[non_exhaustive]
pub struct StratifiedSplit {
    pub training_fraction: f64,
    pub validation_fraction: f64,
    pub test_fraction: f64,
    pub key: String,
    /* private fields */
}

Available on crate feature pipeline-service only.

Assigns input data to the training, validation, and test sets so that the distribution of values found in the categorical column (as specified by the key field) is mirrored within each split. The fraction values determine the relative sizes of the splits.

For example, if the specified column has three values, with 50% of the rows having value “A”, 25% value “B”, and 25% value “C”, and the split fractions are specified as 80/10/10, then the training set will constitute 80% of the training data, with about 50% of the training set rows having the value “A” for the specified column, about 25% having the value “B”, and about 25% having the value “C”.

Only the top 500 occurring values are used; any values not in the top 500 values are randomly assigned to a split. If less than three rows contain a specific value, those rows are randomly assigned.

Supported only for tabular Datasets.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

training_fraction: f64

The fraction of the input data that is to be used to train the Model.

validation_fraction: f64

The fraction of the input data that is to be used to validate the Model.

test_fraction: f64

The fraction of the input data that is to be used to evaluate the Model.

key: String

Required. The key is a name of one of the Dataset’s data columns. The key provided must be for a categorical column.

Implementations

impl StratifiedSplit

pub fn new() -> Self

pub fn set_training_fraction<T: Into<f64>>(self, v: T) -> Self

Sets the value of training_fraction.

Example

let x = StratifiedSplit::new().set_training_fraction(42.0);

pub fn set_validation_fraction<T: Into<f64>>(self, v: T) -> Self

Sets the value of validation_fraction.

Example

let x = StratifiedSplit::new().set_validation_fraction(42.0);

pub fn set_test_fraction<T: Into<f64>>(self, v: T) -> Self

Sets the value of test_fraction.

Example

let x = StratifiedSplit::new().set_test_fraction(42.0);

pub fn set_key<T: Into<String>>(self, v: T) -> Self

Sets the value of key.

Example

let x = StratifiedSplit::new().set_key("example");

Trait Implementations

impl Clone for StratifiedSplit

fn clone(&self) -> StratifiedSplit

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for StratifiedSplit

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

Formats the value using the given formatter.

impl Default for StratifiedSplit

fn default() -> StratifiedSplit

Returns the “default value” for a type.

impl Message for StratifiedSplit

fn typename() -> &'static str

The typename of this message.

impl PartialEq for StratifiedSplit

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for StratifiedSplit