org.petuum.jbosen

Class PsApplication

java.lang.Object

org.petuum.jbosen.PsApplication

public abstract class PsApplication
extends java.lang.Object

This class abstracts away some of the boilerplate code common to application initialization and execution. In particular, this class takes care of PsTableGroup initialization and shutdown, as well as worker thread spawning, registering, and de-registering. An application using this class should extend from it and implement initialize() and runWorkerThread(int). The application can then be started by calling run(PsConfig).

Constructor Summary

Constructors

Constructor and Description
PsApplication()

Method Summary

Modifier and Type	Method and Description
abstract void	initialize() This method is called after PsTableGroup is initialized and before any worker threads are spawned.
void	run(PsConfig config) This method runs the application.
abstract void	runWorkerThread(int threadId) This method executes the code for a single worker thread.

Methods inherited from class java.lang.Object

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

Constructor Detail

PsApplication

public PsApplication()

Method Detail

initialize

public abstract void initialize()

This method is called after PsTableGroup is initialized and before any worker threads are spawned. Initialization tasks such as table creation and data loading should be done here. Initializing PsTableGroup is not required.

runWorkerThread

public abstract void runWorkerThread(int threadId)

This method executes the code for a single worker thread. The appropriate number of threads are spawned and run this method. Worker thread register and de-register are not required.

Parameters:

threadId - the local thread ID to run.

run

public void run(PsConfig config)

This method runs the application. It first initializes PsTableGroup, then calls initialize(), and finally spawns numLocalWorkerThreads threads, each of which runs a single instance of runWorkerThread(int). This method returns after all worker threads have completed and PsTableGroup has been shut down.

Parameters:

config - the config object.