1mlpack_mean_shift(1)             User Commands            mlpack_mean_shift(1)
2
3
4

NAME

6       mlpack_mean_shift - mean shift clustering
7

SYNOPSIS

9        mlpack_mean_shift -i string [-f bool] [-P bool] [-l bool] [-m int] [-r double] [-V bool] [-C string] [-o string] [-h -v]
10

DESCRIPTION

12       This program performs mean shift clustering on the given dataset, stor‐
13       ing the learned cluster assignments either as a column of labels in the
14       input dataset or separately.
15
16       The  input  dataset  should  be  specified with the '--input_file (-i)'
17       parameter, and the radius used for search can  be  specified  with  the
18       '--radius  (-r)'  parameter.  The  maximum  number of iterations before
19       algorithm termination is controlled with  the  '--max_iterations  (-m)'
20       parameter.
21
22       The  output  labels  may  be saved with the '--output_file (-o)' output
23       parameter and the centroids of each  cluster  may  be  saved  with  the
24       '--centroid_file (-C)' output parameter.
25
26       For example, to run mean shift clustering on the dataset 'data.csv' and
27       store the centroids to 'centroids.csv', the following  command  may  be
28       used:
29
30       $ mean_shift --input_file data.csv --centroid_file centroids.csv
31

REQUIRED INPUT OPTIONS

33       --input_file (-i) [string]
34              Input dataset to perform clustering on.
35

OPTIONAL INPUT OPTIONS

37       --force_convergence (-f) [bool]
38              If  specified,  the  mean  shift algorithm will continue running
39              regardless of max_iterations until the clusters converge.
40
41       --help (-h) [bool]
42              Default help info.
43
44       --in_place (-P) [bool]
45              If specified, a column containing the  learned  cluster  assign‐
46              ments  will  be  added  to the input dataset file. In this case,
47              --output_file is overridden. (Do not use with Python.)
48
49       --info [string]
50              Get help on a specific module or option.  Default value ''.
51
52       --labels_only (-l) [bool]
53              If specified, only the output labels will be written to the file
54              specified by --output_file.
55
56       --max_iterations (-m) [int]
57              Maximum  number  of  iterations  before  mean  shift terminates.
58              Default value 1000.
59
60       --radius (-r) [double]
61              If the distance between two centroids is  less  than  the  given
62              radius,  one  will  be  removed.  A radius of 0 or less means an
63              estimate will be calculated and used  for  the  radius.  Default
64              value 0.
65
66       --verbose (-v) [bool]
67              Display  informational  messages and the full list of parameters
68              and timers at the end of execution.
69
70       --version (-V) [bool]
71              Display the version of mlpack.
72

OPTIONAL OUTPUT OPTIONS

74       --centroid_file (-C) [string]
75              If specified, the centroids of each cluster will be  written  to
76              the given matrix. Default value ''.
77
78       --output_file (-o) [string]
79              Matrix  to write output labels or labeled data to. Default value
80              ''.
81

ADDITIONAL INFORMATION

83       For further information, including relevant papers, citations, and the‐
84       ory,  consult  the  documentation  found  at  http://www.mlpack.org  or
85       included with your distribution of mlpack.
86
87
88
89mlpack-3.0.4                   21 February 2019           mlpack_mean_shift(1)