Metadata-Version: 2.1
Name: wild-nlp
Version: 1.0.0
Summary: Text aspects for nlp models
Home-page: https://github.com/MI2DataLab/WildNLP
Author: Dominika Basaj, Barbara Rychalska, Alicja Gosiewska, Adam Słucki
Author-email: adam.slucki@gmail.com
License: BSD
Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Topic :: Text Processing
Classifier: License :: OSI Approved :: BSD License
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: num2words

[![Documentation Status](https://readthedocs.org/projects/nlp-demo/badge/?version=latest)](https://nlp-demo.readthedocs.io/en/latest/?badge=latest)

# wild-nlp
Corrupt an input text to test NLP models' robustness.
For details refer to https://nlp-demo.readthedocs.io

## Installation
`pip install wild-nlp`

## Usage
```python
from wildnlp.aspects import Reverser, PigLatin
from wildnlp.aspects.utils import compose
from wildnlp.datasets import SampleDataset

# Create a dataset object and load the dataset
dataset = SampleDataset()
dataset.load()

# Crate a composed corruptor function.
# Functions will be applied in the same order they appear.
composed = compose(Reverser(), PigLatin())

# Apply the function to the dataset
modified = dataset.apply(composed)
```


