Skip to main content

Budget

Struct Budget 

pub struct Budget {
    pub max_trials: Option<u64>,
    pub max_fidelity_units: Option<u64>,
    pub deadline_millis: Option<u64>,
}
Expand description

What a study is allowed to spend.

Every field is optional; None means unbounded. Budgets are enforced at ask time and exposed to objectives through TrialCtx::budget, because an RL run legitimately needs to know how many environment steps it may use (the budget).

Fields§

§max_trials: Option<u64>

Maximum number of trials to create.

§max_fidelity_units: Option<u64>

Cooperative maximum total fidelity, in the study’s ResourceUnit, summed over durable trial reports.

The gate is evaluated from a storage snapshot before new work starts. Already-running trials may therefore carry the durable total past this value when multiple handles execute concurrently. Use it as a stop signal, not as an atomic cross-process reservation.

The overshoot is bounded, not unknown. Admission stops the instant the durable total reaches the limit, so everything above it is work that was already in flight: with P handles running concurrently and a per-trial charge of at most F units, the total can exceed the limit by at most P * F. A single handle therefore overshoots by at most the one trial that crossed the line.

A hard atomic reservation was considered and deliberately not built: it would need an owning cross-process protocol to reserve and settle units before every evaluation, and this budget stops a search rather than metering a paid resource, so the bound above is what the contract owes.

§deadline_millis: Option<u64>

Wall-clock deadline, in the study clock’s milliseconds. Compared against a Clock; never read from the OS here.

Implementations§

§

impl Budget

pub const fn unbounded() -> Self

An unbounded budget.

pub const fn trials(max_trials: u64) -> Self

A budget of max_trials trials.

pub const fn with_fidelity_units(self, units: u64) -> Self

Sets the cooperative fidelity budget.

This is an ask-time stop signal based on durable reports, not an atomic reservation. Concurrent in-flight trials can overshoot it.

pub const fn with_deadline_millis(self, millis: u64) -> Self

Sets the deadline, in the study clock’s milliseconds.

pub const fn is_unbounded(&self) -> bool

true if nothing is limited.

pub fn is_exhausted( &self, trials: u64, fidelity_units: u64, now_millis: u64, ) -> bool

true if the budget is exhausted at (trials, fidelity_units, now).

now_millis comes from the study’s Clock.

Trait Implementations§

§

impl Clone for Budget

§

fn clone(&self) -> Budget

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
§

impl Copy for Budget

§

impl Debug for Budget

§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
§

impl Default for Budget

§

fn default() -> Budget

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

impl<'de> Deserialize<'de> for Budget

§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
§

impl Eq for Budget

§

impl PartialEq for Budget

§

fn eq(&self, other: &Budget) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
§

impl Serialize for Budget

§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
§

impl StructuralPartialEq for Budget

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
§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

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> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> Instrument for T

§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided [Span], returning an Instrumented wrapper. Read more
§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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.

§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V

§

impl<T> WithSubscriber for T

§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a [WithDispatch] wrapper. Read more
§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a [WithDispatch] wrapper. Read more