Struct BoosterParameters

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

Parameters for training boosters. Created using BoosterParametersBuilder.

Implementations§

Source§

impl BoosterParameters

Source

pub fn booster_type(&self) -> &BoosterType

Get type of booster (tree, linear or DART) along with its parameters.

Source

pub fn set_booster_type<T: Into<BoosterType>>(&mut self, booster_type: T)

Set type of booster (tree, linear or DART) along with its parameters.

Source

pub fn learning_params(&self) -> &LearningTaskParameters

Get configuration for the learning objective.

Source

pub fn set_learning_params<T: Into<LearningTaskParameters>>( &mut self, learning_params: T, )

Set configuration for the learning objective.

Source

pub fn verbose(&self) -> bool

Check whether verbose output is enabled or not.

Source

pub fn set_verbose(&mut self, verbose: bool)

Set to true to enable verbose output from XGBoost’s C library.

Source

pub fn threads(&self) -> &Option<u32>

Get number of parallel threads XGBoost will use (if compiled with multiprocessing support).

If None, XGBoost will determine the number of threads to use automatically.

Source

pub fn set_threads<T: Into<Option<u32>>>(&mut self, threads: T)

Set number of parallel threads XGBoost will use (if compiled with multiprocessing support).

If None, XGBoost will determine the number of threads to use automatically.

Trait Implementations§

Source§

impl Clone for BoosterParameters

Source§

fn clone(&self) -> BoosterParameters

Returns a duplicate of the value. Read more
1.0.0 · Source§

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Default for BoosterParameters

Source§

fn default() -> BoosterParameters

Returns the “default value” for a type. Read more

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.