Skip to main content

FairScaleIntegration

Struct FairScaleIntegration 

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

FairScale compatibility integration

Implementations§

Source§

impl FairScaleIntegration

Source

pub fn new(config: FairScaleConfig) -> Self

Create a new FairScale integration

Source

pub fn from_file<P: AsRef<Path>>(path: P) -> TorshResult<Self>

Load configuration from JSON file

Source

pub fn initialize( &mut self, rank: u32, world_size: u32, local_rank: u32, local_size: u32, ) -> TorshResult<()>

Initialize FairScale integration

Source

pub fn to_fsdp_config(&self) -> TorshResult<FsdpConfig>

Convert FairScale config to ToRSh FSDP config

Source

pub fn to_pipeline_config(&self) -> TorshResult<Option<PipelineConfig>>

Convert FairScale config to ToRSh pipeline config

Source

pub fn config(&self) -> &FairScaleConfig

Get the current configuration

Source

pub fn stats(&self) -> &FairScaleStats

Get current statistics

Source

pub fn is_initialized(&self) -> bool

Check if FairScale integration is initialized

Source

pub fn rank(&self) -> u32

Get current rank

Source

pub fn world_size(&self) -> u32

Get world size

Source

pub fn local_rank(&self) -> u32

Get local rank

Source

pub fn local_size(&self) -> u32

Get local size

Source

pub fn fsdp_operation( &mut self, operation_name: &str, parameter_count: usize, ) -> TorshResult<()>

Simulate FSDP operation

Source

pub fn oss_operation( &mut self, operation_name: &str, optimizer_state_size: usize, ) -> TorshResult<()>

Simulate OSS operation

Source

pub fn record_activation_checkpoint( &mut self, layer_name: &str, memory_saved: usize, )

Record activation checkpoint

Source

pub fn record_gradient_scaling_event(&mut self, scale_factor: f32)

Record gradient scaling event

Source

pub fn default_config() -> FairScaleConfig

Create a default FairScale configuration

Source

pub fn config_with_fsdp_mixed_precision() -> FairScaleConfig

Create a configuration with FSDP and mixed precision

Source

pub fn config_with_pipeline_parallelism(stages: u32) -> FairScaleConfig

Create a configuration with pipeline parallelism

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

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

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

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.

Source§

impl<T> IntoEither for T

Source§

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 more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

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 more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
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.
Source§

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

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

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

fn with_current_subscriber(self) -> WithDispatch<Self>

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