Skip to content

Commit 32f6349

Browse files
fracpetefracpete
committed
added help screens
1 parent 12995c4 commit 32f6349

File tree

1 file changed

+316
-0
lines changed

1 file changed

+316
-0
lines changed

‎doc/source/commandline.rst‎

Lines changed: 316 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,27 @@ Artifical data can be generated using one of Weka's data generators, e.g., the
2727
weka.datagenerators.classifiers.classification.Agrawal
2828
2929
30+
Command-line help screen:
31+
32+
::
33+
34+
usage: pww-datagenerator [-h] [-j classpath] [-X heap] datagenerator ...
35+
36+
Executes a data generator from the command-line. Calls JVM start/stop
37+
automatically.
38+
39+
positional arguments:
40+
datagenerator data generator classname, e.g.,
41+
weka.datagenerators.classifiers.classification.LED24
42+
option additional data generator options
43+
44+
optional arguments:
45+
-h, --help show this help message and exit
46+
-j classpath additional classpath, jars/directories
47+
-X heap max heap size for jvm, e.g., 512m
48+
49+
50+
3051
Filters
3152
-------
3253

@@ -45,6 +66,32 @@ For batch filtering, you can use the `-r` and `-s` options for the input and out
4566
for the second file.
4667

4768

69+
Command-line help screen:
70+
71+
::
72+
73+
usage: pww-filter [-h] [-j classpath] [-X heap] -i input1 -o output1
74+
[-r input2] [-s output2] [-c classindex]
75+
filter ...
76+
77+
Executes a filter from the command-line. Calls JVM start/stop automatically.
78+
79+
positional arguments:
80+
filter filter classname, e.g., weka.filters.AllFilter
81+
option additional filter options
82+
83+
optional arguments:
84+
-h, --help show this help message and exit
85+
-j classpath additional classpath, jars/directories
86+
-X heap max heap size for jvm, e.g., 512m
87+
-i input1 input file 1
88+
-o output1 output file 1
89+
-r input2 input file 2
90+
-s output2 output file 2
91+
-c classindex 1-based class attribute index
92+
93+
94+
4895
Classifiers
4996
-----------
5097

@@ -60,6 +107,42 @@ on the iris UCI dataset:
60107
-C 0.3
61108
62109
110+
Command-line help screen:
111+
112+
::
113+
114+
usage: pww-classifier [-h] [-j classpath] [-X heap] -t train [-T test]
115+
[-c class index] [-d outmodel] [-l inmodel]
116+
[-x num folds] [-s seed] [-v] [-o] [-i] [-k]
117+
[-m costmatrix] [-g graph]
118+
classifier ...
119+
120+
Performs classification/regression from the command-line. Calls JVM start/stop
121+
automatically.
122+
123+
positional arguments:
124+
classifier classifier classname, e.g., weka.classifiers.trees.J48
125+
option additional classifier options
126+
127+
optional arguments:
128+
-h, --help show this help message and exit
129+
-j classpath additional classpath, jars/directories
130+
-X heap max heap size for jvm, e.g., 512m
131+
-t train Training set file
132+
-T test Test set file
133+
-c class index 1-based class attribute index
134+
-d outmodel model output file name
135+
-l inmodel model input file name
136+
-x num folds number of folds for cross-validation
137+
-s seed seed value for randomization
138+
-v no statistics for training
139+
-o only statistics, don't output model
140+
-i output information retrieval statistics
141+
-k output information theoretic statistics
142+
-m costmatrix cost matrix file
143+
-g graph output file for graph (if supported)
144+
145+
63146
Clusterers
64147
----------
65148

@@ -75,6 +158,36 @@ Example on how to perform classes-to-clusters evaluation for `SimpleKMeans`
75158
-N 3
76159
77160
161+
Command-line help screen:
162+
163+
::
164+
165+
usage: pww-clusterer [-h] [-j classpath] [-X heap] -t train [-T test]
166+
[-d outmodel] [-l inmodel] [-p attributes] [-x num folds]
167+
[-s seed] [-c class index] [-g graph]
168+
clusterer ...
169+
170+
Performs clustering from the command-line. Calls JVM start/stop automatically.
171+
172+
positional arguments:
173+
clusterer clusterer classname, e.g., weka.clusterers.SimpleKMeans
174+
option additional clusterer options
175+
176+
optional arguments:
177+
-h, --help show this help message and exit
178+
-j classpath additional classpath, jars/directories
179+
-X heap max heap size for jvm, e.g., 512m
180+
-t train training set file
181+
-T test test set file
182+
-d outmodel model output file name
183+
-l inmodel model input file name
184+
-p attributes attribute range
185+
-x num folds number of folds
186+
-s seed seed value for randomization
187+
-c class index 1-based class attribute index
188+
-g graph graph output file (if supported)
189+
190+
78191
Attribute selection
79192
-------------------
80193

@@ -93,6 +206,33 @@ You can perform attribute selection using `BestFirst` as search algorithm and
93206
-E 1
94207
95208
209+
Command-line help screen:
210+
211+
::
212+
213+
usage: pww-attsel [-h] [-j classpath] [-X heap] -i input [-c class index]
214+
[-s search] [-x num folds] [-n seed]
215+
evaluator ...
216+
217+
Performs attribute selection from the command-line. Calls JVM start/stop
218+
automatically.
219+
220+
positional arguments:
221+
evaluator evaluator classname, e.g.,
222+
weka.attributeSelection.CfsSubsetEval
223+
option additional evaluator options
224+
225+
optional arguments:
226+
-h, --help show this help message and exit
227+
-j classpath additional classpath, jars/directories
228+
-X heap max heap size for jvm, e.g., 512m
229+
-i input input file
230+
-c class index 1-based class attribute index
231+
-s search search method, classname and options
232+
-x num folds number of folds
233+
-n seed the seed value for randomization
234+
235+
96236
Associators
97237
-----------
98238

@@ -104,3 +244,179 @@ Associators, like `Apriori`, can be run like this:
104244
-t /my/datasets/iris.arff \
105245
weka.associations.Apriori \
106246
-N 9 -I
247+
248+
249+
Command-line help screen:
250+
251+
::
252+
253+
usage: pww-associator [-h] [-j classpath] [-X heap] -t train associator ...
254+
255+
Executes an associator from the command-line. Calls JVM start/stop
256+
automatically.
257+
258+
positional arguments:
259+
associator associator classname, e.g., weka.associations.Apriori
260+
option additional associator options
261+
262+
optional arguments:
263+
-h, --help show this help message and exit
264+
-j classpath additional classpath, jars/directories
265+
-X heap max heap size for jvm, e.g., 512m
266+
-t train training set file
267+
268+
269+
Package management
270+
------------------
271+
272+
Versions newer than 0.2.9 also offer package management from the command-line via the `pww-packages`
273+
command. There are several sub-commands available:
274+
275+
::
276+
277+
usage: pww-packages [-h]
278+
{list,info,install,uninstall,remove,suggest,is-installed}
279+
...
280+
281+
Manages Weka packages.
282+
283+
positional arguments:
284+
{list,info,install,uninstall,remove,suggest,is-installed}
285+
list For listing all/installed/available packages
286+
info Outputs information about packages
287+
install For installing one or more packages
288+
uninstall (remove) For uninstalling one or more packages
289+
suggest For suggesting packages that contain the specified
290+
class
291+
is-installed Checks whether a package is installed, simply outputs
292+
true/false
293+
294+
optional arguments:
295+
-h, --help show this help message and exit
296+
297+
298+
Listing packages
299+
++++++++++++++++
300+
301+
Listing all, available or installed packages can be done using the `list` sub-command:
302+
303+
::
304+
305+
usage: pww-packages list [-h] [-f {text,json}] [-o FILE] [-r]
306+
[{all,installed,available}]
307+
308+
positional arguments:
309+
{all,installed,available}
310+
defines what packages to list
311+
312+
optional arguments:
313+
-h, --help show this help message and exit
314+
-f {text,json}, --format {text,json}
315+
the output format to use
316+
-o FILE, --output FILE
317+
the file to store the output in, uses stdout if not
318+
supplied
319+
-r, --refresh-cache whether to refresh the package cache
320+
321+
322+
Info on packages
323+
++++++++++++++++
324+
325+
Outputting information on one or more packages is achieved with the `list` sub-command:
326+
327+
::
328+
329+
usage: pww-packages info [-h] [-t {brief,full}] [-f {text,json}] [-o FILE]
330+
[-r]
331+
name [name ...]
332+
333+
positional arguments:
334+
name the package(s) to output the information for
335+
336+
optional arguments:
337+
-h, --help show this help message and exit
338+
-t {brief,full}, --type {brief,full}
339+
the type of information to output
340+
-f {text,json}, --format {text,json}
341+
the output format to use
342+
-o FILE, --output FILE
343+
the file to store the output in, uses stdout if not
344+
supplied
345+
-r, --refresh-cache whether to refresh the package cache
346+
347+
348+
349+
Installing/uninstalling/check installed status
350+
++++++++++++++++++++++++++++++++++++++++++++++
351+
352+
The `install` sub-command installs one or more packages:
353+
354+
::
355+
356+
usage: pww-packages install [-h] packages [packages ...]
357+
358+
positional arguments:
359+
packages the name of the package(s) to install, append '==VERSION' to pin
360+
to a specific version
361+
362+
optional arguments:
363+
-h, --help show this help message and exit
364+
365+
366+
The `uninstall` (or `remove`) sub-command removes one or more packages:
367+
368+
::
369+
370+
usage: pww-packages uninstall [-h] packages [packages ...]
371+
372+
positional arguments:
373+
packages the name of the package(s) to uninstall
374+
375+
optional arguments:
376+
-h, --help show this help message and exit
377+
378+
379+
The `is-installed` sub-command outputs whether a package is installed or not:
380+
381+
::
382+
383+
usage: pww-packages is-installed [-h] [-f {text,json}] [-o FILE]
384+
name [name ...]
385+
386+
positional arguments:
387+
name the name of the package to check, append '==VERSION'
388+
to pin to a specific version
389+
390+
optional arguments:
391+
-h, --help show this help message and exit
392+
-f {text,json}, --format {text,json}
393+
the output format to use
394+
-o FILE, --output FILE
395+
the file to store the output in, uses stdout if not
396+
supplied
397+
398+
399+
400+
Suggest packages
401+
++++++++++++++++
402+
403+
If you are not sure which package a certain class is part of, then use the `suggest`
404+
sub-command to help with that (this works only for official packages):
405+
406+
::
407+
408+
usage: pww-packages suggest [-h] [-e] [-f {text,json}] [-o FILE] classname
409+
410+
positional arguments:
411+
classname the classname to suggest packages for
412+
413+
optional arguments:
414+
-h, --help show this help message and exit
415+
-e, --exact whether to match the name exactly or perform substring
416+
matching
417+
-f {text,json}, --format {text,json}
418+
the output format to use
419+
-o FILE, --output FILE
420+
the file to store the output in, uses stdout if not
421+
supplied
422+

0 commit comments

Comments
 (0)