Skip to main content

Modular INtelligent Evaluation for a Reliable Voice Assistant

Project description

Neon Minerva

Neon Minerva (Modular INtelligent Evaluation for a Reliable Voice Assistant) provides tools for testing skills.

Install the Minerva Python package with: pip install neon-minerva The minerva entrypoint is available to interact with a bus via CLI. Help is available via minerva --help.

Installation

Since skill intents may use Padatious, the following system packages must be installed before installing this package:

sudo apt install swig libfann-dev

To install this package from PyPI, simply run:

pip install neon-minerva

Usage

This package provides a CLI for local testing of skills. Skills installed with pip can be specified by entrypoint, or skills cloned locally can be specified by root directory.

Resource Tests

To test that skill resources are defined for all supported languages, minerva test-resources <skill-entrypoint> <test-file>

  • <skill-entrypoint> is the string entrypoint for the skill to test as specified in setup.py OR the path to the skill's root directory
  • <test-file> is a relative or absolute path to the resource test file, usually test_resources.yaml

Intent Tests

To test that skill intents match as expected for all supported languages, minerva test-intents <skill-entrypoint> <test-file>

  • <skill-entrypoint> is the string entrypoint for the skill to test as specified in setup.py OR the path to the skill's root directory
  • <test-file> is a relative or absolute path to the resource test file, usually test_intents.yaml
  • The --padacioso flag can be added to test with Padacioso instead of Padatious for relevant intents

Advanced Usage

In addition to convenient CLI methods, this package also provides test cases that may be extended.

Skill Unit Tests

neon_minerva.tests.skill_unit_test_base provides SkillTestCase, a class that supplies boilerplate setup/teardown/mocking for testing a skill. An example skill test implementation could look like:

from os import environ
from neon_minerva.tests.skill_unit_test_base import SkillTestCase

environ['TEST_SKILL_ENTRYPOINT'] = "my_skill.test"

class MySkillTest(SkillTestCase):
    def test_skill_init(self):
        self.assertEqual(self.skill.skill_id, "my_skill.test")
    ...

Be sure to review the base class for mocked methods and test paths as these may change in the future.

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

neon-minerva-0.0.2a4.tar.gz (16.2 kB view details)

Uploaded Source

Built Distribution

neon_minerva-0.0.2a4-py3-none-any.whl (35.1 kB view details)

Uploaded Python 3

File details

Details for the file neon-minerva-0.0.2a4.tar.gz.

File metadata

  • Download URL: neon-minerva-0.0.2a4.tar.gz
  • Upload date:
  • Size: 16.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.7

File hashes

Hashes for neon-minerva-0.0.2a4.tar.gz
Algorithm Hash digest
SHA256 cd86ce184c3d6816762df214174dbc4e34da76c1803141ce7b70f23120613efa
MD5 8237c6f95228ab54d9e9f930f490c6b2
BLAKE2b-256 98b621b632e8a90151465ef5b8ef85089c1dd3e15b2ac1394159b58c4372382c

See more details on using hashes here.

File details

Details for the file neon_minerva-0.0.2a4-py3-none-any.whl.

File metadata

File hashes

Hashes for neon_minerva-0.0.2a4-py3-none-any.whl
Algorithm Hash digest
SHA256 9d5cb5e7af2a2e9573180c42d53f3d248595c2201c41f202f4becccb81ea3d5d
MD5 30745ef54ac056f5c881266fee9ab9e9
BLAKE2b-256 e2bcc053515e254f9aaca70bddddd766befcde07daad4aa8303a2fb9869f03b8

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