sparsepixels 0.1.0__tar.gz

sparsepixels-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Ho Fung Tsoi
+
+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.

sparsepixels-0.1.0/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: sparsepixels
+Version: 0.1.0
+Summary: Efficient convolution for sparse data on FPGAs
+Home-page: https://github.com/hftsoi/sparse-pixels
+Author: Ho Fung Tsoi
+Author-email: ho.fung.tsoi@cern.ch
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tensorflow<2.15.0,>=2.14.0
+Requires-Dist: keras<2.15.0,>=2.14.0
+Requires-Dist: qkeras<0.10.0,>=0.9.0
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/logo.png" width="300" />
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/sparsepixels.png" width="900"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_standard.gif" width="400" />
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_sparse.gif" width="400" />
+</p>
+
+# SparsePixels: Efficient convolution for sparse data on FPGAs
+
+[![arXiv](https://img.shields.io/badge/arXiv-2512.06208-b31b1b.svg?style=flat-square)](https://arxiv.org/abs/2512.06208)
+
+> **Note:** code packaging in preparation, stay tuned :)
+
+## Installation
+
+## Getting Started
+
+## Documentation
+
+## Citation
+If you find this useful in your research, please consider citing:
+```
+@article{Tsoi:2025nvg,
+    author = "Tsoi, Ho Fung and Rankin, Dylan and Loncar, Vladimir and Harris, Philip",
+    title = "{SparsePixels: Efficient Convolution for Sparse Data on FPGAs}",
+    eprint = "2512.06208",
+    archivePrefix = "arXiv",
+    primaryClass = "cs.AR",
+    month = "12",
+    year = "2025"
+}
+```

sparsepixels-0.1.0/README.md

@@ -0,0 +1,38 @@
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/logo.png" width="300" />
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/sparsepixels.png" width="900"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_standard.gif" width="400" />
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_sparse.gif" width="400" />
+</p>
+
+# SparsePixels: Efficient convolution for sparse data on FPGAs
+
+[![arXiv](https://img.shields.io/badge/arXiv-2512.06208-b31b1b.svg?style=flat-square)](https://arxiv.org/abs/2512.06208)
+
+> **Note:** code packaging in preparation, stay tuned :)
+
+## Installation
+
+## Getting Started
+
+## Documentation
+
+## Citation
+If you find this useful in your research, please consider citing:
+```
+@article{Tsoi:2025nvg,
+    author = "Tsoi, Ho Fung and Rankin, Dylan and Loncar, Vladimir and Harris, Philip",
+    title = "{SparsePixels: Efficient Convolution for Sparse Data on FPGAs}",
+    eprint = "2512.06208",
+    archivePrefix = "arXiv",
+    primaryClass = "cs.AR",
+    month = "12",
+    year = "2025"
+}
+```

sparsepixels-0.1.0/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"

sparsepixels-0.1.0/setup.cfg

@@ -0,0 +1,31 @@
+[metadata]
+name = sparsepixels
+version = 0.1.0
+description = Efficient convolution for sparse data on FPGAs
+author = Ho Fung Tsoi
+author_email = ho.fung.tsoi@cern.ch
+license = MIT
+license_files = LICENSE
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/hftsoi/sparse-pixels
+classifiers = 
+	Programming Language :: Python :: 3
+	License :: OSI Approved :: MIT License
+
+[options]
+packages = find_namespace:
+python_requires = >=3.10
+install_requires = 
+	tensorflow>=2.14.0,<2.15.0
+	keras>=2.14.0,<2.15.0
+	qkeras>=0.9.0,<0.10.0
+include_package_data = True
+
+[options.package_data]
+sparsepixels = img/logo.png
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

sparsepixels-0.1.0/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+if __name__ == "__main__":
+    setup()

sparsepixels-0.1.0/sparsepixels/layers.py

@@ -0,0 +1,153 @@
+import tensorflow as tf
+from qkeras import QConv2D, quantizers
+from tensorflow.keras.layers import AveragePooling2D, MaxPooling2D
+
+class InputReduce(tf.keras.layers.Layer):
+    def __init__(self, n_max_pixels, threshold, **kwargs):
+        super(InputReduce, self).__init__(**kwargs)
+        self.n_max_pixels = n_max_pixels
+        self.threshold = threshold
+
+    def call(self, inputs):
+        batch_size = tf.shape(inputs)[0]
+        h = tf.shape(inputs)[1]
+        w = tf.shape(inputs)[2]
+
+        '''
+        if self.threshold is not None:
+            cond = inputs > self.threshold
+        else:
+            cond = inputs != 0
+        active_flag = tf.cast(tf.reduce_any(cond, axis=-1), tf.int32)
+        '''
+
+        # to be consistent with hls, check only the first input channel
+        if self.threshold is not None:
+            active_flag = tf.cast(inputs[..., 0] > self.threshold, tf.int32)
+        else:
+            active_flag = tf.cast(inputs[..., 0] != 0, tf.int32)
+
+        active_flag_flat = tf.reshape(active_flag, [batch_size, h * w])
+        active_count = tf.cumsum(active_flag_flat, axis=1)
+
+        keep_mask_flat = tf.cast(tf.logical_and(active_flag_flat == 1, active_count <= self.n_max_pixels), inputs.dtype)
+        keep_mask = tf.reshape(keep_mask_flat, [batch_size, h, w, 1])
+
+        inputs_reduced = inputs * keep_mask
+        return inputs_reduced, keep_mask
+
+    def get_config(self):
+        config = super(InputReduce, self).get_config()
+        config.update({
+            "n_max_pixels": self.n_max_pixels,
+            "threshold": self.threshold
+        })
+        return config
+    
+
+class RemoveDilatedPixels(tf.keras.layers.Layer):
+    def __init__(self, **kwargs):
+        super(RemoveDilatedPixels, self).__init__(**kwargs)
+
+    def call(self, inputs):
+        x, mask = inputs
+        mask = tf.cast(mask, x.dtype)
+        removed = x * mask
+        return removed
+
+    def get_config(self):
+        config = super(RemoveDilatedPixels, self).get_config()
+        return config
+
+
+class QConv2DSparse(tf.keras.layers.Layer):
+    def __init__(self, *conv_args, **conv_kwargs):
+        super().__init__(name=conv_kwargs.get("name", None))
+        self._bias_quant_cfg = conv_kwargs.pop("bias_quantizer", None)
+        self._bias_quantizer = (quantizers.get_quantizer(self._bias_quant_cfg) if self._bias_quant_cfg is not None else None)
+
+        conv_kwargs["use_bias"] = False
+        self.conv = QConv2D(*conv_args, **conv_kwargs)
+        self.bias = self.add_weight(
+            name = "bias",
+            shape = (self.conv.filters,),
+            initializer = "zeros",
+            trainable = True,
+            dtype = self.conv.dtype,
+        )
+        self.masker = RemoveDilatedPixels()
+
+    def call(self, inputs, **kwargs):
+        x, keep_mask = inputs
+        x = self.masker((x, keep_mask))
+        y = self.conv(x, **kwargs)
+
+        b = self.bias
+        if self._bias_quantizer is not None:
+            b = self._bias_quantizer(b)
+        b = tf.reshape(b, shape=(1, 1, 1, -1))
+
+        non_zero = tf.cast(tf.not_equal(y, 0), y.dtype)
+        y = y + b * non_zero
+
+        y = self.masker((y, keep_mask))
+        return y
+
+    def get_config(self):
+        cfg = super().get_config()
+        cfg["conv_config"] = self.conv.get_config()
+        cfg["bias_quantizer"] = self._bias_quant_cfg
+        return cfg
+
+    @classmethod
+    def from_config(cls, config):
+        conv_cfg = config.pop("conv_config")
+        bias_quant_cfg = config.pop("bias_quantizer", None)
+        layer = cls(**conv_cfg, bias_quantizer=bias_quant_cfg)
+        return layer
+
+
+class AveragePooling2DSparse(tf.keras.layers.Layer):
+    def __init__(self, *pool_args, **pool_kwargs):
+        super().__init__(name=pool_kwargs.get("name", None))
+        self.avg_pool = AveragePooling2D(*pool_args, **pool_kwargs)
+        self.max_pool = MaxPooling2D(*pool_args, **pool_kwargs)
+
+    def call(self, inputs, **kwargs):
+        x, keep_mask = inputs
+        y = self.avg_pool(x, **kwargs)
+        keep_mask_pooled = self.max_pool(keep_mask)
+        return y, keep_mask_pooled
+
+    def get_config(self):
+        cfg = super().get_config()
+        cfg["pool_config"] = self.avg_pool.get_config()
+        return cfg
+
+    @classmethod
+    def from_config(cls, config):
+        pool_cfg = config.pop("pool_config")
+        return cls(**pool_cfg)
+    
+
+class MaxPooling2DSparse(tf.keras.layers.Layer):
+    def __init__(self, *pool_args, **pool_kwargs):
+        super().__init__(name=pool_kwargs.get("name", None))
+        self.max_pool = MaxPooling2D(*pool_args, **pool_kwargs)
+
+    def call(self, inputs, **kwargs):
+        x, keep_mask = inputs
+        y = self.max_pool(x, **kwargs)
+        keep_mask_pooled = self.max_pool(keep_mask)
+        return y, keep_mask_pooled
+
+    def get_config(self):
+        cfg = super().get_config()
+        cfg["pool_config"] = self.max_pool.get_config()
+        return cfg
+
+    @classmethod
+    def from_config(cls, config):
+        pool_cfg = config.pop("pool_config")
+        return cls(**pool_cfg)
+

sparsepixels-0.1.0/sparsepixels.egg-info/PKG-INFO

@@ -0,0 +1,56 @@
+Metadata-Version: 2.4
+Name: sparsepixels
+Version: 0.1.0
+Summary: Efficient convolution for sparse data on FPGAs
+Home-page: https://github.com/hftsoi/sparse-pixels
+Author: Ho Fung Tsoi
+Author-email: ho.fung.tsoi@cern.ch
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: tensorflow<2.15.0,>=2.14.0
+Requires-Dist: keras<2.15.0,>=2.14.0
+Requires-Dist: qkeras<0.10.0,>=0.9.0
+Dynamic: license-file
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/logo.png" width="300" />
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/sparsepixels.png" width="900"/>
+</p>
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_standard.gif" width="400" />
+  <img src="https://raw.githubusercontent.com/hftsoi/sparse-pixels/main/docs/figs/cnn_sparse.gif" width="400" />
+</p>
+
+# SparsePixels: Efficient convolution for sparse data on FPGAs
+
+[![arXiv](https://img.shields.io/badge/arXiv-2512.06208-b31b1b.svg?style=flat-square)](https://arxiv.org/abs/2512.06208)
+
+> **Note:** code packaging in preparation, stay tuned :)
+
+## Installation
+
+## Getting Started
+
+## Documentation
+
+## Citation
+If you find this useful in your research, please consider citing:
+```
+@article{Tsoi:2025nvg,
+    author = "Tsoi, Ho Fung and Rankin, Dylan and Loncar, Vladimir and Harris, Philip",
+    title = "{SparsePixels: Efficient Convolution for Sparse Data on FPGAs}",
+    eprint = "2512.06208",
+    archivePrefix = "arXiv",
+    primaryClass = "cs.AR",
+    month = "12",
+    year = "2025"
+}
+```

sparsepixels-0.1.0/sparsepixels.egg-info/SOURCES.txt

@@ -0,0 +1,13 @@
+LICENSE
+README.md
+pyproject.toml
+setup.cfg
+setup.py
+sparsepixels/__init__.py
+sparsepixels/layers.py
+sparsepixels.egg-info/PKG-INFO
+sparsepixels.egg-info/SOURCES.txt
+sparsepixels.egg-info/dependency_links.txt
+sparsepixels.egg-info/requires.txt
+sparsepixels.egg-info/top_level.txt
+sparsepixels/img/logo.png

sparsepixels-0.1.0/sparsepixels.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

sparsepixels-0.1.0/sparsepixels.egg-info/requires.txt

@@ -0,0 +1,3 @@
+tensorflow<2.15.0,>=2.14.0
+keras<2.15.0,>=2.14.0
+qkeras<0.10.0,>=0.9.0

sparsepixels-0.1.0/sparsepixels.egg-info/top_level.txt

@@ -0,0 +1,8 @@
+datasets
+dist
+docs
+hls_proj
+hls_templates
+plots
+sparsepixels
+weights