ExplainaBoard Client
This is a command line and API client that makes it easy for you to evaluate systems using ExplainaBoard.
Preparation
Install: First, install the client.
pip install explainaboard_client
Acquiring a Login and API Key: Create an account at the ExplainaBoard site and log in. Once you are logged in, you can click on the upper-right corner of the screen, and it will display your email and API key, which you can copy-paste.
You can save these into environmental variables for convenient use in the commands below:
export EB_USERNAME="[your username]"
export EB_API_KEY="[your API key]"
Use in Python
The most common usage of this client will probably be to evaluate systems on the ExplainaBoard server. Below is an example of how you can do this in Python.
import os
import explainaboard_client
# Set up your environment
explainaboard_client.username = os.environ['EB_USERNAME']
explainaboard_client.api_key = os.environ['EB_API_KEY']
client = explainaboard_client.ExplainaboardClient()
# Do the evaluation
evaluation_result = client.evaluate_system_file(
task='text-classification',
system_name='text-classification-test',
system_output_file='example/data/sst2-lstm-output.txt',
system_output_file_type='text',
dataset='sst2',
split='test',
source_language='en',
)
For more details on precisely how to specify all the variables, as well as how to do other things such as search for and delete systems, see the documentation of the Python API.
Use from the Command Line
You can also evaluate systems from the command line like this.
python -m explainaboard_client.cli.evaluate_system \
--task text-classification \
--system-name text-classification-test \
--system-output-file example/data/sst2-lstm-output.txt \
--system-output-file-type text \
--dataset sst2 \
--split test \
--source-language 'en'
For more details, see the command line documentation.
Having Trouble?
Please open an issue on the issues page and we'll be happy to help!
Metadata
Release files for explainaboard-client 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| explainaboard_client-0.1.4.tar.gz | 18.4 kB | Without provenance | Details for explainaboard_client-0.1.4.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| explainaboard_client-0.1.4-py2.py3-none-any.whl | Python 2, Python 3 | none | any | Details for explainaboard_client-0.1.4-py2.py3-none-any.whl |
Total release size: 44.8 kB
Release files / explainaboard_client-0.1.4.tar.gz
| Download URL | explainaboard_client-0.1.4.tar.gz |
|---|---|
| Size | 18.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
02e2c2fa68a3591937024660d1500bf7ea0f8774b5e910705852da8bedf931b4
|
|
BLAKE2b-256 checksum How to use checksums |
3df42902da1440f89c09b68279eee221a59baa6bd7523a0bcbf66c295f41ed69
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Release files / explainaboard_client-0.1.4-py2.py3-none-any.whl
| Download URL | explainaboard_client-0.1.4-py2.py3-none-any.whl |
|---|---|
| Size | 26.4 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
1b10476252a2eefe622971156e54b48e00381e27f20e850fae88b80ccdfea880
|
|
BLAKE2b-256 checksum How to use checksums |
f7d4ec248d16b7554e772e086ecb0e5b60a93228ca3180401bfd3ca83040e301
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/4.0.2 CPython/3.9.16
|
Security for explainaboard-client 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.