1mlpack_preprocess_describe(1) User Commands mlpack_preprocess_describe(1)
2
3
4
6 mlpack_preprocess_describe - descriptive statistics
7
9 mlpack_preprocess_describe -i string [-d int] [-P bool] [-p int] [-r bool] [-V bool] [-w int] [-h -v]
10
12 This utility takes a dataset and prints out the descriptive statistics
13 of the data. Descriptive statistics is the discipline of quantitatively
14 describing the main features of a collection of information, or the
15 quantitative description itself. The program does not modify the origi‐
16 nal file, but instead prints out the statistics to the console. The
17 printed result will look like a table.
18
19 Optionally, width and precision of the output can be adjusted by a user
20 using the '--width (-w)' and '--precision (-p)' parameters. A user can
21 also select a specific dimension to analyze if there are too many
22 dimensions. The ’--population (-P)' parameter can be specified when the
23 dataset should be considered as a population. Otherwise, the dataset
24 will be considered as a sample.
25
26 So, a simple example where we want to print out statistical facts about
27 the dataset 'X.csv' using the default settings, we could run
28
29 $ preprocess_describe --input_file X.csv --verbose
30
31 If we want to customize the width to 10 and precision to 5 and consider
32 the dataset as a population, we could run
33
34 $ preprocess_describe --input_file X.csv --width 10 --precision 5
35 --verbose
36
38 --input_file (-i) [string]
39 Matrix containing data,
40
42 --dimension (-d) [int]
43 Dimension of the data. Use this to specify a dimension Default
44 value 0.
45
46 --help (-h) [bool]
47 Default help info.
48
49 --info [string]
50 Get help on a specific module or option. Default value ''.
51
52 --population (-P) [bool]
53 If specified, the program will calculate statistics assuming the
54 dataset is the population. By default, the program will assume
55 the dataset as a sample.
56
57 --precision (-p) [int]
58 Precision of the output statistics. Default value 4.
59
60 --row_major (-r) [bool]
61 If specified, the program will calculate statistics across rows,
62 not across columns. (Remember that in mlpack, a column repre‐
63 sents a point, so this option is generally not necessary.)
64
65 --verbose (-v) [bool]
66 Display informational messages and the full list of parameters
67 and timers at the end of execution.
68
69 --version (-V) [bool]
70 Display the version of mlpack.
71
72 --width (-w) [int]
73 Width of the output table. Default value 8.
74
76 For further information, including relevant papers, citations, and the‐
77 ory, consult the documentation found at http://www.mlpack.org or
78 included with your distribution of mlpack.
79
80
81
82mlpack-3.0.4 21 February 2019 mlpack_preprocess_describe(1)