Metadata-Version: 2.1
Name: pyspikes
Version: 0.2.2
Summary: Spiking Neural Network Spike Encoders
Home-page: https://github.com/akshaybabloo/Spikes
Author: Akshay Raj Gollahalli
Author-email: akshay@gollahalli.com
License: BSD-3-Clause
Keywords: Spiking Neural Network spike encoder
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering
Requires-Dist: scikit-learn (>=0.17.0)
Requires-Dist: numpy (>=1.10.3)
Requires-Dist: scipy (>=0.17.1)

# Spike Encoders

| Branch | Codecov | CI | Requirements |
|--------|---------|---------------------------------------------------------------------------------------------------------------------------------------|--------------|
| Master | Soon.. | [![Build Status](https://travis-ci.org/akshaybabloo/Spikes.svg?branch=master)](https://travis-ci.org/akshaybabloo/Spikes) | [![Updates](https://pyup.io/repos/github/akshaybabloo/Spikes/shield.svg)](https://pyup.io/repos/github/akshaybabloo/Spikes/) |

Spike encoders for Spiking Neural Network.

This package consists of two types of spike encoders for spatio-temporal data:

1. Threshold Based Representation (TBR) encoder
2. Bens Spiker Algorithm (BSA) encoder

<!-- TOC -->

- [Data](#data)
- [Instillation](#instillation)
- [Example](#example)
- [Contribution](#contribution)
- [Issues](#issues)

<!-- /TOC -->

## Data

The data given to the encoders are spatio-temporal. Each sample is one `csv` file. In each file, every column is a feature and the rows are time points.

For example each file given in the [Data](https://github.com/akshaybabloo/Spikes/tree/master/Data) folder had 128 rows and 14 columns, 14 columns are the features and 128 columns are the data points.

## Instillation

```
python setup.py install
```

## Example

```python
from spikes import encoder
from spikes.utility import ReadCSV

data = ReadCSV('Data').get_samples()['samples']

bsa = encoder.BSA(data)
print(bsa.get_spikes())

tbr = encoder.TBR(data)
print(tbr.get_spikes())
```

## Contribution

All contributions are welcome.

## Issues

Issues can be opened through Github's [Issues](https://github.com/akshaybabloo/Spikes/issues) tab.


