Package for kPOD clustering
Project description
kPOD: A Method for kMeans Clustering of Missing Data
Python software for kmeans clustering of partially observed data from Chi, Chi, and Baraniuk (2016) <doi:10.1080/00031305.2015.1086685>.
The kPOD method presents a simple extension of kmeans clustering for missing data that works even when the missingness mechanism is unknown, when external information is unavailable, and when there is significant missingness in the data. In addition, kPOD presents strong advantages in computation time and resources over other methods for removing missingness, while still maintaining accuracy.
Citation information is provided near the bottom of this README file.
Getting Started
These instructions will walk you through the process of installing and using the kPOD
package in your local environment.
Prerequisites
First, ensure that you have the package manager pip
installed for your Python version. You can find the installation instructions at this link.
In order to use kPOD, you should have Pandas, NumPy, and SciPy. Installation instructions can be found in the links shown or below in the examples.
# install Pandas
pip install pandas
# install NumPy
pip install numpy
# install SciPy
pip install scipy
Installation
The kPOD
Python package was designed simplistically and the installation can be accomplished in only one step, assuming the dependencies mentioned above are installed.
Use the package manager pip
(installation instructions above) to install the kPOD
package.
pip install kpod
You should now have kPOD
installed locally on your device.
QuickStart
The Usage section below demonstrates the features of kPOD
for clustering. The Examples section goes in more depth on all of the available functions with builtin examples.
Usage
With a given dataset containing some missing values, you will use the steps below to perform the kPOD
clustering algorithm.
# import the k_pod method
from kPOD import k_pod
# set the number of clusters desired (in this example, 3)
K = 3
# use previously existing data to perform clustering
clustering_results = k_pod(data_set, K)
# k_pod outputs a tuple with the cluster assignments and centers
print(clustering_results)
Output:
(cluster_assignments, cluster_centers)
# save the cluster assignments and centers
cluster_assignments = clustering_results[0]
cluster_centers = clustering_results[1]
Examples
First, we generate a dataset with missing values using the utility functions available in the kPOD
package.
# import function to generate data
from kPOD import generate_complete_data
# number of observations for the data
N = 10
# number of features/dimensions for the data
P = 2
# number of clusters the data should have
K = 3
# distance between each cluster
CLUSTER_DISTANCE = 5
# use function to generate data set
data_set = generate_complete_data(N, P, K, CLUSTER_DISTANCE)
# view generated data set
>>> data_set
[[0.53044271 2.23450779]
[1.0860111 1.59151924]
[ 0.16173119 0.65364989]
[ 3.44575031 6.93929861]
[ 5.54232482 4.49887709]
[ 4.43165189 4.42414154]
[12.47158915 9.83366756]
[13.09792485 9.02237441]
[ 9.07237922 8.43085377]
[13.94656989 15.6348249 ]]
Next, we generate randomized indices where the numerical values should be replaced with NaN
.
# import function to generate indices
from kPOD import generate_missing_indices
# shape of the data set generated in the last step
SHAPE = (N, P)
# percentage of the data set that should have missing values
MISSING_PERCENT = 10
# use function to generate data set
missing_indices = generate_missing_indices(SHAPE, MISSING_PERCENT)
# view generated data set
>>> missing_indices
[(1, 1), (6, 0)]
Then, we use the fill_missing_indices
function to fill the data set with the generated missing indices.
# import function to fill data set with missing values
from kPOD import fill_missing_indices
# use function to fill data set
data_missing = fill_missing_indices(data_set, missing_indices)
# view data set with missing values
>>> data_missing
[[0.53044271 2.23450779]
[1.0860111 nan]
[ 0.16173119 0.65364989]
[ 3.44575031 6.93929861]
[ 5.54232482 4.49887709]
[ 4.43165189 4.42414154]
[ nan 9.83366756]
[13.09792485 9.02237441]
[ 9.07237922 8.43085377]
[13.94656989 15.6348249 ]]
Now, we can use the kPOD
algorithm to cluster the data set containing missing values.
# import the k_pod method
from kPOD import k_pod
# set the number of clusters to 3
K = 3
# use data with missing values to perform clustering
clustered_data = k_pod(data_missing, K)
# save the cluster assignments and centers
cluster_assignments = clustered_data[0]
cluster_centers = clustered_data[1]
# view cluster assignments
>>> cluster_assignments
[0. 0. 0. 2. 2. 2. 2. 1. 2. 1.]
# view cluster centers
>>> cluster_centers
[array([0.48490754, 0.05269574]), array([13.52224737, 12.32859965]), array([5.63207229, 6.82536771])]
Finally, we can plot the results of the kPOD algorithm. In these examples, the shape of the data set is defined by (N, P), the number of clusters by K, and the percentage of the data that was missing is mentioned. The comparison shown is the kPOD algorithm with the data containing missing values inputted, while the kmeans algorithm was given the complete data set (kMeans does not work on data sets with missing values).
kPOD Algorithm vs kMeans Algorithm Graphically
N = 50, P = 2, K = 3, 10% Missing Data
N = 100, P = 2, K = 3, 25% Missing Data
Note: Colors are randomly assigned for each image and they do not indicate the same clusters of data across images.
As shown, the kPOD algorithm shows only small decreases in accuracy over kmeans while accomplishing a clustering task that would be otherwise computationally expensive with missing data. In addition, the kmeans algorithm shown above is used on the complete data set, since kmeans does not work on data sets with missing values.
Citation
If you find that this Python implementation of kPOD has contributed to your published work, please include the following citations:
Chi JT, Chi EC, Baraniuk RG (2016). “$k$POD: A Method for $k$Means Clustering of Missing Data.” The American Statistician, 70, 91–99. doi: 10.1080/00031305.2015.1086685, http://www.tandfonline.com/doi/abs/10.1080/00031305.2015.1086685.
Corresponding BibTeX entry:
@article{,
title = {$k$POD: A Method for $k$Means Clustering of Missing Data},
author = {Jocelyn T. Chi and Eric C. Chi and Richard G. Baraniuk},
journal = {The American Statistician},
year = {2016},
volume = {70},
pages = {9199},
doi = {10.1080/00031305.2015.1086685},
issue = {1},
url = {http://www.tandfonline.com/doi/abs/10.1080/00031305.2015.1086685},
}
Radia, Ishaan (2020). “A Python implementation of kPOD.” https://github.com/iiradia/kPOD/.
Corresponding BibTeX entry:
@misc{,
author = {Ishaan Radia},
title = {A Python implementation of {$k$POD}},
url = {https://github.com/iiradia/kPOD/},
month = {June},
year = {2020}
}
Authors

Ishaan Radia  Rising Junior majoring in Statistics at North Carolina State University  Translated paper to Python package, responsible for maintenance of package.  LinkedIn  GitHub

Jocelyn T. Chi  PhD Student in Statistics at North Carolina State University  CoAuthor of $k$POD paper and algorithm.  Website

Eric C. Chi  Assistant Professor of Statistics at North Carolina State University  CoAuthor of $k$POD paper and algorithm, Faculty mentor for this Python implementation of $k$POD  Website

Richard G. Baraniuk  Victor E. Cameron Chair of Electrical and Computer Engineering at Rice University  CoAuthor of $k$POD paper and algorithm.  Website
License
This project is licensed under the MIT License. You can find more details in the LICENSE.md file.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Filename, size  File type  Python version  Upload date  Hashes 

Filename, size kPOD0.18py3noneany.whl (10.9 kB)  File type Wheel  Python version py3  Upload date  Hashes View 
Filename, size kPOD0.18.tar.gz (10.3 kB)  File type Source  Python version None  Upload date  Hashes View 