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

Uploaded Source

Built Distribution

neon_minerva-0.0.2a3-py3-none-any.whl (35.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neon-minerva-0.0.2a3.tar.gz
  • Upload date:
  • Size: 16.2 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.2a3.tar.gz
Algorithm Hash digest
SHA256 eb54a42a8b76a2d1c7431a22327faedad3f1ee317a023362661e67f6d800feee
MD5 2c759fa28d6228928ab8d609b5fc2927
BLAKE2b-256 18742f14ebd63b74f5b6c2dd33b1289789fe13669586a1d5aebd62ea102c3062

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for neon_minerva-0.0.2a3-py3-none-any.whl
Algorithm Hash digest
SHA256 c984586589a68fc4b3b11f938459b0ac404ed810cd263174e6b308c8841010f9
MD5 0150a6e380286893e80979037135d938
BLAKE2b-256 78b013e7361f4832d7415fb3bc49875f0705d12934710a6ce4c9140ab6732417

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