pyrception 0.2.4__tar.gz → 0.2.5__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,110 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyrception
3
+ Version: 0.2.5
4
+ Author: Alexander Hadjiivanov
5
+ Requires-Python: >=3.11
6
+ Description-Content-Type: text/markdown
7
+ License-File: LICENCE.md
8
+ Requires-Dist: av
9
+ Requires-Dist: black
10
+ Requires-Dist: h5py
11
+ Requires-Dist: imageio[ffmpeg]
12
+ Requires-Dist: ipykernel
13
+ Requires-Dist: ipywidgets
14
+ Requires-Dist: loguru
15
+ Requires-Dist: matplotlib
16
+ Requires-Dist: numpy
17
+ Requires-Dist: opencv-python
18
+ Requires-Dist: plotly[express]
19
+ Requires-Dist: pydantic-settings
20
+ Requires-Dist: rich
21
+ Requires-Dist: ruff
22
+ Requires-Dist: scikit-image
23
+ Requires-Dist: scipy
24
+ Requires-Dist: tqdm
25
+ Provides-Extra: gui
26
+ Requires-Dist: pyqtgraph; extra == "gui"
27
+ Requires-Dist: PySide6; extra == "gui"
28
+ Provides-Extra: cli
29
+ Requires-Dist: cloup; extra == "cli"
30
+ Provides-Extra: events
31
+ Requires-Dist: tonic; extra == "events"
32
+ Provides-Extra: dev
33
+ Requires-Dist: py-spy; extra == "dev"
34
+ Provides-Extra: docs
35
+ Requires-Dist: mike; extra == "docs"
36
+ Requires-Dist: mkdocs-jupyter; extra == "docs"
37
+ Requires-Dist: mkdocs-material; extra == "docs"
38
+ Requires-Dist: mkdocs; extra == "docs"
39
+ Requires-Dist: mkdocstrings[python]; extra == "docs"
40
+ Dynamic: license-file
41
+
42
+ [![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
43
+ [![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
44
+
45
+ # Overview
46
+ 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.
47
+
48
+ ## Installation
49
+
50
+ You can install Pyrception from PyPI:
51
+
52
+ ```shell
53
+ pip install pyrception
54
+ ```
55
+
56
+ or directly from GitHub (optionally in development mode):
57
+
58
+ ```shell
59
+ git clone git@github.com:cantordust/pyrception.git
60
+ cd pyrception
61
+ pip install -e .
62
+ ```
63
+
64
+ ## Usage
65
+
66
+ Please refer to the [documentation](#documentation), which contains a [step-by-step notebook](docs/docs/notebooks/image.ipynb) 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.
67
+
68
+ ## Documentation
69
+
70
+ 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:
71
+
72
+ ```shell
73
+ pip install -e .[dev]
74
+ cd docs
75
+ mkdocs build
76
+ ```
77
+
78
+ Then, to view the documentation locally, start the MkDocs server:
79
+
80
+ ```shell
81
+ mkdocs serve
82
+ ```
83
+
84
+ # ToDo
85
+
86
+ ## Short-term
87
+ ### Visual package
88
+ - [X] All major types of retinal cells.
89
+ - [X] Receptors (raw input, Weber's law).
90
+ - [X] Horizontal cells (mean local brightness, normalising feedback).
91
+ - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
92
+ - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
93
+ - [X] Ganglion cells (spiking).
94
+ - [X] Logpolar kernel arrangement.
95
+ - [X] Uniform or Gaussian kernels.
96
+ - [X] Arbitrary kernel, size, shape and orientation.
97
+ - [ ] Saccadic movements [WIP].
98
+ - [ ] Colour vision (with colour opponency) [WIP].
99
+ - [ ] Temporal dynamics [WIP].
100
+ - [ ] Events as input [WIP].
101
+
102
+ ### Auditory package
103
+ WIP.
104
+
105
+ ### Olfactory package
106
+ WIP.
107
+
108
+ ### Overall functionality
109
+ - [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/)).
110
+ - [ ] Interfacing with (neuromorphic) hardware, such as event cameras.
@@ -0,0 +1,69 @@
1
+ [![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
2
+ [![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
3
+
4
+ # Overview
5
+ 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.
6
+
7
+ ## Installation
8
+
9
+ You can install Pyrception from PyPI:
10
+
11
+ ```shell
12
+ pip install pyrception
13
+ ```
14
+
15
+ or directly from GitHub (optionally in development mode):
16
+
17
+ ```shell
18
+ git clone git@github.com:cantordust/pyrception.git
19
+ cd pyrception
20
+ pip install -e .
21
+ ```
22
+
23
+ ## Usage
24
+
25
+ Please refer to the [documentation](#documentation), which contains a [step-by-step notebook](docs/docs/notebooks/image.ipynb) 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.
26
+
27
+ ## Documentation
28
+
29
+ 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:
30
+
31
+ ```shell
32
+ pip install -e .[dev]
33
+ cd docs
34
+ mkdocs build
35
+ ```
36
+
37
+ Then, to view the documentation locally, start the MkDocs server:
38
+
39
+ ```shell
40
+ mkdocs serve
41
+ ```
42
+
43
+ # ToDo
44
+
45
+ ## Short-term
46
+ ### Visual package
47
+ - [X] All major types of retinal cells.
48
+ - [X] Receptors (raw input, Weber's law).
49
+ - [X] Horizontal cells (mean local brightness, normalising feedback).
50
+ - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
51
+ - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
52
+ - [X] Ganglion cells (spiking).
53
+ - [X] Logpolar kernel arrangement.
54
+ - [X] Uniform or Gaussian kernels.
55
+ - [X] Arbitrary kernel, size, shape and orientation.
56
+ - [ ] Saccadic movements [WIP].
57
+ - [ ] Colour vision (with colour opponency) [WIP].
58
+ - [ ] Temporal dynamics [WIP].
59
+ - [ ] Events as input [WIP].
60
+
61
+ ### Auditory package
62
+ WIP.
63
+
64
+ ### Olfactory package
65
+ WIP.
66
+
67
+ ### Overall functionality
68
+ - [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/)).
69
+ - [ ] Interfacing with (neuromorphic) hardware, such as event cameras.
@@ -8,7 +8,7 @@ packages = ["pyrception"]
8
8
  [project]
9
9
  authors = [{ name = "Alexander Hadjiivanov" }]
10
10
  name = "pyrception"
11
- version = "0.2.4"
11
+ version = "0.2.5"
12
12
  requires-python = ">= 3.11"
13
13
  dependencies = [
14
14
  "av",
@@ -29,6 +29,10 @@ dependencies = [
29
29
  "scipy",
30
30
  "tqdm",
31
31
  ]
32
+ dynamic = ["readme"]
33
+
34
+ [tool.setuptools.dynamic]
35
+ readme = {file=["README.md"], content-type="text/markdown"}
32
36
 
33
37
  [project.optional-dependencies]
34
38
  gui = ["pyqtgraph", "PySide6"]
@@ -0,0 +1,110 @@
1
+ Metadata-Version: 2.4
2
+ Name: pyrception
3
+ Version: 0.2.5
4
+ Author: Alexander Hadjiivanov
5
+ Requires-Python: >=3.11
6
+ Description-Content-Type: text/markdown
7
+ License-File: LICENCE.md
8
+ Requires-Dist: av
9
+ Requires-Dist: black
10
+ Requires-Dist: h5py
11
+ Requires-Dist: imageio[ffmpeg]
12
+ Requires-Dist: ipykernel
13
+ Requires-Dist: ipywidgets
14
+ Requires-Dist: loguru
15
+ Requires-Dist: matplotlib
16
+ Requires-Dist: numpy
17
+ Requires-Dist: opencv-python
18
+ Requires-Dist: plotly[express]
19
+ Requires-Dist: pydantic-settings
20
+ Requires-Dist: rich
21
+ Requires-Dist: ruff
22
+ Requires-Dist: scikit-image
23
+ Requires-Dist: scipy
24
+ Requires-Dist: tqdm
25
+ Provides-Extra: gui
26
+ Requires-Dist: pyqtgraph; extra == "gui"
27
+ Requires-Dist: PySide6; extra == "gui"
28
+ Provides-Extra: cli
29
+ Requires-Dist: cloup; extra == "cli"
30
+ Provides-Extra: events
31
+ Requires-Dist: tonic; extra == "events"
32
+ Provides-Extra: dev
33
+ Requires-Dist: py-spy; extra == "dev"
34
+ Provides-Extra: docs
35
+ Requires-Dist: mike; extra == "docs"
36
+ Requires-Dist: mkdocs-jupyter; extra == "docs"
37
+ Requires-Dist: mkdocs-material; extra == "docs"
38
+ Requires-Dist: mkdocs; extra == "docs"
39
+ Requires-Dist: mkdocstrings[python]; extra == "docs"
40
+ Dynamic: license-file
41
+
42
+ [![PyPI - Version](https://img.shields.io/pypi/v/pyrception)](https://pypi.org/project/pyrception/)
43
+ [![Read The Docs](https://readthedocs.org/projects/pyrception/badge/?version=latest)](https://pyrception.readthedocs.io/en/latest/)
44
+
45
+ # Overview
46
+ 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.
47
+
48
+ ## Installation
49
+
50
+ You can install Pyrception from PyPI:
51
+
52
+ ```shell
53
+ pip install pyrception
54
+ ```
55
+
56
+ or directly from GitHub (optionally in development mode):
57
+
58
+ ```shell
59
+ git clone git@github.com:cantordust/pyrception.git
60
+ cd pyrception
61
+ pip install -e .
62
+ ```
63
+
64
+ ## Usage
65
+
66
+ Please refer to the [documentation](#documentation), which contains a [step-by-step notebook](docs/docs/notebooks/image.ipynb) 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.
67
+
68
+ ## Documentation
69
+
70
+ 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:
71
+
72
+ ```shell
73
+ pip install -e .[dev]
74
+ cd docs
75
+ mkdocs build
76
+ ```
77
+
78
+ Then, to view the documentation locally, start the MkDocs server:
79
+
80
+ ```shell
81
+ mkdocs serve
82
+ ```
83
+
84
+ # ToDo
85
+
86
+ ## Short-term
87
+ ### Visual package
88
+ - [X] All major types of retinal cells.
89
+ - [X] Receptors (raw input, Weber's law).
90
+ - [X] Horizontal cells (mean local brightness, normalising feedback).
91
+ - [X] Bipolar cells (positive and negative contrast, temporal filter, excitatory input to ganglion cells).
92
+ - [X] Amacrine cells (inhibitory input to ganglion cells, modulatory signal to bipolar cells).
93
+ - [X] Ganglion cells (spiking).
94
+ - [X] Logpolar kernel arrangement.
95
+ - [X] Uniform or Gaussian kernels.
96
+ - [X] Arbitrary kernel, size, shape and orientation.
97
+ - [ ] Saccadic movements [WIP].
98
+ - [ ] Colour vision (with colour opponency) [WIP].
99
+ - [ ] Temporal dynamics [WIP].
100
+ - [ ] Events as input [WIP].
101
+
102
+ ### Auditory package
103
+ WIP.
104
+
105
+ ### Olfactory package
106
+ WIP.
107
+
108
+ ### Overall functionality
109
+ - [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/)).
110
+ - [ ] Interfacing with (neuromorphic) hardware, such as event cameras.
pyrception-0.2.4/PKG-INFO DELETED
@@ -1,38 +0,0 @@
1
- Metadata-Version: 2.2
2
- Name: pyrception
3
- Version: 0.2.4
4
- Author: Alexander Hadjiivanov
5
- Requires-Python: >=3.11
6
- License-File: LICENCE.md
7
- Requires-Dist: av
8
- Requires-Dist: black
9
- Requires-Dist: h5py
10
- Requires-Dist: imageio[ffmpeg]
11
- Requires-Dist: ipykernel
12
- Requires-Dist: ipywidgets
13
- Requires-Dist: loguru
14
- Requires-Dist: matplotlib
15
- Requires-Dist: numpy
16
- Requires-Dist: opencv-python
17
- Requires-Dist: plotly[express]
18
- Requires-Dist: pydantic-settings
19
- Requires-Dist: rich
20
- Requires-Dist: ruff
21
- Requires-Dist: scikit-image
22
- Requires-Dist: scipy
23
- Requires-Dist: tqdm
24
- Provides-Extra: gui
25
- Requires-Dist: pyqtgraph; extra == "gui"
26
- Requires-Dist: PySide6; extra == "gui"
27
- Provides-Extra: cli
28
- Requires-Dist: cloup; extra == "cli"
29
- Provides-Extra: events
30
- Requires-Dist: tonic; extra == "events"
31
- Provides-Extra: dev
32
- Requires-Dist: py-spy; extra == "dev"
33
- Provides-Extra: docs
34
- Requires-Dist: mike; extra == "docs"
35
- Requires-Dist: mkdocs-jupyter; extra == "docs"
36
- Requires-Dist: mkdocs-material; extra == "docs"
37
- Requires-Dist: mkdocs; extra == "docs"
38
- Requires-Dist: mkdocstrings[python]; extra == "docs"
@@ -1,64 +0,0 @@
1
- # Overview
2
- Pyrception aims to serve as a simulation and conversion framework for different perceptual modalities. Currently, it supports simulation of visual pathways of the mammalian retina, but the goal is to incorporate other modalities as well, 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.
3
-
4
- At this stage, only the visual package is implemented. The auditory and olfactory packages are work in progress. Contributions are welcome in case you would like to help with the implementation of these modalities!
5
-
6
- ## Installation
7
-
8
- You can install Pyrception from PyPI, or directly from GitHub.
9
-
10
- ### PyPI
11
-
12
- ```shell
13
- pip install pyrception
14
- ```
15
-
16
- ### GitHub
17
-
18
- Clone the repository and install it (optionally in in development mode):
19
-
20
- === "HTTPS"
21
-
22
- ``` shell
23
- git clone https://github.com/cantordust/pyrception.git
24
- ```
25
-
26
- === "Git+SSH"
27
-
28
- ``` shell
29
- git clone git@github.com:cantordust/pyrception.git
30
- ```
31
-
32
- ``` shell
33
- cd pyrception
34
- ```
35
- ``` shell
36
- pip install -e .
37
- ```
38
-
39
- ### Documentation
40
-
41
- To generate the documentation, run the MkDocs build pipeline:
42
-
43
- ```shell
44
- mkdocs build
45
- ```
46
-
47
- To view the documentation locally, start the MkDocs server:
48
-
49
- ```shell
50
- mkdocs serve
51
- ```
52
-
53
- # ToDo
54
-
55
- ## Short-term
56
- Visual package:
57
- - [X] Receptor signal scaling following Weber's law.
58
- - [X] Retinal ganglion cells.
59
- - [ ] Saccadic movements (WIP).
60
- - [ ] Colour vision (with colour opponency).
61
- - [ ] Auditory package (WIP).
62
- - [ ] Olfactory package (WIP).
63
- - [ ] Investigate 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/)).
64
- - [ ] Interfacing with neuromorphic hardware.
@@ -1,38 +0,0 @@
1
- Metadata-Version: 2.2
2
- Name: pyrception
3
- Version: 0.2.4
4
- Author: Alexander Hadjiivanov
5
- Requires-Python: >=3.11
6
- License-File: LICENCE.md
7
- Requires-Dist: av
8
- Requires-Dist: black
9
- Requires-Dist: h5py
10
- Requires-Dist: imageio[ffmpeg]
11
- Requires-Dist: ipykernel
12
- Requires-Dist: ipywidgets
13
- Requires-Dist: loguru
14
- Requires-Dist: matplotlib
15
- Requires-Dist: numpy
16
- Requires-Dist: opencv-python
17
- Requires-Dist: plotly[express]
18
- Requires-Dist: pydantic-settings
19
- Requires-Dist: rich
20
- Requires-Dist: ruff
21
- Requires-Dist: scikit-image
22
- Requires-Dist: scipy
23
- Requires-Dist: tqdm
24
- Provides-Extra: gui
25
- Requires-Dist: pyqtgraph; extra == "gui"
26
- Requires-Dist: PySide6; extra == "gui"
27
- Provides-Extra: cli
28
- Requires-Dist: cloup; extra == "cli"
29
- Provides-Extra: events
30
- Requires-Dist: tonic; extra == "events"
31
- Provides-Extra: dev
32
- Requires-Dist: py-spy; extra == "dev"
33
- Provides-Extra: docs
34
- Requires-Dist: mike; extra == "docs"
35
- Requires-Dist: mkdocs-jupyter; extra == "docs"
36
- Requires-Dist: mkdocs-material; extra == "docs"
37
- Requires-Dist: mkdocs; extra == "docs"
38
- Requires-Dist: mkdocstrings[python]; extra == "docs"
File without changes
File without changes