nlpsandbox-client

nlpsandboxclient is a set of tools and commands that provides an interface for NLP sandbox data node, annotation services, and evaluation of annotation results. This repository consists of 3 packages:

• nlpsandbox: Python SDK client that wraps all the NLP Sandbox APIs

• nlpsandboxclient: - Convenience functions that infer user behavior of the SDK client.

Installation

To install from pypi:

$ pip install nlpsandbox-client

To install from the source:

$ python setup.py install

Configuration

This client interfaces with the data-node or annotators such as date-annotator-example. There are two main ways of running this code, and each way has its preferred method of setting Synapse credentials.

1. Local Python Installation: Please learn more about Synapse client configuration.

nlp-cli --version

2. Docker: The client will read environmental variables for your Synapse credentials.

   1. Create the file that contains the future environment variables

   cp .env.sample .env
   

   2. Update the configuration values in .env. Set the values of SYNAPSE_AUTH_TOKEN to be your Synapse personal access token.

   3. Run docker command

   docker run --rm --env-file .env nlpsandbox/cli
   

Contributing

Interested in contributing? Awesome! We follow the typical GitHub workflow of forking a repo, creating a branch, and opening pull requests. For more information on how you can add or propose a change, visit our contributing guide.

Python Client

• nlpsandboxclient

Command-Line Client

• nlp-cli
  • nlp-cli community
  • nlp-cli datanode
  • nlp-cli tool

About

• Changelog
• Authors