bbob_pproc
 

Black-Box Optimization Benchmarking (BBOB) post processing tool:
 
The BBOB post-processing tool takes as input data from BBOB experiments and
generates output that will be used in the generation of the LateX-formatted
article summarizing the experiments.

 
Package Contents
       
bootstrap
dataoutput
determineFtarget
determineFtarget2
determineFtarget3
findindexfiles
minirun
minirun_2
ppfig
ppfigdim
ppperfprof
ppperfprof_2
pprldistr
pproc
pprocold
pptables
pptex
readalign
readindexfiles
run
runmarc

 
Functions
       
main(argv=None)
Generates from BBOB experiment data some outputs for a tex document.
 
If provided with some index entries (from info files), this should return
many output files in the folder 'ppdata' needed for the compilation of
latex document templateBBOBarticle.tex. These output files will contain
performance tables, performance scaling figures and empirical cumulative
distribution figures. On subsequent executions, new files will be added 
to the output directory, overwriting existing older files in the process.
 
Keyword arguments:
argv -- list of strings containing options and arguments. If not given,
sys.argv is accessed.
 
argv should list either names of info files or folders containing info
files. argv can also contain post-processed pickle files generated by this
routine. Furthermore, argv can begin with, in any order, facultative option
flags listed below.
 
    -h, --help
 
        display this message
 
    -v, --verbose
 
        verbose mode, prints out operations. When not in verbose mode, no
        output is to be expected, except for errors.
 
    -p, --pickle
 
        generates pickle post processed data files.
 
    -o, --output-dir OUTPUTDIR
 
        change the default output directory ('ppdata') to OUTPUTDIR
 
    -f, --final
 
        lengthens the bootstrapping process used as dispersion measure in
        the tables generation. This might at least double the time of the
        whole post-processing. Please use this option when generating your
        final paper.
 
    --tab-only, --fig-only, --rld-only
 
        these options can be used to output respectively the tex tables,
        convergence and ENFEs graphs figures, run length distribution
        figures only. A combination of any two of these options results in
        no output.
 
Exceptions raised:
Usage -- Gives back a usage message.
 
Examples:
 
* Calling the run.py interface from the command line:
 
    $ python bbob_pproc/run.py -v experiment1
 
will post-process the folder experiment1 and all its containing data,
base on the found .info files in the folder. The result will appear
in folder ppdata. The -v option adds verbosity.
 
    $ python bbob_pproc/run.py -o otherppdata experiment2/*.info
 
This will execute the post-processing on the info files found in
experiment2. The result will be located in the alternative location
otherppdata.
 
* Loading this package and calling the main from the command line
  (requires that the path to this package is in python search path):
 
    $ python -m bbob_pproc -h
 
This will print out this help message.
 
* From the python interactive shell (requires that the path to this
  package is in python search path):
 
    >>> import bbob_pproc
    >>> bbob_pproc.main('-o outputfolder folder1'.split())
 
This will execute the post-processing on the index files found in folder1.
The -o option changes the output folder from the default ppdata to
outputfolder.

 
Data
        __all__ = ['readalign', 'findindexfiles', 'pptex', 'pprldistr', 'main', 'ppfigdim', 'pproc', 'dataoutput']