pub struct GpuIndexOptimizer { /* private fields */ }Expand description
Optimises GPU memory usage during index construction by computing ideal batch sizes and checking memory feasibility.
Implementations§
Source§impl GpuIndexOptimizer
impl GpuIndexOptimizer
Sourcepub fn new(total_mb: u64, reserved_mb: u64) -> Self
pub fn new(total_mb: u64, reserved_mb: u64) -> Self
Create an optimizer with the given total and reserved GPU memory (MB).
Sourcepub fn memory_budget(&self) -> &GpuMemoryBudget
pub fn memory_budget(&self) -> &GpuMemoryBudget
Return a reference to the underlying memory budget.
Sourcepub fn recommend_batch_size(&self, vector_dim: usize) -> usize
pub fn recommend_batch_size(&self, vector_dim: usize) -> usize
Recommend a batch size for index construction given the vector dimension.
Sourcepub fn batch_fits(&self, batch_size: usize, vector_dim: usize) -> bool
pub fn batch_fits(&self, batch_size: usize, vector_dim: usize) -> bool
Check whether a specific batch fits within the available budget.
Trait Implementations§
Source§impl Clone for GpuIndexOptimizer
impl Clone for GpuIndexOptimizer
Source§fn clone(&self) -> GpuIndexOptimizer
fn clone(&self) -> GpuIndexOptimizer
Returns a duplicate of the value. Read more
1.0.0 · Source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from
source. Read moreAuto Trait Implementations§
impl Freeze for GpuIndexOptimizer
impl RefUnwindSafe for GpuIndexOptimizer
impl Send for GpuIndexOptimizer
impl Sync for GpuIndexOptimizer
impl Unpin for GpuIndexOptimizer
impl UnsafeUnpin for GpuIndexOptimizer
impl UnwindSafe for GpuIndexOptimizer
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> 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>
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<T> Pointable for T
impl<T> Pointable for T
Source§impl<T> PolicyExt for Twhere
T: ?Sized,
impl<T> PolicyExt for Twhere
T: ?Sized,
Source§impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
impl<SS, SP> SupersetOf<SS> for SPwhere
SS: SubsetOf<SP>,
Source§fn to_subset(&self) -> Option<SS>
fn to_subset(&self) -> Option<SS>
The inverse inclusion map: attempts to construct
self from the equivalent element of its
superset. Read moreSource§fn is_in_subset(&self) -> bool
fn is_in_subset(&self) -> bool
Checks if
self is actually part of its subset T (and can be converted to it).Source§fn to_subset_unchecked(&self) -> SS
fn to_subset_unchecked(&self) -> SS
Use with care! Same as
self.to_subset but without any property checks. Always succeeds.Source§fn from_subset(element: &SS) -> SP
fn from_subset(element: &SS) -> SP
The inclusion map: converts
self to the equivalent element of its superset.