SG++
python.controller.TerminalController.TerminalController Class Reference

The class provides the functionality for launching of learning jobs from terminal using console parameters or a configuration file. More...

Public Member Functions

def constructObjectsFromFile (cls, filename)
 Construct all objects from the information, defined in the job file. More...
 
def constructObjectsFromOptions (cls, options)
 Construct all objects form the information, defined with arguments. More...
 
def generateBuilderCodeFromOptions (cls, options)
 Generate LearnerBuilder code according to parameters You can execute the code with exec command and use builder object in your python code. More...
 
def itemsToDict (cls, items)
 Convert list of items [(key1,value1), ...] to dictionary. More...
 
def run (cls)
 Initial processing of input parameters. More...
 

Detailed Description

The class provides the functionality for launching of learning jobs from terminal using console parameters or a configuration file.

See file tests/tbin/tcontroller/testsettings.job for an example of configuration file. The command is then looks like:

1 python TerminalController.py --jobfile path/to/file.job

In the same time there is an option to use command line for definition of all parameters of the job. Execute

1 python TerminalController.py --help

for help to the console parameters.

Member Function Documentation

def python.controller.TerminalController.TerminalController.constructObjectsFromFile (   cls,
  filename 
)

Construct all objects from the information, defined in the job file.

Parameters
clspython keyword for class method (no specification needed)
filenamestring path to the file with job settings

References sgpp::combigrid.split().

def python.controller.TerminalController.TerminalController.constructObjectsFromOptions (   cls,
  options 
)

Construct all objects form the information, defined with arguments.

Parameters
clspython keyword for class method (no specification needed)
optionsOptionParser result object with options
def python.controller.TerminalController.TerminalController.generateBuilderCodeFromOptions (   cls,
  options 
)

Generate LearnerBuilder code according to parameters You can execute the code with exec command and use builder object in your python code.

Parameters
clspython keyword for class method (no specification needed)
optionsOptionParser result object with options
def python.controller.TerminalController.TerminalController.itemsToDict (   cls,
  items 
)

Convert list of items [(key1,value1), ...] to dictionary.

Parameters
clspython keyword for class method (no specification needed)
itemslist of items
Returns
: dictionary
def python.controller.TerminalController.TerminalController.run (   cls)

Initial processing of input parameters.

Referenced by python.uq.uq_setting.UQSetting.UQSetting.runSamples_withoutDistribution().


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