pub struct LabelPropagation<S = Untrained> { /* private fields */ }Expand description
Label Propagation classifier
Label propagation is a graph-based semi-supervised learning algorithm that propagates labels through a neighborhood graph. It uses the graph Laplacian to propagate labels from labeled to unlabeled points.
§Parameters
kernel- Kernel function (‘knn’ or ‘rbf’)gamma- Parameter for RBF kerneln_neighbors- Number of neighbors for KNN kernelalpha- Clamping factor (0.0 = hard clamping, 1.0 = soft clamping)max_iter- Maximum number of iterationstol- Convergence tolerance
§Examples
use scirs2_core::array;
use sklears_semi_supervised::LabelPropagation;
use sklears_core::traits::{Predict, Fit};
let X = array![[1.0, 2.0], [2.0, 3.0], [3.0, 4.0], [4.0, 5.0]];
let y = array![0, 1, -1, -1]; // -1 indicates unlabeled
let lp = LabelPropagation::new()
.kernel("rbf".to_string())
.gamma(20.0);
let fitted = lp.fit(&X.view(), &y.view()).unwrap();
let predictions = fitted.predict(&X.view()).unwrap();Implementations§
Source§impl LabelPropagation<Untrained>
impl LabelPropagation<Untrained>
Sourcepub fn n_neighbors(self, n_neighbors: usize) -> Self
pub fn n_neighbors(self, n_neighbors: usize) -> Self
Set the number of neighbors for KNN kernel
Trait Implementations§
Source§impl<S: Clone> Clone for LabelPropagation<S>
impl<S: Clone> Clone for LabelPropagation<S>
Source§fn clone(&self) -> LabelPropagation<S>
fn clone(&self) -> LabelPropagation<S>
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreSource§impl<S: Debug> Debug for LabelPropagation<S>
impl<S: Debug> Debug for LabelPropagation<S>
Source§impl Default for LabelPropagation<Untrained>
impl Default for LabelPropagation<Untrained>
Source§impl Estimator for LabelPropagation<Untrained>
impl Estimator for LabelPropagation<Untrained>
Source§type Error = SklearsError
type Error = SklearsError
Error type for the estimator
Source§fn validate_config(&self) -> Result<(), SklearsError>
fn validate_config(&self) -> Result<(), SklearsError>
Validate estimator configuration with detailed error context
Source§fn check_compatibility(
&self,
n_samples: usize,
n_features: usize,
) -> Result<(), SklearsError>
fn check_compatibility( &self, n_samples: usize, n_features: usize, ) -> Result<(), SklearsError>
Check if estimator is compatible with given data dimensions
Source§fn metadata(&self) -> EstimatorMetadata
fn metadata(&self) -> EstimatorMetadata
Get estimator metadata
Source§impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&i32>, Dim<[usize; 1]>>> for LabelPropagation<Untrained>
impl Fit<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<ViewRepr<&i32>, Dim<[usize; 1]>>> for LabelPropagation<Untrained>
Source§type Fitted = LabelPropagation<LabelPropagationTrained>
type Fitted = LabelPropagation<LabelPropagationTrained>
The fitted model type
Source§fn fit(
self,
X: &ArrayView2<'_, Float>,
y: &ArrayView1<'_, i32>,
) -> SklResult<Self::Fitted>
fn fit( self, X: &ArrayView2<'_, Float>, y: &ArrayView1<'_, i32>, ) -> SklResult<Self::Fitted>
Fit the model to the provided data with validation
Source§fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
fn fit_with_validation(
self,
x: &X,
y: &Y,
_x_val: Option<&X>,
_y_val: Option<&Y>,
) -> Result<(Self::Fitted, FitMetrics), SklearsError>where
Self: Sized,
Fit with custom validation and early stopping
Source§impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<i32>, Dim<[usize; 1]>>> for LabelPropagation<LabelPropagationTrained>
impl Predict<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<i32>, Dim<[usize; 1]>>> for LabelPropagation<LabelPropagationTrained>
Source§fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array1<i32>>
fn predict(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array1<i32>>
Make predictions on the provided data
Source§fn predict_with_uncertainty(
&self,
x: &X,
) -> Result<(Output, UncertaintyMeasure), SklearsError>
fn predict_with_uncertainty( &self, x: &X, ) -> Result<(Output, UncertaintyMeasure), SklearsError>
Make predictions with confidence intervals
Source§impl PredictProba<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for LabelPropagation<LabelPropagationTrained>
impl PredictProba<ArrayBase<ViewRepr<&f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>> for LabelPropagation<LabelPropagationTrained>
Source§fn predict_proba(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<f64>>
fn predict_proba(&self, X: &ArrayView2<'_, Float>) -> SklResult<Array2<f64>>
Predict class probabilities
Auto Trait Implementations§
impl<S> Freeze for LabelPropagation<S>where
S: Freeze,
impl<S> RefUnwindSafe for LabelPropagation<S>where
S: RefUnwindSafe,
impl<S> Send for LabelPropagation<S>where
S: Send,
impl<S> Sync for LabelPropagation<S>where
S: Sync,
impl<S> Unpin for LabelPropagation<S>where
S: Unpin,
impl<S> UnwindSafe for LabelPropagation<S>where
S: UnwindSafe,
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
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 moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
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 moreSource§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> StableApi for Twhere
T: Estimator,
impl<T> StableApi for Twhere
T: Estimator,
Source§const STABLE_SINCE: &'static str = "0.1.0"
const STABLE_SINCE: &'static str = "0.1.0"
API version this type was stabilized in
Source§const HAS_EXPERIMENTAL_FEATURES: bool = false
const HAS_EXPERIMENTAL_FEATURES: bool = false
Whether this API has any experimental features