added descriptions for arguments

Author: subhadarship

.gitignore

@@ -0,0 +1,18 @@
+*.pyc
+venv/
+bin/
+build/
+develop-eggs/
+dist/
+eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+*.eggs
+.mypy_cache/
+.vscode

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) Subhadarshi Panda
+Copyright (c) Subhadarshi
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -41,7 +41,11 @@ cd kmeans_pytorch
 pip install --editable .
 ```
 
+# CPU vs GPU
+see [`cpu_vs_gpu.ipynb`](https://github.com/subhadarship/kmeans_pytorch/blob/master/cpu_vs_gpu.ipynb) for comparison between CPU and GPU
+
 # Notes
 - useful when clustering large number of samples
 - utilizes GPU for faster matrix computations
 - support euclidean and cosine distances (for now)
+