1mlpack_preprocess_describe(1)General Commands Manuamllpack_preprocess_describe(1)
2
3
4

NAME

6       mlpack_preprocess_describe - descriptive statistics
7

SYNOPSIS

9        mlpack_preprocess_describe [-h] [-v]
10

DESCRIPTION

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). A user can also select a
21       specific dimension to analyize  if  he  or  she  has  too  many  dimen‐
22       sions.--population (-P) is a flag which can be used when the user wants
23       the dataset to 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       dataset.csv, and keep the default settings, we could run
28
29       $ mlpack_preprocess_describe -i dataset.csv -v
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       $ mlpack_preprocess_describe -i dataset.csv -w 10 -p 5 -P -v
35

REQUIRED INPUT OPTIONS

37       --input_file (-i) [string]
38              File containing data,
39

OPTIONAL INPUT OPTIONS

41       --dimension (-d) [int]
42              Dimension  of  the data. Use this to specify a dimension Default
43              value 0.
44
45       --help (-h)
46              Default help info.
47
48       --info [string]
49              Get help on a specific module or option.  Default value ''.
50
51       --population (-P)
52              If specified, the program will calculate statistics assuming the
53              dataset  is  the population. By default, the program will assume
54              the dataset as a sample.
55
56       --precision (-p) [int]
57              Precision of the output statistics. Default value 4.
58
59       --row_major (-r)
60              If specified, the program will calculate statistics across rows,
61              not  across  columns.  (Remember that in mlpack, a column repre‐
62              sents a point, so this option is generally not necessary.)
63
64       --verbose (-v)
65              Display informational messages and the full list  of  parameters
66              and timers at the end of execution.
67
68       --version (-V)
69              Display the version of mlpack.
70
71       --width (-w) [int]
72              Width of the output table. Default value 8.
73

ADDITIONAL INFORMATION

ADDITIONAL INFORMATION

76       For further information, including relevant papers, citations, and the‐
77       ory, For further information, including relevant papers, citations, and
78       theory,  consult  the  documentation  found at http://www.mlpack.org or
79       included   with   your   consult    the    documentation    found    at
80       http://www.mlpack.org  or  included  with  your DISTRIBUTION OF MLPACK.
81       DISTRIBUTION OF MLPACK.
82
83
84
85                                                 mlpack_preprocess_describe(1)
Impressum