README.md in convolver-0.0.1 vs README.md in convolver-0.0.2
- old
+ new
@@ -1,14 +1,22 @@
# Convolver
[](http://travis-ci.org/neilslater/convolver)
-Adds an "inner" convolve operation to NArray floats. It is around 250 times faster than equivalents
+Adds a convolve operation to NArray floats. It is around 250 times faster than equivalents
in pure Ruby.
Note that convolves based on FFTW3 could well be faster still for large arrays with large kernels.
+Benchmark tests suggest that the kernel needs to be a few hundred items, and be significantly smaller
+than the signal before FFTW3 offers a significant advantage.
+## Planned features
+
+The *convolver* gem will eventually contain a basic kit for creating, training and running convolutional
+neural networks. As a side effect of this plan, it will also contain efficient code for
+calculating signal convolutions for other types of analysis.
+
## Installation
Add this line to your application's Gemfile:
gem 'convolver'
@@ -30,11 +38,13 @@
c = Convolver.convolve( a, b )
=> NArray.float(2): [ 0.19, 0.27 ]
* Convolver only works on single-precision floats internally. It will cast NArray types to this, if
possible, prior to calculating.
+
* The convolution is an "inner" one. The output is smaller than the input, each dimension is reduced
by 1 less than the width of the kernel in the same dimension.
+
* Convolver expects input a and kernel b to have the same rank, and for the kernel to be same size
or smaller in all dimensions as the input.
## Contributing