Metadata-Version: 2.1
Name: keras-pyramid-pooling-module
Version: 1.1.6
Summary: The Pyramid Pooling Module for Keras.
Home-page: https://github.com/Kautenja/keras-pyramid-pooling-module
Author: Christian Kauten
Author-email: kautencreations@gmail.com
License: MIT
Keywords: Keras Pyramid-Pooling-Module Layer
Platform: UNKNOWN
Classifier: License :: Free For Educational Use
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Description-Content-Type: text/markdown
Requires-Dist: Keras (>=2.4.3)
Requires-Dist: tensorflow (>=2.4.1)

# Keras Pyramid Pooling Module

[![PackageVersion][pypi-version]][pypi-home]
[![PythonVersion][python-version]][python-home]
[![Stable][pypi-status]][pypi-home]
[![Format][pypi-format]][pypi-home]
[![License][pypi-license]](LICENSE)

[pypi-version]: https://badge.fury.io/py/keras-pyramid-pooling-module.svg
[pypi-license]: https://img.shields.io/pypi/l/keras-pyramid-pooling-module.svg
[pypi-status]: https://img.shields.io/pypi/status/keras-pyramid-pooling-module.svg
[pypi-format]: https://img.shields.io/pypi/format/keras-pyramid-pooling-module.svg
[pypi-home]: https://badge.fury.io/py/keras-pyramid-pooling-module
[python-version]: https://img.shields.io/pypi/pyversions/keras-pyramid-pooling-module.svg
[python-home]: https://python.org

A [Keras](https://keras.io) implementation of the Pyramid Pooling Module
discussed in [_Pyramid scene parsing network [1]_](#references).

## Installation

The preferred installation of `keras-pyramid-pooling-module` is from `pip`:

```shell
pip install keras-pyramid-pooling-module
```

## Usage

The module functions as any other convolutional / pooling layer applied to a
rank 4 tensor (batch, height, width, channels):

```python
from keras.layers import Input
from keras.models import Model
from keras_pyramid_pooling_module import PyramidPoolingModule


input_ = Input((224, 224, 3))
x = PyramidPoolingModule()(input_)
model = Model(inputs=input_, outputs=x)
```

See [PyramidPoolingModule.ipynb](PyramidPoolingModule.ipynb) for a rough example
of the layer outputs for a simple RGB image.

See [CIFAR10Classifier.ipynb](CIFAR10Classifier.ipynb) for an example of using
the layer in a model to classify images.

## References

[_[1] H. Zhao, J. Shi, X. Qi, X. Wang, and J. Jia. Pyramid scene parsing network. CVPR, 2017._](https://hszhao.github.io/projects/pspnet/)


