---
name: "mpi_kmeans"
section: "1"
platform: "linux"
package: "mpikmeans-tools"
version: "1.5+dfsg-7"
release: "Debian 10 (Buster)"
platforms: ["linux"]
url: "https://new.carta.tech/mpi_kmeans"
---

# mpi\_kmeans(1)

K-Means clustering tool

## NAME

mpi\_kmeans - K-Means clustering tool

## SYNOPSIS

**mpi\_kmeans** \[*options*\]

## DESCRIPTION

**mpi\_kmeans** is a program that uses k-means clustering to produce a list of cluster centers. The resulting data can be used by [**mpi\_assign**(1)](/mpi_assign/1.md) to assign points to those cluster centers.

## OPTIONS

A summary of options is included below.

### Generic Options:

- **--help**

  Produce help message

### Input/Output Options:

- **--data** *file*

  Training file, one datum per line (default: "data.txt")

- **--output** *file*

  Output file, one cluster center per line (default: "output.txt")

### K-Means Options:

- **--k** *num*

  Number of clusters to generate (default: 100)

- **--restarts** *num*

  Number of k-means restarts (default: 0 = single run)

- **--maxiter** *num*

  Maximum number of k-means iterations (default: 0 = infinity)

## EXAMPLES

-

  mpi\_kmeans --k 2 --data example.txt --output clusters.txt

## SEE ALSO

[**mpi\_assign**(1)](/mpi_assign/1.md)

## AUTHOR

**mpi\_kmeans** was written by Peter Gehler \<peter.gehler@tuebingen.mpg.de\>.

This manual page was written by Christian Kastner \<ckk@debian.org\> for the Debian project (and may be used by others).