Skip to content

This plugin allows Naomi to use the Mycroft Padatious intent parser for text to intent

License

Notifications You must be signed in to change notification settings

NaomiProject/naomi-plugin-padatious-tti

Repository files navigation

id label title type description logo source meta
padatious-tti
Padatious TTI
Padatious TTI - Text to Intent
ttis
Allows the Padatious Text to Intent module to be used with Naomi
images/plugins/
property content
og:title
Padatious TTI - Text to Intent
property content
og:description
Allows the Padatious Text to Intent module to be used with Naomi

Padatious TTI - Text to Intent

To install a plugin in Naomi, you can follow the instructions below.

Padatious TTI Plugin for Naomi

Overview

The Padatious TTI Plugin is a powerful natural language understanding (NLU) component designed for the Naomi platform. It uses the Padatious intent recognition engine to interpret spoken language commands and map them to intents. This plugin enhances Naomi’s ability to process user input using a trained neural network model, enabling highly accurate intent classification.

The plugin’s primary function is to analyze user speech, identify intents through text-to-intent (TTI) recognition, and return relevant actions based on predefined intent sets. This makes it an integral part of voice-controlled applications, allowing Naomi to become a more intelligent and adaptive voice assistant.

Key Features

  • Efficient Intent Recognition: Leverages Padatious, a neural network-based intent recognition engine, to understand user commands and associate them with the appropriate responses or actions.
  • Training and Customization: Supports training new intents from user input, making it flexible to adapt to different use cases and commands.
  • Seamless Integration: Fully compatible with the Naomi platform, allowing easy integration into existing voice-controlled setups.
  • Multilingual Support: Offers the ability to support multiple languages depending on the training data provided.
  • Lightweight and Fast: Designed to run efficiently even on low-resource devices while maintaining high accuracy for intent classification.

Requirements

APT Requirements:

  • libfann-dev
  • python3-dev
  • python3-pip
  • swig
  • libfann-dev
  • python3-fann2

Python Requirements:

  • padatious

These dependencies ensure that the necessary libraries and tools for neural network training and intent recognition are properly set up.

Installation

  1. Clone the Repository: Clone the padatious TTI plugin repository from GitHub:

    git clone https://github.com/NaomiProject/naomi-plugin-padatious-tti.git
  2. Install Required Dependencies: Install the necessary packages by running:

    sudo apt-get install libfann-dev python3-dev python3-pip swig libfann-dev python3-fann2
    pip install padatious
  3. Add to Naomi Configuration: Once installed, configure the plugin within the Naomi framework by updating the plugin directory with the path to the padatious-tti plugin.

Plugin Installation in Naomi

To install a plugin, what you would do is use a command like:

$ Naomi --list-available-plugins

This will give you a list of available plugins, for example:

Available Plugins:
Announcements (notificationclient [1.0.0 installed]) - Naomi makes announcements at scheduled times.
Archive Audiolog (stt_trainer [1.0.0]) - Allows the user to export their audiolog database and audio files into an archive file that can be merged into a different Naomi using the Import Audiolog plugin.
...
Padatious TTI (tti [1.0.0]) - Text-to-intent processing using Padatious.

Then use a command like:

$ Naomi --install "Padatious TTI"

to actually install the plugin.

Usage

To use this plugin, either use Naomi --repopulate to run the wizard and select this Text to Intent engine, or edit the profile.yml file file directly:

tti_engine: Padatious TTI

Contributing

Contributions are welcome! If you would like to contribute to the development of this plugin, feel free to open a pull request on GitHub. Ensure that your code follows the project’s guidelines and includes appropriate test cases.

  1. Fork the repository.
  2. Create a new branch for your feature or bugfix.
  3. Add your changes, and ensure all tests pass.
  4. Open a pull request with a clear description of your changes.

License

This plugin is licensed under the MIT License. See the LICENSE file for more details.

Example Usage in Naomi

Once installed and configured, the Padatious TTI Plugin enables Naomi to recognize natural language commands. For instance, when a user says:

  • User: “Turn on the lights.”
  • Naomi: Recognizes the ‘turn on lights’ intent and sends a signal to the connected home automation system to turn on the lights.

This plugin plays a crucial role in making Naomi’s interactions more natural and intuitive for users, whether it’s for smart home control, entertainment systems, or general voice-command tasks.

This detailed description includes the process of listing available plugins and installing the Padatious TTI plugin within Naomi.

About

This plugin allows Naomi to use the Mycroft Padatious intent parser for text to intent

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages