mlx-sparse 0.0.1b0__tar.gz

mlx_sparse-0.0.1b0/.github/workflows/ci.yml

@@ -0,0 +1,49 @@
+name: CI
+
+on:
+  pull_request:
+  push:
+    branches:
+      - main
+
+jobs:
+  test:
+    runs-on: macos-15
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Verify Metal toolchain
+        run: |
+          xcrun -sdk macosx -find metal
+
+      - name: Install
+        run: python -m pip install -e ".[dev,docs]"
+
+      - name: Verify metallib build output
+        run: test -f mlx_sparse/mlx_sparse.metallib
+
+      - name: Python format
+        run: |
+          python -m black --check mlx_sparse tests benchmarks examples
+          python -m isort --check-only mlx_sparse tests benchmarks examples
+
+      - name: C++ format
+        run: |
+          xcrun clang-format --dry-run --Werror src/bindings.cpp src/sparse/*.cpp src/sparse/*.h src/sparse/*.metal
+
+      - name: Tests
+        run: python -m pytest -q --cov=mlx_sparse --cov-report=term-missing --cov-fail-under=88 --cov-branch --cov-append --cov-report=xml
+
+      - name: Docs
+        run: python -m sphinx -b html docs/ docs/_build/html
+
+      - name: Build wheel
+        run: python -m build --wheel
+
+      - name: Upload coverage reports to Codecov
+          uses: codecov/codecov-action@v5
+          with:
+            token: ${{ secrets.CODECOV_TOKEN }}

mlx_sparse-0.0.1b0/.github/workflows/publish.yaml

@@ -0,0 +1,94 @@
+name: Publish to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  build-wheels:
+    name: Wheel / Python ${{ matrix.python-version }}
+    runs-on: macos-15
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12", "3.13"]
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          # Full history is required so setuptools-scm can read the git tag.
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Verify Metal toolchain
+        run: xcrun -sdk macosx -find metal
+
+      - name: Install build frontend
+        run: python -m pip install --upgrade pip build
+
+      - name: Build wheel
+        env:
+          MACOSX_DEPLOYMENT_TARGET: "14.0"
+        run: python -m build --wheel
+
+      - name: Upload wheel artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: wheel-py${{ matrix.python-version }}
+          path: dist/*.whl
+          if-no-files-found: error
+
+  build-sdist:
+    name: Source distribution
+    runs-on: macos-15
+
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.13"
+
+      - name: Install build frontend
+        run: python -m pip install --upgrade pip build
+
+      - name: Build sdist
+        run: python -m build --sdist
+
+      - name: Upload sdist artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: sdist
+          path: dist/*.tar.gz
+          if-no-files-found: error
+
+  publish:
+    name: Publish to PyPI
+    needs: [build-wheels, build-sdist]
+    runs-on: ubuntu-latest
+
+    environment:
+      name: pypi
+      url: https://pypi.org/project/mlx-sparse/
+
+    permissions:
+      id-token: write
+
+    steps:
+      - name: Download all artifacts
+        uses: actions/download-artifact@v4
+        with:
+          path: dist/
+          merge-multiple: true
+
+      - name: List distributions
+        run: ls -lh dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

mlx_sparse-0.0.1b0/.gitignore

@@ -0,0 +1,20 @@
+.DS_Store
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+__pycache__/
+*.py[cod]
+
+build/
+dist/
+*.egg-info/
+
+.venv/
+
+mlx_sparse/_ext*.so
+mlx_sparse/*.dylib
+mlx_sparse/*.metallib
+mlx_sparse/_version.py
+
+docs/_build
+/docs/misc/

mlx_sparse-0.0.1b0/.pre-commit-config.yaml

@@ -0,0 +1,9 @@
+repos:
+  - repo: https://github.com/psf/black
+    rev: 26.5.1
+    hooks:
+      - id: black
+  - repo: https://github.com/pycqa/isort
+    rev: 7.0.0
+    hooks:
+      - id: isort

mlx_sparse-0.0.1b0/.readthedocs.yaml

@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3.12"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - requirements: docs/requirements.txt

mlx_sparse-0.0.1b0/CMakeLists.txt

@@ -0,0 +1,101 @@
+cmake_minimum_required(VERSION 3.27)
+
+project(mlx_sparse_ext LANGUAGES CXX)
+
+set(CMAKE_CXX_STANDARD 17)
+set(CMAKE_CXX_STANDARD_REQUIRED ON)
+set(CMAKE_POSITION_INDEPENDENT_CODE ON)
+
+option(BUILD_SHARED_LIBS "Build extensions as a shared library" ON)
+option(MLX_SPARSE_BUILD_METAL "Build the mlx_sparse Metal library" ON)
+
+if(NOT CMAKE_LIBRARY_OUTPUT_DIRECTORY)
+  set(CMAKE_LIBRARY_OUTPUT_DIRECTORY "${CMAKE_BINARY_DIR}")
+endif()
+
+if(DEFINED ENV{VIRTUAL_ENV})
+  set(Python_EXECUTABLE
+      "$ENV{VIRTUAL_ENV}/bin/python"
+      CACHE FILEPATH "Python executable from active virtualenv" FORCE)
+endif()
+find_package(Python 3.10 COMPONENTS Interpreter Development.Module REQUIRED)
+
+if(NOT DEFINED nanobind_DIR)
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m nanobind --cmake_dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE nanobind_DIR)
+endif()
+find_package(nanobind CONFIG REQUIRED PATHS "${nanobind_DIR}" NO_DEFAULT_PATH)
+
+if(NOT DEFINED MLX_DIR)
+  execute_process(
+    COMMAND "${Python_EXECUTABLE}" -m mlx --cmake-dir
+    OUTPUT_STRIP_TRAILING_WHITESPACE
+    OUTPUT_VARIABLE MLX_DIR)
+endif()
+find_package(MLX CONFIG REQUIRED PATHS "${MLX_DIR}" NO_DEFAULT_PATH)
+
+add_library(mlx_sparse_native)
+
+target_sources(
+  mlx_sparse_native
+  PUBLIC
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/common.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/coo_tocsr.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_matmul.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_matvec.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_sort_indices.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_todense.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_transpose.cpp
+    ${CMAKE_CURRENT_LIST_DIR}/src/sparse/identity_like.cpp)
+
+target_include_directories(
+  mlx_sparse_native
+  PUBLIC
+    ${CMAKE_CURRENT_LIST_DIR}/src)
+
+target_link_libraries(mlx_sparse_native PUBLIC mlx)
+
+execute_process(
+  COMMAND xcrun -sdk macosx -find metal
+  RESULT_VARIABLE MLX_SPARSE_METAL_FIND_RESULT
+  OUTPUT_QUIET
+  ERROR_QUIET)
+
+if(MLX_BUILD_METAL AND MLX_SPARSE_BUILD_METAL AND MLX_SPARSE_METAL_FIND_RESULT EQUAL 0)
+  mlx_build_metallib(
+    TARGET mlx_sparse_metallib
+    TITLE mlx_sparse
+    SOURCES
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/coo_tocsr.metal
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_matmul.metal
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_matvec.metal
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_sort_indices.metal
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_todense.metal
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/csr_transpose.metal
+    DEPS
+      ${CMAKE_CURRENT_LIST_DIR}/src/sparse/metal_common.h
+    INCLUDE_DIRS
+      ${PROJECT_SOURCE_DIR}
+      ${CMAKE_CURRENT_LIST_DIR}/src
+      ${MLX_INCLUDE_DIRS}
+    OUTPUT_DIRECTORY
+      ${CMAKE_LIBRARY_OUTPUT_DIRECTORY})
+
+  add_dependencies(mlx_sparse_native mlx_sparse_metallib)
+else()
+  message(STATUS "Skipping mlx_sparse.metallib build; Metal compiler is unavailable.")
+endif()
+
+nanobind_add_module(
+  _ext
+  NB_STATIC STABLE_ABI LTO NOMINSIZE
+  NB_DOMAIN mlx
+  ${CMAKE_CURRENT_LIST_DIR}/src/bindings.cpp)
+
+target_link_libraries(_ext PRIVATE mlx_sparse_native)
+
+if(BUILD_SHARED_LIBS)
+  target_link_options(_ext PRIVATE -Wl,-rpath,@loader_path)
+endif()

mlx_sparse-0.0.1b0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

mlx_sparse-0.0.1b0/MANIFEST.in

@@ -0,0 +1,16 @@
+include CMakeLists.txt
+include CHANGELOG.md
+include LICENSE
+include README.md
+include pyproject.toml
+include setup.py
+
+recursive-include src *.cpp *.h *.metal
+recursive-include mlx_sparse *.py *.metallib
+recursive-include benchmarks *.py *.md
+recursive-include docs *.css *.md *.py *.rst
+recursive-include examples *.py
+recursive-include tests *.py
+
+prune build
+prune docs/_build

mlx_sparse-0.0.1b0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: mlx-sparse
+Version: 0.0.1b0
+Summary: Sparse array containers and primitives for MLX
+Author: mlx-sparse contributors
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: mlx>=0.31
+Provides-Extra: dev
+Requires-Dist: build>=1.2; extra == "dev"
+Requires-Dist: black>=26.5.0; extra == "dev"
+Requires-Dist: isort>=6; extra == "dev"
+Requires-Dist: nanobind>=2.0; extra == "dev"
+Requires-Dist: numpy>=1.26; extra == "dev"
+Requires-Dist: pre-commit>=4; extra == "dev"
+Requires-Dist: pytest>=8; extra == "dev"
+Requires-Dist: pytest-cov>=6; extra == "dev"
+Requires-Dist: scipy>=1.11; extra == "dev"
+Provides-Extra: bench
+Requires-Dist: numpy>=1.26; extra == "bench"
+Requires-Dist: scipy>=1.11; extra == "bench"
+Provides-Extra: docs
+Requires-Dist: sphinx<10,>=8; extra == "docs"
+Requires-Dist: pydata-sphinx-theme>=0.16; extra == "docs"
+Requires-Dist: myst-nb>=1.4; extra == "docs"
+Dynamic: license-file
+
+# mlx-sparse
+
+> **Warning: beta release**
+> This is an early beta. APIs may change, bugs are expected, and some features
+> are still incomplete. Feedback and issue reports are very welcome!
+
+`mlx-sparse` is an attempt at an MLX-native sparse array package. The public API is Python,
+while performance-critical operations are implemented as MLX primitives in C++
+with CPU backends and Metal kernels for fixed-shape sparse operations.
+
+The supported format surface is COO and CSR for 2D sparse arrays. Current
+functionality includes construction, validation, COO to CSR, CSR to dense, CSR
+canonicalization, CSR matrix-vector multiply, CSR matrix-matrix multiply,
+batched dense RHS products, CSR sparse-sparse products, transpose, Hermitian
+transpose, and autodiff through sparse values and dense RHS operands, including
+`complex64`.
+
+Supported value dtypes are `float32`, `float16`, `bfloat16`, and `complex64`.
+Supported index dtypes are `int32` and `int64` on CPU and GPU.
+
+## Quick Start
+
+Install from PyPI:
+
+```bash
+python -m pip install mlx-sparse
+```
+
+```python
+import mlx.core as mx
+import numpy as np
+
+import mlx_sparse as ms
+
+ms.use_gpu()
+
+data = mx.array(np.array([2.0, -1.0, 4.0], dtype=np.float32))
+row = mx.array(np.array([0, 0, 1], dtype=np.int32))
+col = mx.array(np.array([0, 2, 1], dtype=np.int32))
+
+a = ms.coo_array((data, (row, col)), shape=(2, 3)).tocsr(canonical=True)
+x = mx.array(np.array([3.0, 10.0, 7.0], dtype=np.float32))
+
+y = a @ x
+dense = a.todense()
+at = a.T
+```
+
+The package build compiles `src/sparse/*.metal` into
+`mlx_sparse/mlx_sparse.metallib` when the macOS Metal toolchain is available,
+and the wheel ships that metallib beside the Python package.
+
+## Development
+
+For contributors, use an editable install from the repository root. This builds
+the native extension and installs the development tooling.
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## License
+
+This package is licensed under the [Apache License 2.0](https://github.com/waleed-sh/mlx-sparse/blob/main/LICENSE).

mlx_sparse-0.0.1b0/README.md

@@ -0,0 +1,64 @@
+# mlx-sparse
+
+> **Warning: beta release**
+> This is an early beta. APIs may change, bugs are expected, and some features
+> are still incomplete. Feedback and issue reports are very welcome!
+
+`mlx-sparse` is an attempt at an MLX-native sparse array package. The public API is Python,
+while performance-critical operations are implemented as MLX primitives in C++
+with CPU backends and Metal kernels for fixed-shape sparse operations.
+
+The supported format surface is COO and CSR for 2D sparse arrays. Current
+functionality includes construction, validation, COO to CSR, CSR to dense, CSR
+canonicalization, CSR matrix-vector multiply, CSR matrix-matrix multiply,
+batched dense RHS products, CSR sparse-sparse products, transpose, Hermitian
+transpose, and autodiff through sparse values and dense RHS operands, including
+`complex64`.
+
+Supported value dtypes are `float32`, `float16`, `bfloat16`, and `complex64`.
+Supported index dtypes are `int32` and `int64` on CPU and GPU.
+
+## Quick Start
+
+Install from PyPI:
+
+```bash
+python -m pip install mlx-sparse
+```
+
+```python
+import mlx.core as mx
+import numpy as np
+
+import mlx_sparse as ms
+
+ms.use_gpu()
+
+data = mx.array(np.array([2.0, -1.0, 4.0], dtype=np.float32))
+row = mx.array(np.array([0, 0, 1], dtype=np.int32))
+col = mx.array(np.array([0, 2, 1], dtype=np.int32))
+
+a = ms.coo_array((data, (row, col)), shape=(2, 3)).tocsr(canonical=True)
+x = mx.array(np.array([3.0, 10.0, 7.0], dtype=np.float32))
+
+y = a @ x
+dense = a.todense()
+at = a.T
+```
+
+The package build compiles `src/sparse/*.metal` into
+`mlx_sparse/mlx_sparse.metallib` when the macOS Metal toolchain is available,
+and the wheel ships that metallib beside the Python package.
+
+## Development
+
+For contributors, use an editable install from the repository root. This builds
+the native extension and installs the development tooling.
+
+```bash
+python -m pip install -e ".[dev]"
+```
+
+## License
+
+This package is licensed under the [Apache License 2.0](https://github.com/waleed-sh/mlx-sparse/blob/main/LICENSE).