session

Documentation

Index

• Constants
• type Session
  • func New(strategy kb.Strategy, self plan.PeerID, pl plan.PeerList, ...) (*Session, bool)
  • func (sess *Session) AllGather(w kb.Workspace) error
  • func (sess *Session) AllReduce(w base.Workspace) error
  • func (sess *Session) AllReduceWith(tree []int32, w kb.Workspace) error
  • func (sess *Session) Barrier() error
  • func (sess *Session) Broadcast(w kb.Workspace) error
  • func (sess *Session) BytesConsensus(bs []byte, name string) (bool, error)
  • func (sess *Session) CalcStats()
  • func (sess *Session) CheckInterference() bool
  • func (sess *Session) Consensus(w kb.Workspace) error
  • func (sess *Session) CrossAllReduce(w base.Workspace) error
  • func (sess *Session) Gather(w kb.Workspace) error
  • func (sess *Session) GetEgressRates() []float64
  • func (sess *Session) GetNumStrategies() int
  • func (sess *Session) GetPeerLatencies() []time.Duration
  • func (sess *Session) HostCount() int
  • func (sess *Session) LocalBroadcast(w kb.Workspace) error
  • func (sess *Session) LocalRank() int
  • func (sess *Session) LocalReduce(w kb.Workspace) error
  • func (sess *Session) LocalSize() int
  • func (sess *Session) LogStats()
  • func (sess *Session) Peer(rank int) plan.PeerID
  • func (sess *Session) PrintStategyStats()
  • func (sess *Session) Rank() int
  • func (sess *Session) Reduce(w kb.Workspace) error
  • func (sess *Session) SetGlobalStrategy(sl strategyList) error
  • func (sess *Session) SimpleSetGlobalStrategy(forest []int32) error
  • func (sess *Session) Size() int
• type StrategyStat
  • func (ss *StrategyStat) GetSnapshot() StrategyStatSnapshot
  • func (ss *StrategyStat) Reset()
  • func (ss *StrategyStat) Update(begin, end time.Time, size int)
• type StrategyStatSnapshot

Constants

const (
	Mi = 1 << 20
)

Types

type Session

type Session struct {
	sync.Mutex
	// contains filtered or unexported fields
}

Session contains the immutable peer list for a given period of logical duration

func New

func New(strategy kb.Strategy, self plan.PeerID, pl plan.PeerList, client *client.Client, collectiveHandler *handler.CollectiveEndpoint) (*Session, bool)

func (*Session) AllGather

func (sess *Session) AllGather(w kb.Workspace) error

func (*Session) AllReduce

func (sess *Session) AllReduce(w base.Workspace) error

func (*Session) AllReduceWith

func (sess *Session) AllReduceWith(tree []int32, w kb.Workspace) error

AllReduceWith persoms an AllReduce collective communication operation given a tree topology for the strategy to be executted. ATTENTION: not stable feauture. Only for internal use.

func (*Session) Barrier

func (sess *Session) Barrier() error

func (*Session) Broadcast

func (sess *Session) Broadcast(w kb.Workspace) error

func (*Session) BytesConsensus

func (sess *Session) BytesConsensus(bs []byte, name string) (bool, error)

func (*Session) CalcStats

func (sess *Session) CalcStats()

CalcStats reports a Stat object for the current active strategyt

func (*Session) CheckInterference

func (sess *Session) CheckInterference() bool

CheckInterference is checking current state of the strategy stat metrics against the reference window and communicates with the cluster whether to change to an alternate communication strategy or not. Returns true if the cluster reached consensus on changing, flase otherwise.

func (*Session) Consensus

func (sess *Session) Consensus(w kb.Workspace) error

func (*Session) CrossAllReduce

func (sess *Session) CrossAllReduce(w base.Workspace) error

CrossAllReduce performs allreduce across all local roots.

func (*Session) Gather

func (sess *Session) Gather(w kb.Workspace) error

func (*Session) GetEgressRates

func (sess *Session) GetEgressRates() []float64

func (*Session) GetNumStrategies

func (sess *Session) GetNumStrategies() int

GetNumStrategies returns the number of different strategies for a given session

func (*Session) GetPeerLatencies

func (sess *Session) GetPeerLatencies() []time.Duration

GetPeerLatencies is deprecated

func (*Session) HostCount

func (sess *Session) HostCount() int

func (*Session) LocalBroadcast

func (sess *Session) LocalBroadcast(w kb.Workspace) error

func (*Session) LocalRank

func (sess *Session) LocalRank() int

func (*Session) LocalReduce

func (sess *Session) LocalReduce(w kb.Workspace) error

func (*Session) LocalSize

func (sess *Session) LocalSize() int

func (*Session) LogStats

func (sess *Session) LogStats()

LogStats stores a snapshot of the `StrategyStat` object for the current active communication strategy

func (*Session) Peer

func (sess *Session) Peer(rank int) plan.PeerID

func (*Session) PrintStategyStats

func (sess *Session) PrintStategyStats()

PrintStategyStats prints the Strategy Stats Snapshots that have been logged in the `sess.strategyStats` slice

func (*Session) Rank

func (sess *Session) Rank() int

func (*Session) Reduce

func (sess *Session) Reduce(w kb.Workspace) error

func (*Session) SetGlobalStrategy

func (sess *Session) SetGlobalStrategy(sl strategyList) error

func (*Session) SimpleSetGlobalStrategy

func (sess *Session) SimpleSetGlobalStrategy(forest []int32) error

func (*Session) Size

func (sess *Session) Size() int

type StrategyStat

type StrategyStat struct {
	Throughput float64
	// contains filtered or unexported fields
}

StrategyStat holds statistical data for a specific strategy

func (*StrategyStat) GetSnapshot

func (ss *StrategyStat) GetSnapshot() StrategyStatSnapshot

GetSnapshot return a StrategyStatSnapshot object containing a snapshot of the strategy's statistics

func (*StrategyStat) Reset

func (ss *StrategyStat) Reset()

Reset resets the counters associated with a specfiic `StrategyStat` object

func (*StrategyStat) Update

func (ss *StrategyStat) Update(begin, end time.Time, size int)

Update set the appropriate counters associated with a specific `StrategyStat` object

type StrategyStatSnapshot

type StrategyStatSnapshot struct {
	Throughput float64
}

StrategyStatSnapshot holds a snapshot of major metrics from the `StrategyStat` object