Skip to content

normi

Estimating NMI matrix of coordinates.

Usage:

normi [OPTIONS]

Options:

  -i, --input PATH                Path to input file. Needs to be of shape
                                  (n_samples, n_features). All command lines
                                  need to start with "#". By default
                                  np.float16 is used for the datatype.
                                  [required]
  -o, --output PATH               Path to output basename. Will be a matrix of
                                  shape (n_features, n_features).  [required]
  --norm [min|max|joint|arithmetic|geometric]
                                  Normalization method of the mutual
                                  information.  [default: geometric]
  --inv-measure [volume|volume_stable|radius|kraskov]
                                  Invariant measure to rescale the entropies.
                                  [default: volume]
  --n-dims INTEGER RANGE          Dimension of each feature. Assumes the first
                                  nth colums belong to the first feature.
                                  [default: 1; x>=1]
  --precision [half|single|double]
                                  Precision used for calculation. Lower
                                  precision reduces memory impact but may lead
                                  to overflow errors.  [default: single]
  -v, --verbose                   Activate verbose mode.
  --help                          Show this message and exit.