LogisticRegressionBuilder

Struct LogisticRegressionBuilder 

Source
pub struct LogisticRegressionBuilder { /* private fields */ }
Expand description

Builder for creating LogisticRegression models with customizable configurations.

The LogisticRegressionBuilder provides methods to configure the properties of a LogisticRegression model before it is instantiated, following the Builder design pattern.

§Fields

  • n_features - The number of input features for the logistic regression model
  • activation_fn - The activation function to use (default: Sigmoid)

§Examples

use rust_ml::model::logistic_regression::LogisticRegression;
use rust_ml::core::activations::activation_functions::ActivationFn;
use rust_ml::builders::builder::Builder;

// Create a logistic regression model with 4 features and sigmoid activation
let model = LogisticRegression::builder()
    .n_features(4)
    .activation_function(ActivationFn::Sigmoid)
    .build()
    .unwrap();

Implementations§

Source§

impl LogisticRegressionBuilder

Source

pub fn new() -> Self

Creates a new LogisticRegressionBuilder with default parameter values.

The default configuration uses 1 feature and the Sigmoid activation function.

§Returns
  • Self - A new LogisticRegressionBuilder instance with default settings
Source

pub fn n_features(self, n_features: usize) -> Self

Sets the number of input features for the logistic regression model.

§Arguments
  • n_features - The number of independent variables (features) in the input data
§Returns
  • Self - Builder instance with updated feature count for method chaining
Source

pub fn activation_function(self, activation_function: ActivationFn) -> Self

Sets the activation function to use in the logistic regression model.

While sigmoid is the traditional activation function for logistic regression, other functions like ReLU or Tanh could be used for specific use cases.

§Arguments
  • activation_function - The activation function to use
§Returns
  • Self - Builder instance with updated activation function for method chaining
Source

pub fn threshold(self, threshold: f64) -> Self

Sets the classification threshold for the logistic regression model.

§Arguments
  • threshold - The threshold value for classifying predictions (between 0 and 1)
§Returns
  • Self - Builder instance with updated threshold for method chaining

Trait Implementations§

Source§

impl Builder<LogisticRegression, ArrayBase<OwnedRepr<f64>, Dim<[usize; 2]>>, ArrayBase<OwnedRepr<f64>, Dim<[usize; 1]>>> for LogisticRegressionBuilder

Source§

fn build(&self) -> Result<LogisticRegression, ModelError>

Builds and returns a new LogisticRegression model with the configured parameters.

§Returns
  • Result<LogisticRegression, ModelError> - A new LogisticRegression instance with the specified configuration, or an error if construction fails
Source§

impl Default for LogisticRegressionBuilder

Source§

fn default() -> Self

Creates a new LogisticRegressionBuilder with default parameter values.

The default configuration uses 1 feature and the Sigmoid activation function.

§Returns
  • Self - A new LogisticRegressionBuilder instance with default settings

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

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<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. 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