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::Session Class Reference

A class to represent a collection of Operation objects with the same global mini-batch size. More...

#include <mlsl.hpp>

Public Member Functions

void SetGlobalMinibatchSize (size_t globalMinibatchSize)
 
size_t GetGlobalMinibatchSize ()
 
PhaseType GetPhaseType ()
 
OperationRegInfoCreateOperationRegInfo (OpType opType)
 
void DeleteOperationRegInfo (OperationRegInfo *info)
 
size_t AddOperation (OperationRegInfo *info, Distribution *dist=NULL)
 
void RemoveOperations ()
 
size_t GetOperationCount ()
 
OperationGetOperation (size_t idx)
 
void Commit ()
 
StatisticsGetStats ()
 

Detailed Description

A class to represent a collection of Operation objects with the same global mini-batch size.

Member Function Documentation

size_t MLSL::Session::AddOperation ( OperationRegInfo info,
Distribution dist = NULL 
)

Creates and adds an Operation object to the current session.

Parameters
infothe operation's registration object that holds information about activations and/or parameter sets
distthe distribution that will be used by the new operation (optional), can be set later with the Operation::SetDistribution() method
void MLSL::Session::Commit ( )

Finalizes creation of the collection of Operations. Must be called after all operations are added to the session. Session-wide optimizations take place there.

OperationRegInfo* MLSL::Session::CreateOperationRegInfo ( OpType  opType)

Creates an object containing the operation's registration information.

Parameters
opTypethe compute operation type
Returns
The operation's registration object.
void MLSL::Session::DeleteOperationRegInfo ( OperationRegInfo info)

Deletes the previously created OperationRegInfo object.

Parameters
infothe operation's registration object to delete
size_t MLSL::Session::GetGlobalMinibatchSize ( )
Returns
The global mini-batch size.
Operation* MLSL::Session::GetOperation ( size_t  idx)

Returns the operation by index.

Parameters
idxthe operation's index
Returns
The operation.
size_t MLSL::Session::GetOperationCount ( )
Returns
The number of operations for the current session.
PhaseType MLSL::Session::GetPhaseType ( )
Returns
The phase type.
Statistics* MLSL::Session::GetStats ( )

Returns the statistics information for the session

Returns
A Statistics class instance.
void MLSL::Session::RemoveOperations ( )

Removes all operations from the current session.

void MLSL::Session::SetGlobalMinibatchSize ( size_t  globalMinibatchSize)

Sets the global mini-batch size. Must be called before any compute operation creation.

Parameters
globalMinibatchSizethe global mini-batch size

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