Struct PyStandardScaler 

pub struct PyStandardScaler { /* private fields */ }

Standardize features by removing the mean and scaling to unit variance.

The standard score of a sample x is calculated as:

z = (x - u) / s

where u is the mean of the training samples or zero if with_mean=False, and s is the standard deviation of the training samples or one if with_std=False.

Centering and scaling happen independently on each feature by computing the relevant statistics on the samples in the training set. Mean and standard deviation are then stored to be used on later data using :meth:transform.

Standardization of a dataset is a common requirement for many machine learning estimators: they might behave badly if the individual features do not more or less look like standard normally distributed data (e.g. Gaussian with 0 mean and unit variance).

Parameters

copy : bool, default=True If False, try to avoid a copy and do inplace scaling instead. This is not guaranteed to always work inplace; e.g. if the data is not a NumPy array or scipy.sparse CSR matrix, a copy may still be returned.

with_mean : bool, default=True If True, center the data before scaling. This does not work (and will raise an exception) when attempted on sparse matrices, because centering them entails building a dense matrix which in common use cases is likely to be too large to fit in memory.

with_std : bool, default=True If True, scale the data to unit variance (or equivalently, unit standard deviation).

Attributes

scale_ : ndarray of shape (n_features,) or None Per feature relative scaling of the data to achieve zero mean and unit variance. Generally this is calculated using np.sqrt(var_). If a variance is zero, we can’t achieve unit variance, and the data is left as-is, giving a scaling factor of 1. scale_ is equal to None when with_std=False.

mean_ : ndarray of shape (n_features,) or None The mean value for each feature in the training set. Equal to None when with_mean=False.

var_ : ndarray of shape (n_features,) or None The variance for each feature in the training set. Used to compute scale_. Equal to None when with_std=False.

n_features_in_ : int Number of features seen during :term:fit.

n_samples_seen_ : int The number of samples processed by the estimator. It will be reset on new calls to fit, but increments across partial_fit calls.

Examples

from sklears_python import StandardScaler import numpy as np data = [[0, 0], [0, 0], [1, 1], [1, 1]] scaler = StandardScaler() scaler.fit(data) StandardScaler() print(scaler.mean_) [0.5 0.5] print(scaler.transform(data)) [[-1. -1.] [-1. -1.] [ 1. 1.] [ 1. 1.]] print(scaler.transform([[2, 2]])) [[3. 3.]]

Trait Implementations

impl DerefToPyAny for PyStandardScaler

impl ExtractPyClassWithClone for PyStandardScaler

impl<'py> IntoPyObject<'py> for PyStandardScaler

type Target = PyStandardScaler

The Python output type

type Output = Bound<'py, <PyStandardScaler as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for PyStandardScaler

const NAME: &str = "StandardScaler"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyStandardScaler

const MODULE: Option<&str> = ::core::option::Option::None

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Standardize features by removing the mean and scaling to unit variance. /// /// The standard score of a sample `x` is calculated as: /// /// ```text /// z = (x - u) / s /// ``` /// /// where `u` is the mean of the training samples or zero if `with_mean=False`, /// and `s` is the standard deviation of the training samples or one if /// `with_std=False`. /// /// Centering and scaling happen independently on each feature by computing /// the relevant statistics on the samples in the training set. Mean and /// standard deviation are then stored to be used on later data using /// :meth:`transform`. /// /// Standardization of a dataset is a common requirement for many /// machine learning estimators: they might behave badly if the /// individual features do not more or less look like standard normally /// distributed data (e.g. Gaussian with 0 mean and unit variance). /// /// Parameters /// ---------- /// copy : bool, default=True /// If False, try to avoid a copy and do inplace scaling instead. /// This is not guaranteed to always work inplace; e.g. if the data is /// not a NumPy array or scipy.sparse CSR matrix, a copy may still be /// returned. /// /// with_mean : bool, default=True /// If True, center the data before scaling. /// This does not work (and will raise an exception) when attempted on /// sparse matrices, because centering them entails building a dense /// matrix which in common use cases is likely to be too large to fit in /// memory. /// /// with_std : bool, default=True /// If True, scale the data to unit variance (or equivalently, /// unit standard deviation). /// /// Attributes /// ---------- /// scale_ : ndarray of shape (n_features,) or None /// Per feature relative scaling of the data to achieve zero mean and unit /// variance. Generally this is calculated using `np.sqrt(var_)`. If a /// variance is zero, we can't achieve unit variance, and the data is left /// as-is, giving a scaling factor of 1. `scale_` is equal to `None` /// when `with_std=False`. /// /// mean_ : ndarray of shape (n_features,) or None /// The mean value for each feature in the training set. /// Equal to ``None`` when ``with_mean=False``. /// /// var_ : ndarray of shape (n_features,) or None /// The variance for each feature in the training set. Used to compute /// `scale_`. Equal to ``None`` when ``with_std=False``. /// /// n_features_in_ : int /// Number of features seen during :term:`fit`. /// /// n_samples_seen_ : int /// The number of samples processed by the estimator. /// It will be reset on new calls to fit, but increments across /// ``partial_fit`` calls. /// /// Examples /// -------- /// >>> from sklears_python import StandardScaler /// >>> import numpy as np /// >>> data = [[0, 0], [0, 0], [1, 1], [1, 1]] /// >>> scaler = StandardScaler() /// >>> scaler.fit(data) /// StandardScaler() /// >>> print(scaler.mean_) /// [0.5 0.5] /// >>> print(scaler.transform(data)) /// [[-1. -1.] /// [-1. -1.] /// [ 1. 1.] /// [ 1. 1.]] /// >>> print(scaler.transform([[2, 2]])) /// [[3. 3.]]

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<PyStandardScaler as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyStandardScaler>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for PyStandardScaler

const TEXT_SIGNATURE: &'static str = "(copy=True, with_mean=True, with_std=True)"

impl PyMethods<PyStandardScaler> for PyClassImplCollector<PyStandardScaler>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyStandardScaler

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.