Skip to main content

A library and CLI for NLP tasks

Project description

# bavard-nlu

## Releasing The Package

Releasing the package is automatically handled by CI, but three steps must be taken to trigger a successful release:

  1. Increment the VERSION variable in setup.py to the new desired version (e.g. VERSION=”1.1.1”)

  2. Commit and tag the repo with the exact same value you populated the VERSION variable with (e.g. git tag 1.1.1)

  3. Push the commit and tag to remote. These can be done together using: git push –atomic origin <branch name> <tag>

CI will then release the package to pypi with that version once the commit and tag are pushed.

## Local Development

### Install Dependencies

` pip3 install -e . pip3 install -r requirements-test.txt `

### NLUModel CLI

There is a convenience CLI for training, evaluating, predicting, tuning, and interacting with NLU models. To see the CLI documentation:

` python3 -m bavard_nlu.cli --help `

You can also view the documentation for a sub-command for example:

` python3 -m bavard_nlu.cli train --help `

## Testing Locally

The tests for this repo consist of functional tests for catching bugs/code regressions, and validation tests for catching model performance regressions. The validation tests take much longer to execute. Both are run in CI. To run just the functional tests:

` python3 -m unittest discover test/functional `

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

bavard-nlu-0.0.27.tar.gz (22.1 kB view hashes)

Uploaded Source

Built Distribution

bavard_nlu-0.0.27-py3-none-any.whl (31.3 kB view hashes)

Uploaded Python 3

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