Skip to content

Commit

Permalink
fixed documentation bug (#33)
Browse files Browse the repository at this point in the history
  • Loading branch information
synzhu authored and larskotthoff committed Jan 15, 2017
1 parent b362aaa commit edfb098
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 7 deletions.
9 changes: 9 additions & 0 deletions .gitignore
@@ -0,0 +1,9 @@
autoweka.jar
autoweka.zip
build/
doc/javadoc/
doc/manual/manual.aux
doc/manual/manual.log
doc/manual/manual.out
doc/manual/manual.pdf
doc/manual/manual.toc
12 changes: 6 additions & 6 deletions doc/manual/manual.tex
Expand Up @@ -69,7 +69,7 @@ \section{User Documentation}\label{sec:overview}
A full list of all classifiers and attribute selectors considered along with
their hyperparameters can be found in the appendix.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Using the GUI}\label{sec:gui}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Expand Down Expand Up @@ -140,7 +140,7 @@ \subsection{Using the GUI}\label{sec:gui}
Note that the time limit is \emph{approximate} and Auto-WEKA may not take
\emph{exactly} as long as requested.

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\subsection{Running Experiments Using the Command Line Interface (CLI)}\label{sec:running}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

Expand Down Expand Up @@ -214,8 +214,8 @@ \subsection{Running Experiments Using the Command Line Interface (CLI)}\label{se
E.g.: weka.classifiers.evaluation.output.prediction.PlainText
-p range
Outputs predictions for test instances (or the train instances if
no test instances provided and -no-cv is used), along with the
attributes in the specified range (and nothing else).
no test instances provided and -no-cv is used), along with the
attributes in the specified range (and nothing else).
Use '-p 0' if no attributes are desired.
Deprecated: use "-classifications ..." instead.
-distribution
Expand All @@ -228,7 +228,7 @@ \subsection{Running Experiments Using the Command Line Interface (CLI)}\label{se
Retrieves the options from the XML-data instead of the command line.
-threshold-file <file>
The file to save the threshold data to.
The format is determined by the extensions, e.g., '.arff' for ARFF
The format is determined by the extensions, e.g., '.arff' for ARFF
format or '.csv' for CSV.
-threshold-label <label>
The class label to determine the threshold data for
Expand All @@ -249,7 +249,7 @@ \subsection{Running Experiments Using the Command Line Interface (CLI)}\label{se
(default: 1024)
-nBestConfigs <limit>
The amount of best configurations to output.
(default: 1024)
(default: 1)
-metric <metric>
The metric to optimise.
(default: errorRate)
Expand Down
2 changes: 1 addition & 1 deletion src/java/weka/classifiers/meta/AutoWEKAClassifier.java
Expand Up @@ -558,7 +558,7 @@ public Enumeration<Option> listOptions() {
new Option("\tThe memory limit for runs in MiB.\n" + "\t(default: " + DEFAULT_MEM_LIMIT + ")",
"memLimit", 1, "-memLimit <limit>"));
result.addElement(
new Option("\tThe amount of best configurations to output.\n" + "\t(default: " + DEFAULT_MEM_LIMIT + ")",
new Option("\tThe amount of best configurations to output.\n" + "\t(default: " + DEFAULT_N_BEST + ")",
"nBestConfigs", 1, "-nBestConfigs <limit>"));
result.addElement(
new Option("\tThe metric to optimise.\n" + "\t(default: " + DEFAULT_METRIC + ")",
Expand Down

0 comments on commit edfb098

Please sign in to comment.