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

If testing Padatious intents, 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

If testing with Padatious, install with the padatious extras:

pip install neon-minerva[padatious]

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.

Chatbot Unit Tests

neon_minerva.chatbots contains mocked data for testing as well as some utility methods. neon_minerva.tests.chatbot_v1_test_base provides TestSubmind which may be extended to test a submind bot in a mocked v1 environment. For example:

from os import environ
from datetime import datetime
from chatbot_core.utils.enum import ConversationState

from neon_minerva.tests.chatbot_v1_test_base import TestSubmind
from neon_minerva.chatbots.test_constants import PROMPT, RESPONSES

environ["TEST_BOT_ENTRYPOINT"] = "tester"


class TestTester(TestSubmind):
    def test_submind_chatbot(self):
        self.submind.state = ConversationState.RESP
        response = self.submind.ask_chatbot("testrunner", PROMPT,
                                            datetime.now().strftime(
                                                "%I:%M:%S %p"))
        self.assertIsInstance(response, str)
        self.assertIsNotNone(response)

Make sure to install the chatbots extra to use this test case

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

Uploaded Source

Built Distribution

neon_minerva-0.1.1a2-py3-none-any.whl (35.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: neon-minerva-0.1.1a2.tar.gz
  • Upload date:
  • Size: 17.1 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.1.1a2.tar.gz
Algorithm Hash digest
SHA256 a4bab84278363bc3619b2702df67234688b4865319c8c1c799e81b14c6279aed
MD5 c88d5204d4272a7620e4249702222713
BLAKE2b-256 afa4c2a2151cec7edf6df26841c246f38558b3113711a2fc38c885c211e87d9b

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for neon_minerva-0.1.1a2-py3-none-any.whl
Algorithm Hash digest
SHA256 0a66ba33c39bedf286556a67841fe70863487eedf42594f3edcea4bfa76f3af3
MD5 5bd1bc6682590236f6c29b896edf6364
BLAKE2b-256 eb55f1eccd7ab47bdf5e61eb1b0a8c73ea224108c8b08e2e2eca0a2f1d92b14a

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