BanditPAM: Almost Linear-Time k-Medoids Clustering
This repo contains a high-performance implementation of BanditPAM from BanditPAM: Almost Linear-Time k-Medoids Clustering. The code can be called directly from Python or C++.
If you use this software, please cite:
Mo Tiwari, Martin Jinye Zhang, James Mayclin, Sebastian Thrun, Chris Piech, Ilan Shomorony. "BanditPAM: Almost Linear Time k-medoids Clustering via Multi-Armed Bandits" Advances in Neural Information Processing Systems (NeurIPS) 2020.
@inproceedings{BanditPAM,
title={BanditPAM: Almost Linear Time k-medoids Clustering via Multi-Armed Bandits},
author={Tiwari, Mo and Zhang, Martin J and Mayclin, James and Thrun, Sebastian and Piech, Chris and Shomorony, Ilan},
booktitle={Advances in Neural Information Processing Systems},
pages={368--374},
year={2020}
}
Requirements
TL;DR run pip3 install banditpam and jump to the examples.
If you have any issues, please see the documents below and file a Github issue if you have additional trouble.
Python Quickstart
Install the repo and its dependencies:
This can be done either through PyPI (recommended)
/BanditPAM/: pip install -r requirements.txt
/BanditPAM/: pip install banditpam
OR through the source code via
/BanditPAM/: git submodule update --init --recursive
/BanditPAM/: cd headers/carma
/BanditPAM/: mkdir build && cd build && cmake .. && make && sudo make install
/BanditPAM/: cd ../../..
/BanditPAM/: pip install -r requirements.txt
/BanditPAM/: sudo pip install .
Example 1: Synthetic data from a Gaussian Mixture Model
from banditpam import KMedoids
import numpy as np
import matplotlib.pyplot as plt
# Generate data from a Gaussian Mixture Model with the given means:
np.random.seed(0)
n_per_cluster = 40
means = np.array([[0,0], [-5,5], [5,5]])
X = np.vstack([np.random.randn(n_per_cluster, 2) + mu for mu in means])
# Fit the data with BanditPAM:
kmed = KMedoids(n_medoids = 3, algorithm = "BanditPAM")
# Writes results to gmm_log
kmed.fit(X, 'L2', "gmm_log")
# Visualize the data and the medoids:
for p_idx, point in enumerate(X):
if p_idx in map(int, kmed.medoids):
plt.scatter(X[p_idx, 0], X[p_idx, 1], color='red', s = 40)
else:
plt.scatter(X[p_idx, 0], X[p_idx, 1], color='blue', s = 10)
plt.show()
Example 2: MNIST and its medoids visualized via t-SNE
# Start in the repository root directory, i.e. '/BanditPAM/'.
from banditpam import KMedoids
import numpy as np
import pandas as pd
import matplotlib.pyplot as plt
from sklearn.manifold import TSNE
# Load the 1000-point subset of MNIST and calculate its t-SNE embeddings for visualization:
X = pd.read_csv('data/MNIST-1k.csv', sep=' ', header=None).to_numpy()
X_tsne = TSNE(n_components = 2).fit_transform(X)
# Fit the data with BanditPAM:
kmed = KMedoids(n_medoids = 10, algorithm = "BanditPAM")
kmed.fit(X, 'L2', "mnist_log")
# Visualize the data and the medoids via t-SNE:
for p_idx, point in enumerate(X):
if p_idx in map(int, kmed.medoids):
plt.scatter(X_tsne[p_idx, 0], X_tsne[p_idx, 1], color='red', s = 40)
else:
plt.scatter(X_tsne[p_idx, 0], X_tsne[p_idx, 1], color='blue', s = 5)
plt.show()
The corresponding logfile for this run, mnist_log, will contain the run's results and additional statistics in a format that can be easily read into json.
Documentation
Documentation for BanditPAM can be found here:
- Doxygen docs:
BanditPAM/docs/html/index.html
Building the C++ executable from source
Please note that it is NOT necessary to build the C++ executable from source to use the Python code above. However, if you would like to use the C++ executable directly, follow the instructions below.
Option 1: Building with Docker
We highly recommend building using Docker. One can download and install Docker by following instructions at the Docker install page. Once you have Docker installed and the Docker Daemon is running, run the following commands:
/BanditPAM$ chmod +x env_setup.sh
/BanditPAM$ ./env_setup.sh
/BanditPAM$ ./run_docker.sh
which will start a Docker instance with the necessary dependencies. Then:
/BanditPAM$ mkdir build && cd build
/BanditPAM/build$ cmake .. && make
This will create an executable named BanditPAM in BanditPAM/build/src.
Option 2: Installing Requirements and Building Directly
Building this repository requires four external requirements:
- Cmake >= 3.17, https://cmake.org/download/
- Armadillo >= 10.5.3, http://arma.sourceforge.net/download.html
- OpenMP >= 2.5, https://www.openmp.org/resources/openmp-compilers-tools/ (OpenMP is supported by default on most Linux platforms, and can be downloaded through homebrew on MacOS. For instructions on installing homebrew, see https://brew.sh/.)
- CARMA >= 0.3.0, https://github.com/RUrlus/carma (use the commit to which
BanditPAMpoints in the/headerssubdirectory)
If installing these requirements from source, one can generally use the following procedure to install each requirement from the library's root folder (with CARMA used as an example here):
/BanditPAM$ cd headers/carma
/BanditPAM/headers/carma$ mkdir build && cd build
/BanditPAM/headers/carma/build$ cmake .. && make && sudo make install
Further installation information for MacOS, Linux, and Windows is available in the docs folder. Ensure all the requirements above are installed and then run:
/BanditPAM$ mkdir build && cd build
/BanditPAM/build$ cmake .. && make
This will create an executable named BanditPAM in BanditPAM/build/src.
C++ Usage
Once the executable has been built, it can be invoked with:
/BanditPAM/build/src/BanditPAM -f [path/to/input.csv] -k [number of clusters] -v [verbosity level]
-fis mandatory and specifies the path to the dataset-kis mandatory and specifies the number of clusters with which to fit the data-vis optional and specifies the verbosity level.
For example, if you ran ./env_setup.sh and downloaded the MNIST dataset, you could run:
/BanditPAM/build/src/BanditPAM -f ../data/MNIST-1k.csv -k 10 -v 1
The expected output in the command line will be:
Medoids: 694,168,306,714,324,959,527,251,800,737
A file called KMedoidsLogfile with detailed logs during the process will also be present.
Implementing a custom distance metric
One of the advantages of k-medoids is that it works with arbitrary distance metrics; in fact, your "metric" need not even be a real metric -- it can be negative, asymmetric, and/or not satisfy the triangle inequality or homogeneity. Any pairwise dissimilarity function works with k-medoids!
This also allows for clustering of "exotic" objects like trees, graphs, natural language, and more -- settings where running k-means wouldn't even make sense. We talk about one such setting in the original paper.
The package currently supports a number of distance metrics, including all Lp losses and cosine distance.
If you're willing to write a little C++, you only need to add a few lines to kmedoids_algorithm.cpp and kmedoids_algorithm.hpp to implement your distance metric / pairwise dissimilarity!
Then, be sure to re-install the repository with a pip install . (note the trailing .).
The maintainers of this repository are working on permitting arbitrary dissimilarity metrics that users write in Python, as well; see #4.
Testing
To run the full suite of tests, run in the root directory:
/BanditPAM$ python -m unittest discover -s tests
Alternatively, to run a "smaller" set of tests, from the main repo folder run python tests/test_commit.py or python tests/test_push.py to run a set of longer, more intensive tests.
Reproducing Figures from the Paper
Note that some figures in the original paper were generated using the Python code at https://github.com/motiwari/BanditPAM-python. That code is not pretty, nor is it maintained. It only exists for reference and for reproducibility of the plots.
Credits
Mo Tiwari wrote the original Python implementation of BanditPAM and many features of the C++ implementation. Mo now maintains the C++ implementation.
James Mayclin developed the initial C++ implementation of BanditPAM.
The original BanditPAM paper was published by Mo Tiwari, Martin Jinye Zhang, James Mayclin, Sebastian Thrun, Chris Piech, and Ilan Shomorony.
We would like to thank Jerry Quinn, David Durst, Geet Sethi, and Max Horton for helpful guidance regarding the C++ implementation.
235 Jan 05, 2023
100 Dec 31, 2022
14 May 13, 2022
3.2k Jan 05, 2023
1.2k Jan 04, 2023
6 Nov 19, 2022
7 Nov 15, 2020
28 Oct 02, 2022
6 Oct 08, 2022
0 Jan 20, 2022
1 Sep 14, 2020
4 Dec 30, 2022
22 Oct 20, 2022
2.3k Jan 08, 2023
72 Dec 22, 2022
109 Dec 20, 2022
36 Dec 22, 2022
92 Nov 18, 2022
15 Dec 30, 2021
16 Nov 14, 2022