pyrception 0.3.2__py3-none-any.whl → 0.3.4__py3-none-any.whl

pyrception-0.3.4.dist-info/METADATA

@@ -0,0 +1,120 @@
+Metadata-Version: 2.4
+Name: pyrception
+Version: 0.3.4
+Author: Alexander Hadjiivanov
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENCE.md
+Requires-Dist: av
+Requires-Dist: bokeh
+Requires-Dist: loguru
+Requires-Dist: matplotlib
+Requires-Dist: moviepy
+Requires-Dist: numpy
+Requires-Dist: omegaconf
+Requires-Dist: platformdirs
+Requires-Dist: scikit-image
+Requires-Dist: scipy
+Requires-Dist: tqdm
+Dynamic: license-file
+
+[![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
+[![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
+
+# 🌄 Overview
+Pyrception is a simulation framework for biosensors. Currently, it provides the base ingredients for simulating key parts of the structural and functional elements of visual processing observed in the mammalian retina. The long-term goal of Pyrception is to support multiple sensory modalities (such as auditory, olfactory and tactile), and to provide methods for integrating those inputs into a unified multisensory input signal (such as spike trains). Alongside this, Pyrception can also serve as an input *conversion*  for encoding raw multimodal sensory input into a uniform spike train suitable for processing with spiking neural networks.
+
+<!-- ![Herd of zebra - multi-stage retinal processing]() -->
+<div align="center">
+    <video align="center" src="https://github.com/user-attachments/assets/faeea832-3832-48d0-8085-d71e62acc794" type="video/mp4" controls autoplay muted loop></video>
+    <p align="center">An RGB video processed with different layers (see the full <a href="https://pyrception.readthedocs.io/en/latest/notebooks/video/">example</a>).</p>
+</div>
+
+## 🪛 Installation
+
+You can install Pyrception from PyPI:
+
+```shell
+pip install pyrception
+```
+
+or directly from GitHub (optionally in development mode):
+
+```shell
+git clone git@github.com:cantordust/pyrception.git
+cd pyrception
+pip install -e .
+```
+
+### ♻️ Optional dependencies
+
+Pyrception supports several dependency groups:
+
+- `cli`: Command-line interface.
+- `events`: Support for processing events (including from event cameras).
+- `dev`: Development tools (for testing, profiling, etc.).
+- `torch`: PyTorch support.
+- `ipy`: ipykernel & ipywidgets (for running inside notebooks).
+- `docs`: Tools for building the documentation.
+    - NOTE: The documentation is built using [MKDocs](https://www.mkdocs.org/), which has been discontinued. The documentation will likely move to [Zensical](https://zensical.org/) soon.
+- `all`: All of the above.
+
+Use the `--group` with `pip` to enable a dependency group (repeat for each group). For instance:
+
+```shell
+pip install -e . --group events --group docs
+```
+
+will pull in all dependencies necessary for event-based input and building the documentation.
+
+## ⏯️ Usage
+
+Please refer to the [documentation](https://pyrception.readthedocs.io/en/latest/), which contains step-by-step notebooks demonstrating how to use Pyrception with a [static image](https://pyrception.readthedocs.io/en/latest/notebooks/image/) and an [RGB video](https://pyrception.readthedocs.io/en/latest/notebooks/video/). More notebooks are currently being developed, including sparse event input from an event camera. Stay tuned.
+
+## 📈 Development
+
+Please open an issue if you discover a bug, feature. That said, contributions are welcome!
+
+To generate and view the documentation locally, clone the repository and run the MkDocs build pipeline (note that you have to install Pyrception with the [`docs` dependency group](#optional-dependencies)):
+
+```shell
+git clone git@github.com:cantordust/pyrception.git
+cd pyrception
+pip install -e . --group docs
+cd docs
+mkdocs build
+```
+
+Then, to view the documentation locally, start the MkDocs server:
+
+```shell
+mkdocs serve
+```
+
+# 📋 ToDo
+
+## Short-term
+### 👁️ Visual package
+- [X] All major types of retinal cells.
+    - [X] Receptors (raw input, Weber's law).
+    - [X] Horizontal cells (mean local brightness, normalising feedback).
+    - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
+    - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
+    - [X] Ganglion cells (spiking).
+- [X] Logpolar kernel arrangement.
+- [X] Uniform or Gaussian kernels.
+- [X] Arbitrary kernel, size, shape and orientation.
+- 🚧 Colour vision (with colour opponency).
+- 🚧 Temporal dynamics.
+- 🚧 Events as input.
+- [ ] Saccadic movements.
+
+### 👂 Auditory package
+WIP.
+
+### 👃 Olfactory package
+WIP.
+
+### 🔧 Others
+- 🚧 Support alternative backends for sparse matrix operations ([CuPy](https://cupy.dev/), [PyTorch](https://pytorch.org/docs/stable/sparse.html), [Sparse](https://sparse.pydata.org/en/stable/)).
+- 🚧 Interfacing with (neuromorphic) hardware, such as event cameras.

pyrception-0.3.4.dist-info/RECORD

@@ -0,0 +1,7 @@
+pyrception/__init__.py,sha256=WUk9ebEuT3MfgaQIrOUWRGvg1W9M76rUGuJZEQ3-lTE,84
+pyrception-0.3.4.dist-info/licenses/LICENCE.md,sha256=sMjXzdudBXMsZj3NRSrmovs-xqcYWRmpwUkZmuD8zhA,1070
+pyrception-0.3.4.dist-info/METADATA,sha256=_93Cev3POLlV1lSp2xux0UDCN9OD3RLJNm6MSwY2y2M,4930
+pyrception-0.3.4.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+pyrception-0.3.4.dist-info/entry_points.txt,sha256=otFE1Ls0p9Hrb4dXjIRruuSLaUFjsKJDjf9R0tDUxmw,55
+pyrception-0.3.4.dist-info/top_level.txt,sha256=0BQnVt58i3lOTA_eEir2Fz2KxDcruQoBmMAxgMWlfrU,11
+pyrception-0.3.4.dist-info/RECORD,,

pyrception-0.3.2.dist-info/METADATA

@@ -1,110 +0,0 @@
-Metadata-Version: 2.4
-Name: pyrception
-Version: 0.3.2
-Author: Alexander Hadjiivanov
-Requires-Python: >=3.11
-Description-Content-Type: text/markdown
-License-File: LICENCE.md
-Requires-Dist: av
-Requires-Dist: bokeh
-Requires-Dist: environs
-Requires-Dist: ipykernel
-Requires-Dist: ipywidgets
-Requires-Dist: loguru
-Requires-Dist: matplotlib
-Requires-Dist: moviepy
-Requires-Dist: numpy
-Requires-Dist: omegaconf
-Requires-Dist: platformdirs
-Requires-Dist: scikit-image
-Requires-Dist: scipy
-Requires-Dist: tqdm
-Provides-Extra: gui
-Requires-Dist: pyqtgraph; extra == "gui"
-Requires-Dist: PySide6; extra == "gui"
-Provides-Extra: cli
-Requires-Dist: cloup; extra == "cli"
-Provides-Extra: events
-Requires-Dist: tonic; extra == "events"
-Provides-Extra: dev
-Requires-Dist: black; extra == "dev"
-Requires-Dist: py-spy; extra == "dev"
-Provides-Extra: torch
-Requires-Dist: torch; extra == "torch"
-Provides-Extra: docs
-Requires-Dist: mkdocs; extra == "docs"
-Requires-Dist: mike; extra == "docs"
-Requires-Dist: mkdocs-jupyter; extra == "docs"
-Requires-Dist: mkdocs-material; extra == "docs"
-Requires-Dist: mkdocstrings[python]; extra == "docs"
-Dynamic: license-file
-
-[![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
-[![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
-
-# Overview
-Pyrception is a simulation framework for bio-plausible simulation of perceptual modalities. Currently, it supports visual pathways of the mammalian retina, but the long-term goal is to support modalities such as auditory, olfactory and so forth. It can also serve as an input conversion library for encoding raw multimodal sensory input into a uniform spike train suitable for processing with spiking neural networks.
-
-## Installation
-
-You can install Pyrception from PyPI:
-
-```shell
-pip install pyrception
-```
-
-or directly from GitHub (optionally in development mode):
-
-```shell
-git clone git@github.com:cantordust/pyrception.git
-cd pyrception
-pip install -e .
-```
-
-## Usage
-
-Please refer to the [documentation](https://pyrception.readthedocs.io/en/latest/), which contains a [step-by-step notebook](https://pyrception.readthedocs.io/en/latest/notebooks/image/) demonstrating how to use `pyrception` with a static image. More notebooks are currently being developed, including frame-based RGB input and sparse event input from an event camera. Watch this space.
-
-## Documentation
-
-To generate the documentation, run the MkDocs build pipeline. Note that to build and view the documentation locally, you have to install `pyrception` from GitHub with the optional `docs` modifier:
-
-```shell
-pip install -e .[dev]
-cd docs
-mkdocs build
-```
-
-Then, to view the documentation locally, start the MkDocs server:
-
-```shell
-mkdocs serve
-```
-
-# ToDo
-
-## Short-term
-### Visual package
-- [X] All major types of retinal cells.
-    - [X] Receptors (raw input, Weber's law).
-    - [X] Horizontal cells (mean local brightness, normalising feedback).
-    - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
-    - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
-    - [X] Ganglion cells (spiking).
-- [X] Logpolar kernel arrangement.
-- [X] Uniform or Gaussian kernels.
-- [X] Arbitrary kernel, size, shape and orientation.
-- [ ] Saccadic movements [WIP].
-- [ ] Colour vision (with colour opponency) [WIP].
-- [ ] Temporal dynamics [WIP].
-- [ ] Events as input [WIP].
-
-### Auditory package
-WIP.
-
-### Olfactory package
-WIP.
-
-### Overall functionality
-- [WIP] Support alternative backends for sparse matrix operations ([CuPy](https://cupy.dev/), [PyTorch](https://pytorch.org/docs/stable/sparse.html), [Sparse](https://sparse.pydata.org/en/stable/)).
-- [ ] Interfacing with (neuromorphic) hardware, such as event cameras.

pyrception-0.3.2.dist-info/RECORD

@@ -1,7 +0,0 @@
-pyrception/__init__.py,sha256=WUk9ebEuT3MfgaQIrOUWRGvg1W9M76rUGuJZEQ3-lTE,84
-pyrception-0.3.2.dist-info/licenses/LICENCE.md,sha256=sMjXzdudBXMsZj3NRSrmovs-xqcYWRmpwUkZmuD8zhA,1070
-pyrception-0.3.2.dist-info/METADATA,sha256=weLEAFdSqU3Fb5YLPe0Pcra-9o5Qqkkg92K3bvNPtfk,3885
-pyrception-0.3.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-pyrception-0.3.2.dist-info/entry_points.txt,sha256=otFE1Ls0p9Hrb4dXjIRruuSLaUFjsKJDjf9R0tDUxmw,55
-pyrception-0.3.2.dist-info/top_level.txt,sha256=0BQnVt58i3lOTA_eEir2Fz2KxDcruQoBmMAxgMWlfrU,11
-pyrception-0.3.2.dist-info/RECORD,,