Struct TopologyCommunicationPlan 

pub struct TopologyCommunicationPlan { /* private fields */ }

Semantic inputs used only while projecting opaque communication descriptors.

Implementations

impl TopologyCommunicationPlan

pub const fn new() -> Self

Creates an empty projection plan.

pub fn with_completion_policy( self, policy: CommunicationCompletionPolicy, ) -> Self

Selects one bounded completion policy for every operation in the manifest.

pub fn with_session_group( self, requirements: CommunicationGroupRequirements, ) -> Self

Requests one group containing every participant in world-rank order.

Session groups are projected before axis groups, so their opaque ID is stable across the set of active Cartesian axes.

pub const fn session_group_id(&self) -> Option<CollectiveGroupId>

Exact opaque ID assigned to the requested session group.

pub fn with_tensor_groups( self, requirements: CommunicationGroupRequirements, ) -> Self

Requests groups varying the tensor coordinate.

pub fn tensor_group_id( &self, topology: ParallelTopology, rank: ParallelRankTopology, ) -> Result<Option<CollectiveGroupId>, CommunicationManifestError>

Exact opaque tensor-group ID assigned to one rank by this projection plan.

pub fn with_pipeline_groups( self, requirements: CommunicationGroupRequirements, ) -> Self

Requests groups varying the pipeline coordinate.

pub fn with_expert_groups( self, requirements: CommunicationGroupRequirements, ) -> Self

Requests groups varying the expert coordinate.

pub fn with_data_groups( self, requirements: CommunicationGroupRequirements, ) -> Self

Represents future groups varying the data coordinate.

This is a topology projection facility, not product admission of data parallel execution. Product selection must continue to reject it until its semantics are implemented.

pub fn with_pipeline_routes( self, requirement: CommunicationOperationRequirement, ) -> Result<Self, CommunicationManifestError>

Requests directed routes between adjacent pipeline coordinates.

Trait Implementations

impl Clone for TopologyCommunicationPlan

fn clone(&self) -> TopologyCommunicationPlan

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TopologyCommunicationPlan

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

Formats the value using the given formatter.

impl Default for TopologyCommunicationPlan

fn default() -> TopologyCommunicationPlan

Returns the “default value” for a type.

impl Eq for TopologyCommunicationPlan

impl PartialEq for TopologyCommunicationPlan

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for TopologyCommunicationPlan