IntelĀ® Machine Learning Scaling Library  2018
A library providing an efficient implementation of communication patterns used in deep learning.
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros
Public Member Functions | List of all members
MLSL::Activation Class Reference

A wrapper class for operation input and output activations. More...

#include <mlsl.hpp>

Public Member Functions

size_t GetGlobalFmCount ()
 
size_t GetGlobalFmOffset ()
 
size_t GetLocalFmCount ()
 
size_t GetPackBlockCount ()
 
size_t GetUnpackBlockCount ()
 
CommBlockInfoGetPackBlock (size_t idx)
 
CommBlockInfoGetUnpackBlock (size_t idx)
 
DataType GetDataType ()
 
size_t GetFmSize ()
 
void * GetCommBuf ()
 
size_t GetCommBufSize ()
 
void StartComm (void *buf)
 
void * WaitComm ()
 

Detailed Description

A wrapper class for operation input and output activations.

Holds information about the input/output activation shape and allows performing associated communications.

Member Function Documentation

void* MLSL::Activation::GetCommBuf ( )
Returns
A pointer to internally allocated buffer sufficient for packing/unpacking.
size_t MLSL::Activation::GetCommBufSize ( )
Returns
The size of internally allocated buffer sufficient for packing/unpacking.
DataType MLSL::Activation::GetDataType ( )
Returns
The data type of the feature map elements.
size_t MLSL::Activation::GetFmSize ( )
Returns
The size of a feature map in MLSL::DataType elements.
size_t MLSL::Activation::GetGlobalFmCount ( )
Returns
The global count of feature maps.
size_t MLSL::Activation::GetGlobalFmOffset ( )
Returns
The offset of the local portion of feature maps in the global count of feature maps.
size_t MLSL::Activation::GetLocalFmCount ( )
Returns
The local count of feature maps (the length of the local portion being processed by this process).
CommBlockInfo* MLSL::Activation::GetPackBlock ( size_t  idx)

Returns the CommBlockInfo object containing information for packing.

Parameters
idxthe object index
Returns
Block information for packing.
size_t MLSL::Activation::GetPackBlockCount ( )
Returns
The count of data blocks being sent for this Activation instance.
CommBlockInfo* MLSL::Activation::GetUnpackBlock ( size_t  idx)

Returns the CommBlockInfo object containing information for unpacking.

Parameters
idxthe object index
Returns
Block information for unpacking.
size_t MLSL::Activation::GetUnpackBlockCount ( )
Returns
The count of data blocks being received for this Activation instance.
void MLSL::Activation::StartComm ( void *  buf)

Starts the non-blocking activation/gradient exchange with respect to activation.

Parameters
bufthe buffer containing the packed activation
void* MLSL::Activation::WaitComm ( )

Waits for completion of the activation/gradient exchange with respect to activation.

Returns
A pointer to the buffer containing the activation to be unpacked.

The documentation for this class was generated from the following file: