Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
malik727 authored Aug 8, 2023
1 parent 6698ba9 commit 1dc7241
Showing 1 changed file with 8 additions and 8 deletions.
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# NLU Intent Engine for Vehicles
# Snips NLU Intent Engine Model for Vehicles

This project provides dataset and a pre-trained model of NLU Intent Engine for vehicles, allowing users to control various aspects of their vehicle using natural language commands. The NLU Intent Engine is built using the Snips NLU (Natural Language Understanding) engine and is designed to understand and respond to specific intents related to dashboard controls, HVAC settings, media playback, navigation, and volume control.
This project provides a dataset and a pre-trained NLU Intent Engine model for vehicles, allowing users to control various aspects of their vehicle using natural language commands. The NLU Intent Engine is built using the Snips NLU (Natural Language Understanding) engine and is designed to understand and respond to specific intents related to dashboard controls, HVAC settings, media playback, navigation, and volume control.

## Features

Expand Down Expand Up @@ -30,20 +30,20 @@ To train the NLU Intent Engine model, a pre-processing step is required to conve

## Getting Started

To set up the NLU Intent Engine, follow these steps:
To set up the Snips NLU Intent Engine, follow these steps:

1. Clone this repository to your local machine.

2. Install and set up the [`nlu-inference-agl`](https://github.com/malik727/nlu-inference-agl) module on your local machine. This module is an extension of the original Snips NLU with upgraded Python support and is specifically designed for inference purposes only.
2. Install and set up the [`nlu-inference-agl`](https://github.com/malik727/snips-inference-agl) module on your local machine. This module is an extension of the original Snips NLU with upgraded Python support and is specifically designed for inference purposes only.

3. Once you have the [`nlu-inference-agl`](https://github.com/malik727/nlu-inference-agl) module installed, you can load the pre-trained model located in the model/ folder. This model contains the trained data and parameters necessary for intent extraction. You can use the following command to process commands and extract the associated intents:
3. Once you have the [`nlu-inference-agl`](https://github.com/malik727/snips-inference-agl) module installed, you can load the pre-trained model located in the model/ folder. This model contains the trained data and parameters necessary for intent extraction. You can use the following command to process commands and extract the associated intents:
```
$ nlu-inference-agl parse path/to/model -q "your command here"
```
## Usage
Once the NLU Intent Engine is set up and running, you can interact with it by speaking natural language commands related to the supported intents. The NLU Intent Engine will process the commands and perform the requested actions accordingly.
Once the Snips NLU Intent Engine is set up and running, you can interact with it by speaking natural language commands related to the supported intents. The NLU Intent Engine will process the commands and perform the requested actions accordingly.
Here are a few example commands you can try:
Expand All @@ -69,8 +69,8 @@ Then run the following command to re-train the model:
$ nlu-sdk-agl train path/to/dataset.json path/to/model
```
Finally, you can use the [`nlu-inference-agl`](https://github.com/malik727/nlu-inference-agl) module to to process commands and extract the associated intents.
Finally, you can use the [`nlu-inference-agl`](https://github.com/malik727/snips-inference-agl) module to process commands and extract the associated intents.
## Limitations
It's important to note that the NLU Intent Engine's capabilities are limited to the supported intents and entities defined in the dataset. It may not accurately recognize or handle queries outside the defined scope. You can always add more intents and entities to suit your specific requirements.
It's important to note that the NLU Intent Engine's capabilities are limited to the supported intents and entities defined in the dataset. It may not accurately recognize or handle queries outside the defined scope. You can always add more intents and entities to suit your specific requirements.

0 comments on commit 1dc7241

Please sign in to comment.