Metadata-Version: 2.1
Name: pyprocessors-q_and_a
Version: 0.5.4
Summary: Processor based on Huggingface transformers Q&A pipeline
Home-page: https://github.com/oterrier/pyprocessors_q_and_a/
Keywords: 
Author: Olivier Terrier
Author-email: olivier.terrier@kairntech.com
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Classifier: Intended Audience :: Information Technology
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Operating System :: OS Independent
Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development
Classifier: License :: OSI Approved :: MIT License
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python :: 3.8
Requires-Dist: pymultirole-plugins>=0.5.0,<0.6.0
Requires-Dist: torch==1.7.1
Requires-Dist: protobuf
Requires-Dist: sentencepiece
Requires-Dist: transformers
Requires-Dist: pandas
Requires-Dist: flit ; extra == "dev"
Requires-Dist: pre-commit ; extra == "dev"
Requires-Dist: bump2version ; extra == "dev"
Requires-Dist: sphinx ; extra == "docs"
Requires-Dist: sphinx-rtd-theme ; extra == "docs"
Requires-Dist: m2r2 ; extra == "docs"
Requires-Dist: sphinxcontrib.apidoc ; extra == "docs"
Requires-Dist: jupyter_sphinx ; extra == "docs"
Requires-Dist: pytest ; extra == "test"
Requires-Dist: pytest-cov ; extra == "test"
Requires-Dist: pytest-flake8 ; extra == "test"
Requires-Dist: pytest-black ; extra == "test"
Requires-Dist: flake8==3.9.2 ; extra == "test"
Requires-Dist: tox ; extra == "test"
Provides-Extra: dev
Provides-Extra: docs
Provides-Extra: test

# pyprocessors_q_and_a

[![license](https://img.shields.io/github/license/oterrier/pyprocessors_q_and_a)](https://github.com/oterrier/pyprocessors_q_and_a/blob/master/LICENSE)
[![tests](https://github.com/oterrier/pyprocessors_q_and_a/workflows/tests/badge.svg)](https://github.com/oterrier/pyprocessors_q_and_a/actions?query=workflow%3Atests)
[![codecov](https://img.shields.io/codecov/c/github/oterrier/pyprocessors_q_and_a)](https://codecov.io/gh/oterrier/pyprocessors_q_and_a)
[![docs](https://img.shields.io/readthedocs/pyprocessors_q_and_a)](https://pyprocessors_q_and_a.readthedocs.io)
[![version](https://img.shields.io/pypi/v/pyprocessors_q_and_a)](https://pypi.org/project/pyprocessors_q_and_a/)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyprocessors_q_and_a)](https://pypi.org/project/pyprocessors_q_and_a/)

Processor based on Facebook's q_and_a

## Installation

You can simply `pip install pyprocessors_q_and_a`.

## Developing

### Pre-requesites

You will need to install `flit` (for building the package) and `tox` (for orchestrating testing and documentation building):

```
python3 -m pip install flit tox
```

Clone the repository:

```
git clone https://github.com/oterrier/pyprocessors_q_and_a
```

### Running the test suite

You can run the full test suite against all supported versions of Python (3.8) with:

```
tox
```

### Building the documentation

You can build the HTML documentation with:

```
tox -e docs
```

The built documentation is available at `docs/_build/index.html.

