#[non_exhaustive]pub struct RftHyperParametersBuilder { /* private fields */ }Expand description
A builder for RftHyperParameters.
Implementations§
Source§impl RftHyperParametersBuilder
impl RftHyperParametersBuilder
Sourcepub fn epoch_count(self, input: i32) -> Self
pub fn epoch_count(self, input: i32) -> Self
Number of training epochs to run during reinforcement fine-tuning. Higher values may improve performance but increase training time.
Sourcepub fn set_epoch_count(self, input: Option<i32>) -> Self
pub fn set_epoch_count(self, input: Option<i32>) -> Self
Number of training epochs to run during reinforcement fine-tuning. Higher values may improve performance but increase training time.
Sourcepub fn get_epoch_count(&self) -> &Option<i32>
pub fn get_epoch_count(&self) -> &Option<i32>
Number of training epochs to run during reinforcement fine-tuning. Higher values may improve performance but increase training time.
Sourcepub fn batch_size(self, input: i32) -> Self
pub fn batch_size(self, input: i32) -> Self
Number of training samples processed in each batch during reinforcement fine-tuning (RFT) training. Larger batches may improve training stability.
Sourcepub fn set_batch_size(self, input: Option<i32>) -> Self
pub fn set_batch_size(self, input: Option<i32>) -> Self
Number of training samples processed in each batch during reinforcement fine-tuning (RFT) training. Larger batches may improve training stability.
Sourcepub fn get_batch_size(&self) -> &Option<i32>
pub fn get_batch_size(&self) -> &Option<i32>
Number of training samples processed in each batch during reinforcement fine-tuning (RFT) training. Larger batches may improve training stability.
Sourcepub fn learning_rate(self, input: f32) -> Self
pub fn learning_rate(self, input: f32) -> Self
Learning rate for the reinforcement fine-tuning. Controls how quickly the model adapts to reward signals.
Sourcepub fn set_learning_rate(self, input: Option<f32>) -> Self
pub fn set_learning_rate(self, input: Option<f32>) -> Self
Learning rate for the reinforcement fine-tuning. Controls how quickly the model adapts to reward signals.
Sourcepub fn get_learning_rate(&self) -> &Option<f32>
pub fn get_learning_rate(&self) -> &Option<f32>
Learning rate for the reinforcement fine-tuning. Controls how quickly the model adapts to reward signals.
Sourcepub fn max_prompt_length(self, input: i32) -> Self
pub fn max_prompt_length(self, input: i32) -> Self
Maximum length of input prompts during RFT training, measured in tokens. Longer prompts allow more context but increase memory usage and training-time.
Sourcepub fn set_max_prompt_length(self, input: Option<i32>) -> Self
pub fn set_max_prompt_length(self, input: Option<i32>) -> Self
Maximum length of input prompts during RFT training, measured in tokens. Longer prompts allow more context but increase memory usage and training-time.
Sourcepub fn get_max_prompt_length(&self) -> &Option<i32>
pub fn get_max_prompt_length(&self) -> &Option<i32>
Maximum length of input prompts during RFT training, measured in tokens. Longer prompts allow more context but increase memory usage and training-time.
Sourcepub fn training_sample_per_prompt(self, input: i32) -> Self
pub fn training_sample_per_prompt(self, input: i32) -> Self
Number of response samples generated per prompt during RFT training. More samples provide better reward signal estimation.
Sourcepub fn set_training_sample_per_prompt(self, input: Option<i32>) -> Self
pub fn set_training_sample_per_prompt(self, input: Option<i32>) -> Self
Number of response samples generated per prompt during RFT training. More samples provide better reward signal estimation.
Sourcepub fn get_training_sample_per_prompt(&self) -> &Option<i32>
pub fn get_training_sample_per_prompt(&self) -> &Option<i32>
Number of response samples generated per prompt during RFT training. More samples provide better reward signal estimation.
Sourcepub fn inference_max_tokens(self, input: i32) -> Self
pub fn inference_max_tokens(self, input: i32) -> Self
Maximum number of tokens the model can generate in response to each prompt during RFT training.
Sourcepub fn set_inference_max_tokens(self, input: Option<i32>) -> Self
pub fn set_inference_max_tokens(self, input: Option<i32>) -> Self
Maximum number of tokens the model can generate in response to each prompt during RFT training.
Sourcepub fn get_inference_max_tokens(&self) -> &Option<i32>
pub fn get_inference_max_tokens(&self) -> &Option<i32>
Maximum number of tokens the model can generate in response to each prompt during RFT training.
Sourcepub fn reasoning_effort(self, input: ReasoningEffort) -> Self
pub fn reasoning_effort(self, input: ReasoningEffort) -> Self
Level of reasoning effort applied during RFT training. Higher values may improve response quality but increase training time.
Sourcepub fn set_reasoning_effort(self, input: Option<ReasoningEffort>) -> Self
pub fn set_reasoning_effort(self, input: Option<ReasoningEffort>) -> Self
Level of reasoning effort applied during RFT training. Higher values may improve response quality but increase training time.
Sourcepub fn get_reasoning_effort(&self) -> &Option<ReasoningEffort>
pub fn get_reasoning_effort(&self) -> &Option<ReasoningEffort>
Level of reasoning effort applied during RFT training. Higher values may improve response quality but increase training time.
Sourcepub fn eval_interval(self, input: i32) -> Self
pub fn eval_interval(self, input: i32) -> Self
Interval between evaluation runs during RFT training, measured in training steps. More frequent evaluation provides better monitoring.
Sourcepub fn set_eval_interval(self, input: Option<i32>) -> Self
pub fn set_eval_interval(self, input: Option<i32>) -> Self
Interval between evaluation runs during RFT training, measured in training steps. More frequent evaluation provides better monitoring.
Sourcepub fn get_eval_interval(&self) -> &Option<i32>
pub fn get_eval_interval(&self) -> &Option<i32>
Interval between evaluation runs during RFT training, measured in training steps. More frequent evaluation provides better monitoring.
Sourcepub fn build(self) -> RftHyperParameters
pub fn build(self) -> RftHyperParameters
Consumes the builder and constructs a RftHyperParameters.
Trait Implementations§
Source§impl Clone for RftHyperParametersBuilder
impl Clone for RftHyperParametersBuilder
Source§fn clone(&self) -> RftHyperParametersBuilder
fn clone(&self) -> RftHyperParametersBuilder
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source. Read moreSource§impl Debug for RftHyperParametersBuilder
impl Debug for RftHyperParametersBuilder
Source§impl Default for RftHyperParametersBuilder
impl Default for RftHyperParametersBuilder
Source§fn default() -> RftHyperParametersBuilder
fn default() -> RftHyperParametersBuilder
impl StructuralPartialEq for RftHyperParametersBuilder
Auto Trait Implementations§
impl Freeze for RftHyperParametersBuilder
impl RefUnwindSafe for RftHyperParametersBuilder
impl Send for RftHyperParametersBuilder
impl Sync for RftHyperParametersBuilder
impl Unpin for RftHyperParametersBuilder
impl UnwindSafe for RftHyperParametersBuilder
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
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
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>
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>
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> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the foreground set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red() and
green(), which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg():
use yansi::{Paint, Color};
painted.fg(Color::White);Set foreground color to white using white().
use yansi::Paint;
painted.white();Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self with the background set to
value.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red() and
on_green(), which have the same functionality but
are pithier.
§Example
Set background color to red using fg():
use yansi::{Paint, Color};
painted.bg(Color::Red);Set background color to red using on_red().
use yansi::Paint;
painted.on_red();Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute value.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold() and
underline(), which have the same functionality
but are pithier.
§Example
Make text bold using attr():
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);Make text bold using using bold().
use yansi::Paint;
painted.bold();Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi Quirk value.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask() and
wrap(), which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk():
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);Enable wrapping using wrap().
use yansi::Paint;
painted.wrap();Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting() due to conflicts with Vec::clear().
The clear() method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted only when both stdout and stderr are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);