pub struct PyLogisticRegression { /* private fields */ }Expand description
Logistic Regression (aka logit, MaxEnt) classifier.
In the multiclass case, the training algorithm uses the one-vs-rest (OvR) scheme if the ‘multi_class’ option is set to ‘ovr’, and uses the cross-entropy loss if the ‘multi_class’ option is set to ‘multinomial’.
This class implements regularized logistic regression using various solvers. Note that regularization is applied by default.
§Parameters
penalty- One of “l1”, “l2”, “elasticnet”. Default: “l2”tol- Tolerance for stopping criteria. Default: 1e-4c- Inverse of regularization strength. Default: 1.0fit_intercept- Whether to add bias term. Default: truesolver- One of “lbfgs”, “newton-cg”, “sag”, “saga”. Default: “lbfgs”max_iter- Maximum iterations. Default: 100multi_class- One of “auto”, “ovr”, “multinomial”. Default: “auto”random_state- Random seed for reproducibilityl1_ratio- Elastic-Net mixing parameter (0 to 1)
§References
Trait Implementations§
Source§impl<'py> IntoPyObject<'py> for PyLogisticRegression
impl<'py> IntoPyObject<'py> for PyLogisticRegression
Source§type Target = PyLogisticRegression
type Target = PyLogisticRegression
The Python output type
Source§type Output = Bound<'py, <PyLogisticRegression as IntoPyObject<'py>>::Target>
type Output = Bound<'py, <PyLogisticRegression as IntoPyObject<'py>>::Target>
The smart pointer type to use. Read more
Source§fn into_pyobject(
self,
py: Python<'py>,
) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>
Performs the conversion.
Source§impl PyClass for PyLogisticRegression
impl PyClass for PyLogisticRegression
Source§impl PyClassImpl for PyLogisticRegression
impl PyClassImpl for PyLogisticRegression
Source§const IS_BASETYPE: bool = false
const IS_BASETYPE: bool = false
#[pyclass(subclass)]
Source§const IS_SUBCLASS: bool = false
const IS_SUBCLASS: bool = false
#[pyclass(extends=…)]
Source§const IS_MAPPING: bool = false
const IS_MAPPING: bool = false
#[pyclass(mapping)]
Source§const IS_SEQUENCE: bool = false
const IS_SEQUENCE: bool = false
#[pyclass(sequence)]
Source§const IS_IMMUTABLE_TYPE: bool = false
const IS_IMMUTABLE_TYPE: bool = false
#[pyclass(immutable_type)]
Source§const RAW_DOC: &'static CStr = /// Logistic Regression (aka logit, MaxEnt) classifier.
///
/// In the multiclass case, the training algorithm uses the one-vs-rest (OvR)
/// scheme if the 'multi_class' option is set to 'ovr', and uses the
/// cross-entropy loss if the 'multi_class' option is set to 'multinomial'.
///
/// This class implements regularized logistic regression using various solvers.
/// **Note that regularization is applied by default**.
///
/// # Parameters
///
/// - `penalty` - One of "l1", "l2", "elasticnet". Default: "l2"
/// - `tol` - Tolerance for stopping criteria. Default: 1e-4
/// - `c` - Inverse of regularization strength. Default: 1.0
/// - `fit_intercept` - Whether to add bias term. Default: true
/// - `solver` - One of "lbfgs", "newton-cg", "sag", "saga". Default: "lbfgs"
/// - `max_iter` - Maximum iterations. Default: 100
/// - `multi_class` - One of "auto", "ovr", "multinomial". Default: "auto"
/// - `random_state` - Random seed for reproducibility
/// - `l1_ratio` - Elastic-Net mixing parameter (0 to 1)
///
/// # References
///
/// - L-BFGS-B: <http://users.iems.northwestern.edu/~nocedal/lbfgsb.html>
/// - SAG: <https://hal.inria.fr/hal-00860051/document>
/// - SAGA: <https://arxiv.org/abs/1407.0202>
const RAW_DOC: &'static CStr = /// Logistic Regression (aka logit, MaxEnt) classifier. /// /// In the multiclass case, the training algorithm uses the one-vs-rest (OvR) /// scheme if the 'multi_class' option is set to 'ovr', and uses the /// cross-entropy loss if the 'multi_class' option is set to 'multinomial'. /// /// This class implements regularized logistic regression using various solvers. /// **Note that regularization is applied by default**. /// /// # Parameters /// /// - `penalty` - One of "l1", "l2", "elasticnet". Default: "l2" /// - `tol` - Tolerance for stopping criteria. Default: 1e-4 /// - `c` - Inverse of regularization strength. Default: 1.0 /// - `fit_intercept` - Whether to add bias term. Default: true /// - `solver` - One of "lbfgs", "newton-cg", "sag", "saga". Default: "lbfgs" /// - `max_iter` - Maximum iterations. Default: 100 /// - `multi_class` - One of "auto", "ovr", "multinomial". Default: "auto" /// - `random_state` - Random seed for reproducibility /// - `l1_ratio` - Elastic-Net mixing parameter (0 to 1) /// /// # References /// /// - L-BFGS-B: <http://users.iems.northwestern.edu/~nocedal/lbfgsb.html> /// - SAG: <https://hal.inria.fr/hal-00860051/document> /// - SAGA: <https://arxiv.org/abs/1407.0202>
Docstring for the class provided on the struct or enum. Read more
Source§const DOC: &'static CStr
const DOC: &'static CStr
Fully rendered class doc, including the
text_signature if a constructor is defined. Read moreSource§type ThreadChecker = SendablePyClass<PyLogisticRegression>
type ThreadChecker = SendablePyClass<PyLogisticRegression>
This handles following two situations: Read more
Source§type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild
Immutable or mutable
Source§type BaseNativeType = PyAny
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<isize>
fn weaklist_offset() -> Option<isize>
Source§impl PyClassNewTextSignature for PyLogisticRegression
impl PyClassNewTextSignature for PyLogisticRegression
const TEXT_SIGNATURE: &'static str = "(penalty=\"l2\", dual=False, tol=1e-4, c=1.0, fit_intercept=True, intercept_scaling=1.0, class_weight=None, random_state=None, solver=\"lbfgs\", max_iter=100, multi_class=\"auto\", verbose=0, warm_start=False, n_jobs=None, l1_ratio=None)"
Source§impl PyMethods<PyLogisticRegression> for PyClassImplCollector<PyLogisticRegression>
impl PyMethods<PyLogisticRegression> for PyClassImplCollector<PyLogisticRegression>
fn py_methods(self) -> &'static PyClassItems
Source§impl PyTypeInfo for PyLogisticRegression
impl PyTypeInfo for PyLogisticRegression
Source§fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject
Returns the PyTypeObject instance for this type.
Source§fn type_object(py: Python<'_>) -> Bound<'_, PyType>
fn type_object(py: Python<'_>) -> Bound<'_, PyType>
Returns the safe abstraction over the type object.
impl DerefToPyAny for PyLogisticRegression
impl ExtractPyClassWithClone for PyLogisticRegression
Auto Trait Implementations§
impl Freeze for PyLogisticRegression
impl RefUnwindSafe for PyLogisticRegression
impl Send for PyLogisticRegression
impl Sync for PyLogisticRegression
impl Unpin for PyLogisticRegression
impl UnsafeUnpin for PyLogisticRegression
impl UnwindSafe for PyLogisticRegression
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> 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<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
impl<'py, T> IntoPyObjectExt<'py> for Twhere
T: IntoPyObject<'py>,
Source§fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
fn into_bound_py_any(self, py: Python<'py>) -> Result<Bound<'py, PyAny>, PyErr>
Converts
self into an owned Python object, dropping type information.Source§impl<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PyErrArguments for T
impl<T> PyErrArguments for T
Source§impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
impl<T> PyTypeCheck for Twhere
T: PyTypeInfo,
Source§const NAME: &'static str = T::NAME
const NAME: &'static str = T::NAME
👎Deprecated since 0.27.0: Use ::classinfo_object() instead and format the type name at runtime. Note that using built-in cast features is often better than manual PyTypeCheck usage.
Name of self. This is used in error messages, for example.