Nala is an agile open-source voice assistant framework to improve the workflow of your daily life.
Nala uses actions which can be triggered by user voice queries. All the user needs to do is say 'hey nala' and it will spark Nala to listen and respond to requests - like getting the weather or the news.
And yes, her name is inspired after Nala from the Lion King :-)
It's super easy to setup Nala. All you need to do is:
git clone git@github.com:jim-schwoebel/nala.git
cd nala
python3 -m venv env
source env/bin/activate
python3 setup.py
python3 nala.py
You will then be asked to register with your name, email, and a few other registration tasks.
After that, you're ready to begin using Nala!
To active Nala, all you need to do is query her with 'Hey Nala!' (1) - which then triggers a response from Nala - (3) in this case, “How can I help you?.” Then, a user provides another query (usually after some beeping sound) - such as (4) “I’d like the weather.” Nala transcribes this query to understand it, and parses the query for keyword intents; for example, if the response is “I’d like the weather” the only word that really matters is “weather” and that would be used to provoke a response (5). Then, after this keyword maps onto an action dictionary (or a map of responses to keywords), the action is executed (6). Then, the intent loop repeats itself, looking for another wakeword (“Hey Nala”) before triggering another action.
Nala is equipped with multi-query capability. All you need to do is add 'AND' into your query and she'll automatically execute actions serially that you request to her.
For example, you may say, "Hey Nala" --> "close spotify and sleep"
She will then close spotify and then go to sleep for 30 minutes.
This makes Nala incredibly versatile to do multiple things quickly and is an advantage over other chatbot systems.
Here are some actions that Nala can currently do along with the query intents needed to activate them. If you have any other ideas, let us know on the github issues tab (as an enhancement)!
| Action | Description | Example query intent |
|---|---|---|
| ⏰ alarm.py | Plays an alarm sound (e.g. to wake up in morning) based on the time of day you specified during user registration. | “set alarm”, “stop alarm” |
| 🎵 chillout.py | Plays music in the background to help you calm down. | “chill out” |
| 🏟️ espn.py | Scrapes ESPN website to find any events going on later tonight. This is a work-in-progress. | “get sports” |
| 🎴 events.py | Scrape meetup.com for events in your local area. | “find events” |
| 📜 generate_poem.py | Generate a poem based on the generate poetry script we wrote a while back. | “make a poem” |
| 📝 grateful.py | Helps you keep a gratitude journal by recording a sample of what you’re grateful for today. | “be grateful” |
| Plays back a joke from the database. | “make a joke” | |
| 🌅 meditation.py | Guides you through a simple 60 second meditation. | “meditate” |
| 🎧 music.py | YouTube music links - based on a genre. | “play music” |
| 📰 news.py | searches some basic news sites related to computer science and machine learning (e.g. Hacker News). | “grab the news” |
| 🍐 nutrition.py | Searches for some healthy food nearby | “be healthy” |
| Schedules a trip in terms of AirBnB suggestions and flights | “plan trip” | |
| ↪️ reboot.py | Restarts the computer. | “restart” |
| 🔍 search.py | search bing with a query. | First query: “search”, Second query: [search term] |
| ⌛ shutdown.py | Shuts down the computer. | “shut down” |
| 😴 sleep | Puts the computer to sleep for a designated time period. | "go to sleep" |
| 👥 social.py | Alternative script to give you some suggestions based on your budget to go out later. | "be social" |
| 🌡️ weather.py | Searches weather.com for the current weather at your location. | "get the weather" |
| ☕🍦🎉🍺 yelp.py | Based on the query, searches yelp for coffee, restaurants, food, nightlife, ice cream, or bars. | "get me coffee", "get me some food", "nightlife", "get ice cream", "grab beer" |
| 📂open program | GitHub, Facebook, LinkedIn, Twitter, Spotify, Sublime, Atom | "open github", "open facebook", "open linkedin", "open twitter", "open spotify", "open sublime", "open atom" |
| 📴close program | Close a Spotify session. | "close spotify", "stop spotify" |
| 🎙️Record audio | record a stream of audio for a designated time period and save to desktop | "record audio" |
| 📹Record video | Open up zoom meeting link to record a video session. | "record video" |
... more to come into the future!
Here are some other projects that have used the Nala Framework:
- Greta - 👧 Greta is an agile voice assistant to help reduce your carbon footprint.
Any feedback this repository is greatly appreciated.
- If you find something that is missing or doesn't work, please consider opening a GitHub issue.
- If you want to learn more about voice computing, check out Voice Computing in Python book.
- If you are looking for a framework to start building machine learning models in voice computing, check out Allie.
- If you'd like to be mentored by someone on our team, check out the Innovation Fellows Program.
- If you want to talk to me directly, please send me an email @ js@neurolex.co.
This repository is licensed under the Apache 2.0 License.
If you need anything else, check out the wiki.
If you're looking for a place to start to learn how to code voice computing, Nala has some great documentation in Chapter 7 of the Voicebook repository.
Here are some other modules and things you could look into for further guidance: