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.2a2.tar.gz (13.7 kB view details)

Uploaded Source

Built Distribution

neon_minerva-0.0.2a2-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for neon-minerva-0.0.2a2.tar.gz
Algorithm Hash digest
SHA256 1304605454a324a0814bbb59edd22e67c64f2ca1fbc9de50060f5b2446aed06d
MD5 cc8efc91eed20720e1f3ef5fbd34a1af
BLAKE2b-256 368f3490813e0ecfdebd6aef0256b87f89b2587650b6cf3b67dc0e12c88e86e4

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for neon_minerva-0.0.2a2-py3-none-any.whl
Algorithm Hash digest
SHA256 30ed1cfc7cc759b3c1173988a559ff6d69cb72bccbde9933c9a384e3536e940a
MD5 3812a8cbbb76c62d3e9fee2ef4636e28
BLAKE2b-256 349cb1666630c09dd01a188a733bbd82aa1c6675435024ef5f09d81592625a9e

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