Skip to main content

🧪 Behavioral tests for NLP models 🧪

Project description

NheLPer

NheLPer is Python package designed to ease behavioral testing of Natural Language Processing models to identify possible capability failures.

1. About the project

Behavioral tests are intended to test a model against some input data while treating as a black box. The aim is to observe the model's reaction against some perturbations that might occur once the model is productionized. For a more detailed explanation on behavioral testing of NLP models I encourage you to read the insightful paper: Beyond Accuracy: Behavioral Testing of NLP models with CheckList

NLPtest provides helper objects for three different aspects:

  • easily generate text samples
  • test some specific behaviors of your model
  • aggregate the tests outcomes of your model

2. Getting started

2.1. Installation

You can directly install NheLPer using pypi:

pip3 install nhelper

2.2. Usage

To help you get the hang of the library we provide three different Notebooks to the user, accessible from the examples/ folder:

  1. Samples_generation.ipynb: shows you how to easily generate texts using the Generator object.
  2. Please_Behave.ipynb: getting familiar with the Behavior object.
  3. End2End_tests.ipynb: how to run tests and get an overview of your model behavior.

References

Below, you can find resources that were used for the creation of NLPtest as well as relevant resources about behavioral testing.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

NheLPer-0.1.0.tar.gz (49.1 kB view details)

Uploaded Source

Built Distribution

NheLPer-0.1.0-py3-none-any.whl (12.7 kB view details)

Uploaded Python 3

File details

Details for the file NheLPer-0.1.0.tar.gz.

File metadata

  • Download URL: NheLPer-0.1.0.tar.gz
  • Upload date:
  • Size: 49.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Darwin/21.4.0

File hashes

Hashes for NheLPer-0.1.0.tar.gz
Algorithm Hash digest
SHA256 92ae854cc78d6d55cc7b4c3d6fa154a844114674f4f8953b43c93d2ddd953bed
MD5 d2015ae63f4f218afe8205b788df05f3
BLAKE2b-256 5131ab96d210e5eac0e54aae164310eb70a4fea800ce57bc95e3675e513a1f5c

See more details on using hashes here.

File details

Details for the file NheLPer-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: NheLPer-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 12.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.9.10 Darwin/21.4.0

File hashes

Hashes for NheLPer-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ef6e39c0b9bb574c105ea889dfb1255babe2df6a8be765474e4be17dc4fb1e39
MD5 c449208f3b0f26ce7040cdbaf9a3c21d
BLAKE2b-256 1d08b3585cf5c8ef07ad7e484465a462d51ce28ec3640fb517a8211bd129a73f

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page