Struct PyKMeans 

pub struct PyKMeans { /* private fields */ }

K-Means clustering.

Partitions data into n_clusters clusters by iteratively assigning points to the nearest centroid and recomputing centroids, using K-means++ initialization for the starting centroids.

Implementations

impl PyKMeans

pub fn fit_core(&mut self, x: &Array2<f64>) -> PyResult<()>

Core fit logic operating on plain ndarray types (no PyO3 dependency), so it is directly unit-testable without a live Python interpreter. This crate builds with pyo3’s extension-module feature (required so the compiled cdylib can be imported from Python), which means Python::with_gil cannot be used from a standalone cargo test binary – so all #[cfg(test)] coverage in this file goes through *_core helpers like this one instead of exercising the #[pymethods] directly.

pub (rather than crate-private) so that benches/core_helpers_benchmarks.rs – which compiles as a separate crate – can call it directly for the same reason; this is a minimal exposed surface for benchmarking, not part of the stable Python-facing API.

pub fn predict_core(&self, x: &Array2<f64>) -> PyResult<Vec<i32>>

Core predict logic; see fit_core for why this is split out and pub (exposed for benchmarking from benches/, not part of the stable Python-facing API).

impl PyKMeans

pub fn new( n_clusters: usize, max_iter: usize, tol: f64, random_state: Option<u64>, ) -> Self

pub in addition to being reachable from Python via #[new], so benches/core_helpers_benchmarks.rs (a separate crate) can construct instances to call fit_core/predict_core on; not part of the stable Python-facing API surface.

Trait Implementations

impl DerefToPyAny for PyKMeans

impl ExtractPyClassWithClone for PyKMeans

impl<'py> IntoPyObject<'py> for PyKMeans

type Target = PyKMeans

The Python output type

type Output = Bound<'py, <PyKMeans 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 PyKMeans

const NAME: &str = "KMeans"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for PyKMeans

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 = /// K-Means clustering. /// /// Partitions data into `n_clusters` clusters by iteratively assigning /// points to the nearest centroid and recomputing centroids, using /// K-means++ initialization for the starting centroids.

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 = <<PyKMeans as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<PyKMeans>

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 PyKMeans

const TEXT_SIGNATURE: &'static str = "(n_clusters=8, max_iter=300, tol=1e-4, random_state=None)"

impl PyMethods<PyKMeans> for PyClassImplCollector<PyKMeans>

fn py_methods(self) -> &'static PyClassItems

impl PyTypeInfo for PyKMeans

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.