---------------
:loudspeaker: Overview
---------------
We are very excited to release John Snow Labs' latest library: [NLP Test](http://nlptest.org/)! :rocket: This is our first major step towards building responsible AI.
NLP Test is an open-source library for testing NLP models and datasets from all major NLP libraries in a few lines of code. :test_tube: The library has 1 goal: delivering safe & effective models into production. :dart:
Make sure to give the project a star [right here](https://github.com/JohnSnowLabs/nlptest) :star:
----------------
:fire: Features
----------------
- Generate & run over 50 test types in a few lines of code :computer:
- Test all aspects of model quality: robustness, bias, representation, fairness and accuracy
- Automatically augment training data based on test results :muscle:
- Support for popular NLP libraries: Spark NLP, Hugging Face Transformers & spaCy
- Support for popular NLP tasks: Named Entity Recognition and Text Classification :tada:
----------------
:question: How to Use
----------------
Get started now! :point_down:
pip install nlptest
Create your test harness in 3 lines of code :test_tube:
Import and create a Harness object
from nlptest import Harness
h = Harness(task='ner', model='dslim/bert-base-NER', hub='transformers')
Generate test cases, run them and view a report
h.generate().run().report()
----------------
:book: Documentation
----------------
* [NLP Test: Documentation](https://nlptest.org/docs/pages/docs/install)
* [NLP Test: Notebooks](https://nlptest.org/docs/pages/tutorials/tutorials)
* [NLP Test: Test Types](https://nlptest.org/docs/pages/tests/test)
* [NLP Test: GitHub Repo](https://github.com/JohnSnowLabs/nlptest)
----------------
:heart: Community support
----------------
- [Slack](https://www.johnsnowlabs.com/slack-redirect/) For live discussion with the NLP Test community, join the `#nlptest` channel
- [GitHub](https://github.com/JohnSnowLabs/nlptest/tree/main) For bug reports, feature requests, and contributions
- [Discussions](https://github.com/JohnSnowLabs/nlptest/discussions) To engage with other community members, share ideas, and show off how you use NLP Test!
We would love to have you join the mission :point_right: open an issue, a PR, or give us some feedback on features you'd like to see! :raised_hands:
-------------------
:rocket: Mission
-------------------
While there is a lot of talk about the need to train AI models that are safe, robust, and fair - few tools have been made available to data scientists to meet these goals. As a result, the front line of NLP models in production systems reflects a sorry state of affairs.
We propose here an early stage open-source community project that aims to fill this gap, and would love for you to join us on this mission. We aim to build on the foundation laid by previous research such as [Ribeiro et al. (2020)](https://arxiv.org/abs/2005.04118), [Song et al. (2020)](https://arxiv.org/abs/2004.00053), [Parrish et al. (2021)](https://arxiv.org/abs/2110.08193), [van Aken et al. (2021)](https://arxiv.org/abs/2111.15512) and many others.
[John Snow Labs](www.johnsnowlabs.com) has a full development team allocated to the project and is committed to improving the library for years, as we do with other open-source libraries. Expect frequent releases with new test types, tasks, languages, and platforms to be added regularly. We look forward to working together to make safe, reliable, and responsible NLP an everyday reality.