org.petuum.jbosen

Class PsConfig

java.lang.Object

org.petuum.jbosen.PsConfig

public class PsConfig
extends java.lang.Object

This class specifies the configuration options for the global Bosen PS instance. Internally, it uses org.kohsuke.args4j to parse command line arguments. To add additional arguments used by the application, it is possible to extend this class and annotate additional fields with Option, and then using parse(String[]) to parse an array of command-line arguments.

Field Summary

Fields

Modifier and Type	Field and Description
int	clientId ID of this client, from 0 to numClients - 1.
java.lang.String	hostFile Path to the host file.
int	numLocalCommChannels Number of network threads run on every client.
int	numLocalWorkerThreads Number of application worker threads run on every client.

Constructor Summary

Constructors

Constructor and Description
PsConfig()

Method Summary

Modifier and Type	Method and Description
void	parse(java.lang.String[] args) Parse an array of command-line arguments and sets the fields of this object accordingly.

Methods inherited from class java.lang.Object

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

Field Detail

clientId

public int clientId

ID of this client, from 0 to numClients - 1.

hostFile

public java.lang.String hostFile

Path to the host file.

numLocalWorkerThreads

public int numLocalWorkerThreads

Number of application worker threads run on every client. Default = 1.

numLocalCommChannels

public int numLocalCommChannels

Number of network threads run on every client. The recommended value is one network thread per 4 to 8 worker threads. Default = 1.

Constructor Detail

PsConfig

public PsConfig()

Method Detail

parse

public void parse(java.lang.String[] args)

Parse an array of command-line arguments and sets the fields of this object accordingly. The array must not contain any unrecognized arguments. New arguments can be added by extending this class and using Option to annotate additional fields.

Parameters:

args - array of command-line arguments.