mlx-cluster 0.0.5__cp312-cp312-macosx_14_0_universal2.whl

mlx_cluster/__init__.py

@@ -0,0 +1,4 @@
+import mlx.core as mx
+
+from ._ext import random_walk
+from ._ext import rejection_sampling

mlx_cluster-0.0.5.dist-info/METADATA

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: mlx_cluster
+Version: 0.0.5
+Summary: C++ extension for generating random graphs
+Author-email: Vinay Pandya <vinayharshadpandya27@gmail.com>
+Project-URL: Homepage, https://github.com/vinayhpandya/mlx_cluster
+Project-URL: Issues, https://github.com/vinayhpandya/mlx_cluster/Issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: C++
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: MacOS
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: dev
+Provides-Extra: test
+Requires-Dist: mlx-graphs>=0.0.8; extra == "test"
+Requires-Dist: torch>=2.2.0; extra == "test"
+Requires-Dist: mlx>=0.26.0; extra == "test"
+Requires-Dist: pytest==7.4.4; extra == "test"
+Requires-Dist: scipy>=1.13.0; extra == "test"
+Requires-Dist: requests==2.31.0; extra == "test"
+Requires-Dist: fsspec[http]==2024.2.0; extra == "test"
+Requires-Dist: tqdm==4.66.1; extra == "test"
+Dynamic: license-file
+Dynamic: requires-python
+
+# mlx_cluster
+
+A C++ extension for generating random walks for Homogeneous graphs using mlx
+
+## Installation
+
+To install the necessary dependencies:
+
+Clone the repositories:
+```bash
+git clone https://github.com/vinayhpandya/mlx_cluster.git
+```
+
+After cloning the repository install library using 
+
+```bash
+python setup.py build_ext -j8 --inplace
+```
+
+You can also just install the library via pip
+
+```bash
+pip install mlx_cluster
+```
+
+for testing purposes you need to have `mlx-graphs`  and `torch_geometric` installed
+
+## Usage
+
+
+```
+# Can also use mlx for generating starting indices
+import torch
+from torch.utils.data import DataLoader
+
+loader = DataLoader(range(2708), batch_size=2000)
+start_indices = next(iter(loader))
+
+
+from mlx_graphs.datasets import PlanetoidDataset
+from mlx_graphs.utils.sorting import sort_edge_index
+from torch.utils.data import DataLoader
+from mlx_cluster import random_walk
+
+cora_dataset = PlanetoidDataset(name="cora", base_dir="~")
+# For some reason int_64t and int_32t are not compatible
+edge_index = cora_dataset.graphs[0].edge_index.astype(mx.int64)
+
+# Convert edge index into a CSR matrix
+sorted_edge_index = sort_edge_index(edge_index=edge_index)
+row_mlx = sorted_edge_index[0][0]
+col_mlx = sorted_edge_index[0][1]
+_, counts_mlx = np.unique(np.array(row_mlx, copy=False), return_counts=True)
+cum_sum_mlx = counts_mlx.cumsum()
+row_ptr_mlx = mx.concatenate([mx.array([0]), mx.array(cum_sum_mlx)])
+start_indices = mx.array(start_indices.numpy())
+
+rand_data = mx.random.uniform(shape=[start_indices.shape[0], 5])
+
+node_sequence = random_walk(
+    row_ptr_mlx, col_mlx, start_indices, rand_data, 5, stream=mx.cpu
+)
+```
+
+## TODO
+
+- [x] Add metal shaders to optimize the code
+- [ ] Benchmark random walk against different frameworks
+- [ ] Add more algorithms
+
+## Credits:
+
+torch_cluster random walk implementation : [random_walk](https://github.com/rusty1s/pytorch_cluster/blob/master/csrc/cpu/rw_cpu.cpp)

mlx_cluster-0.0.5.dist-info/RECORD

@@ -0,0 +1,9 @@
+mlx_cluster/__init__.py,sha256=PNgjmiw5F4DRhwCXwtJH5B22C-eB6dVD8Nqctj_3kaY,90
+mlx_cluster/_ext.cpython-312-darwin.so,sha256=yGeRNJxpPD4fyh0ruKLX8x-vY-mPwUWhYeuW4AEla3o,132168
+mlx_cluster/libmlx_cluster.dylib,sha256=jB1nGg6gKmOliPa6vt2_yjV05gAMxlendzkPJlYlcoY,68760
+mlx_cluster/mlx_cluster.metallib,sha256=LdYPYY3iNcwYXpRY-yX_ANOMbDPx04iMx4QJaCFTanA,5416
+mlx_cluster-0.0.5.dist-info/licenses/LICENSE,sha256=7ixsoVuroKzGl84-ZV90CDH6bQrQF2UXvgnTqtW4Zb4,1069
+mlx_cluster-0.0.5.dist-info/METADATA,sha256=yGDaLgX9s97pJo8A8azxQo9RObR2-BVH17PromIadLg,3018
+mlx_cluster-0.0.5.dist-info/WHEEL,sha256=YkHrUi3IRQEf_VfQuUNQu54AKI6RL0ESio4qNLEH7Hg,114
+mlx_cluster-0.0.5.dist-info/top_level.txt,sha256=sERi0kZuQnKmsHnqOkAda1kkBXdQAwV25Y9L-ATj110,12
+mlx_cluster-0.0.5.dist-info/RECORD,,

mlx_cluster-0.0.5.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: false
+Tag: cp312-cp312-macosx_14_0_universal2
+

mlx_cluster-0.0.5.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 vinayhpandya
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

mlx_cluster-0.0.5.dist-info/top_level.txt

@@ -0,0 +1 @@
+mlx_cluster