ml.shifu.guagua.master

Class MasterContext<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>

java.lang.Object

ml.shifu.guagua.master.MasterContext<MASTER_RESULT,WORKER_RESULT>

Type Parameters:

MASTER_RESULT - master result for computation in each iteration.

WORKER_RESULT - worker result for computation in each iteration.

public class MasterContext<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable>
extends Object

MasterContext is a context object which contains all useful info used in master computation.

The info includes:

• Application ID: Job ID for Hadoop mapreduce Job, application ID for YARN application.
• Container ID: Task index for Hadoop mapreduce task, Task index for YARN Container.
• Total iteration number.
• Current iteration number.
• Worker result list for current iteration.
• Master result for current iteration which is used to be sent to workers in next iteration.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MasterContext.MasterCompletionCallBack<MASTER_RESULT extends Bytable,WORKER_RESULT extends Bytable> Define callback for completion of master computation.

Constructor Summary

Constructors

Constructor and Description
MasterContext(int totalIteration, int workers, Properties props, String appId, String containerId, String masterResultClassName, String workerResultClassName, double minWorkersRatio, long minWorkersTimeOut)

Method Summary

Modifier and Type	Method and Description
void	addCompletionCallBack(MasterContext.MasterCompletionCallBack<MASTER_RESULT,WORKER_RESULT> callback) Add callback function.
String	getAppId()
Object	getAttachment()
List<MasterContext.MasterCompletionCallBack<MASTER_RESULT,WORKER_RESULT>>	getCallBackList()
String	getContainerId()
int	getCurrentIteration()
MASTER_RESULT	getMasterResult()
String	getMasterResultClassName()
double	getMinWorkersRatio()
long	getMinWorkersTimeOut()
Properties	getProps()
int	getTotalIteration()
String	getWorkerResultClassName()
Iterable<WORKER_RESULT>	getWorkerResults()
int	getWorkers()
boolean	isFirstIteration() Whether is in first iteration, default first iteration is 1.
boolean	isInitIteration() Whether is in initiate iteration, default initiate iteration is 1.
void	setAttachment(Object attachment)
void	setCurrentIteration(int currentIteration)
void	setMasterResult(MASTER_RESULT masterResult)
void	setWorkerResults(Iterable<WORKER_RESULT> workerResults)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

MasterContext

public MasterContext(int totalIteration,
                     int workers,
                     Properties props,
                     String appId,
                     String containerId,
                     String masterResultClassName,
                     String workerResultClassName,
                     double minWorkersRatio,
                     long minWorkersTimeOut)

Method Detail

getContainerId

public String getContainerId()

getWorkerResults

public Iterable<WORKER_RESULT> getWorkerResults()

setWorkerResults

public void setWorkerResults(Iterable<WORKER_RESULT> workerResults)

getTotalIteration

public int getTotalIteration()

getCurrentIteration

public int getCurrentIteration()

setCurrentIteration

public void setCurrentIteration(int currentIteration)

getWorkers

public int getWorkers()

getProps

public Properties getProps()

getAppId

public String getAppId()

getMasterResult

public MASTER_RESULT getMasterResult()

setMasterResult

public void setMasterResult(MASTER_RESULT masterResult)

getMasterResultClassName

public String getMasterResultClassName()

getWorkerResultClassName

public String getWorkerResultClassName()

getMinWorkersRatio

public double getMinWorkersRatio()

getMinWorkersTimeOut

public long getMinWorkersTimeOut()

getAttachment

public Object getAttachment()

setAttachment

public void setAttachment(Object attachment)

isFirstIteration

public boolean isFirstIteration()

Whether is in first iteration, default first iteration is 1.

isInitIteration

public boolean isInitIteration()

Whether is in initiate iteration, default initiate iteration is 1.

addCompletionCallBack

public void addCompletionCallBack(MasterContext.MasterCompletionCallBack<MASTER_RESULT,WORKER_RESULT> callback)

Add callback function. Be careful not add it in each iteration.

getCallBackList

public List<MasterContext.MasterCompletionCallBack<MASTER_RESULT,WORKER_RESULT>> getCallBackList()

Returns:

the callBackList

toString

public String toString()

Overrides:

toString in class Object