[mlpack-svn] r15798 - mlpack/conf/jenkins-conf/benchmark
fastlab-svn at coffeetalk-1.cc.gatech.edu
fastlab-svn at coffeetalk-1.cc.gatech.edu
Tue Sep 17 15:02:15 EDT 2013
Author: marcus
Date: Tue Sep 17 15:02:14 2013
New Revision: 15798
Log:
Enhanced help section.
Modified:
mlpack/conf/jenkins-conf/benchmark/Makefile
Modified: mlpack/conf/jenkins-conf/benchmark/Makefile
==============================================================================
--- mlpack/conf/jenkins-conf/benchmark/Makefile (original)
+++ mlpack/conf/jenkins-conf/benchmark/Makefile Tue Sep 17 15:02:14 2013
@@ -55,18 +55,41 @@
scripts: .scripts
.help:
- @echo "Usage: make [option] [CONFIG=..]"
- @echo "options:"
- @echo " help Show this info."
- @echo " test [CONFIG] Test the configuration file. Check for correct"
- @echo " syntax and then try to open files referred in the"
- @echo " configuration. Default ''."
- @echo " run [CONFIG] Perform the benchmark with the given config."
- @echo " Default '$(CONFIG)'."
- @echo " memory [CONFIG] Get memory profiling information with the given "
- @echo " config. Default '$(CONFIG)'."
- @echo " scripts Compile the java files for the weka methods."
- @echo " reports [CONFIG] Create the reports. Default '$(CONFIG)'."
+ @echo "Benchmark-Script"
+ @echo ""
+ @echo " This script will test various methods with different data sets."
+ @echo ""
+ @echo " For example, the following will run all scripts and methods defined"
+ @echo " in the config.yaml file and the results are shown on the console:"
+ @echo ""
+ @echo " $$ make run CONFIG=config LOG=False"
+ @echo ""
+ @echo " Usage: make [option] [parameters]"
+ @echo ""
+ @echo "Parameters:"
+ @echo " CONFIG [string] The path to the configuration file to perform the benchmark on."
+ @echo " Default '$(CONFIG)'."
+ @echo " BLOCK [string] Run only the specified blocks defined in the configuration file."
+ @echo " Default run all blocks."
+ @echo " LOG [boolean] If set, the reports will be saved in the database."
+ @echo " Default '$(LOG)'."
+ @echo " UPDATE [boolean] If set, the latest reports in the database are updated."
+ @echo " Default '$(UPDATE)'."
+ @echo " METHODBLOCK [string] Run only the specified methods defined in the configuration file."
+ @echo " Default run all methods."
+ @echo ""
+ @echo "Options:"
+ @echo " test [parameters] Test the configuration file. Check for correct"
+ @echo " syntax and then try to open files referred in the"
+ @echo " configuration file."
+ @echo " run [parameters] Perform the benchmark with the given config."
+ @echo " memory [parameters] Get memory profiling information with the given config"
+ @echo " scripts Compile the java files for the weka methods."
+ @echo " reports [parameters] Create the reports."
+ @echo " help Show this info."
+ @echo ""
+ @echo "For further information consult the documentation found at \
+ http://www.mlpack.org"
.check:
ifndef YAML_INSTALLED
More information about the mlpack-svn
mailing list