Skip to main content

QualityProfile

Struct QualityProfile 

Source
pub struct QualityProfile {
    pub name: String,
    pub description: String,
    pub expected_constant_columns: HashSet<String>,
    pub nullable_columns: HashSet<String>,
    pub max_null_ratio: f64,
    pub max_duplicate_ratio: f64,
    pub min_cardinality: usize,
    pub max_outlier_ratio: f64,
    pub max_duplicate_row_ratio: f64,
    pub penalize_unexpected_constants: bool,
    pub require_signature: bool,
}
Expand description

Quality profile for customizing scoring rules per data type.

Different data types (doctest corpora, ML training sets, time series, etc.) have different expectations. For example:

  • Doctest corpus: source and version columns are expected to be constant
  • ML training: features should have high variance, labels can be categorical
  • Time series: timestamps should be unique and sequential

§Example

let profile = QualityProfile::doctest_corpus();
let score = profile.score_report(&report);

Fields§

§name: String

Profile name for display

§description: String

Description of what this profile is for

§expected_constant_columns: HashSet<String>

Columns that are expected to be constant (not penalized)

§nullable_columns: HashSet<String>

Columns where high null ratio is acceptable

§max_null_ratio: f64

Maximum acceptable null ratio (default: 0.1)

§max_duplicate_ratio: f64

Maximum acceptable duplicate ratio (default: 0.5)

§min_cardinality: usize

Minimum cardinality before flagging as low (default: 2)

§max_outlier_ratio: f64

Maximum outlier ratio to report (default: 0.05)

§max_duplicate_row_ratio: f64

Maximum duplicate row ratio (default: 0.01)

§penalize_unexpected_constants: bool

Whether to penalize constant columns not in expected list

§require_signature: bool

Whether this profile requires a signature column (for doctest)

Implementations§

Source§

impl QualityProfile

Source

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

Create a new profile with custom name

Source

pub fn by_name(name: &str) -> Option<Self>

Get profile by name

Source

pub fn available_profiles() -> Vec<&'static str>

List available profile names

Source

pub fn doctest_corpus() -> Self

Doctest corpus profile - for Python doctest extraction datasets.

Expects:

  • source and version columns to be constant (single crate/version)
  • signature column may have nulls (module-level doctests)
  • input, expected, function should be non-null
Source

pub fn ml_training() -> Self

ML training profile - for machine learning datasets.

Expects:

  • Features to have reasonable variance
  • Labels can be categorical (low cardinality OK)
  • No null values in features or labels
Source

pub fn time_series() -> Self

Time series profile - for temporal data.

Expects:

  • Timestamp column should be unique
  • Data should have temporal patterns
Source

pub fn with_description(self, desc: impl Into<String>) -> Self

Set description

Source

pub fn with_expected_constant(self, column: impl Into<String>) -> Self

Add an expected constant column

Source

pub fn with_nullable(self, column: impl Into<String>) -> Self

Add a nullable column

Source

pub fn with_max_null_ratio(self, ratio: f64) -> Self

Set max null ratio

Source

pub fn with_max_duplicate_ratio(self, ratio: f64) -> Self

Set max duplicate ratio

Source

pub fn is_expected_constant(&self, column: &str) -> bool

Check if a column is expected to be constant

Source

pub fn is_nullable(&self, column: &str) -> bool

Check if a column is allowed to have nulls

Source

pub fn null_threshold_for(&self, column: &str) -> f64

Get effective null threshold for a column

Trait Implementations§

Source§

impl Clone for QualityProfile

Source§

fn clone(&self) -> QualityProfile

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for QualityProfile

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for QualityProfile

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

Source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

impl<T> Allocation for T
where T: RefUnwindSafe + Send + Sync,