AdonisAI is python library to build your own AI virtual assistant with natural language processing.
Project description
Adonis
- What is Adonis?
- Prerequisite
- Getting Started- How to use it?
- What it can do (Features it supports)
- Future / Request Features
- Contribute
- Connect me
- Donate
1. What is Adonis?
Adonis is a Python Module which is able to perform task like Chatbot, Assistant etc. It provides base functionality for any assistant application. This JarvisAI is built using Tensorflow, Pytorch, Transformers and other opensource libraries and frameworks. Well, you can contribute on this project to make it more powerful.
This project is crated only for those who is having interest in building Virtual Assistant. Generally it took lots of time to write code from scratch to build Virtual Assistant. So, I have build an Library called "Adonis", which gives you easy functionality to build your own Virtual Assistant.
This AI is more powerful and light weight version of https://pypi.org/project/JarvisAI/
2. Prerequisite
-
To use it only Python (> 3.6) is required.
-
To contribute in project: Python is the only prerequisite for basic scripting, Machine Learning and Deep Learning knowledge will help this model to do task like AI-ML. Read How to contribute section of this page.
3. Getting Started- How to use it?
-
Install the latest version-
pip install AdonisAI
It will install all the required package automatically.
-
You need only this piece of code-
# create your own function # RULES (Optional)- # It must contain parameter 'feature_command' (What ever input you provide when AI ask for input will be passed to this function) # Return is optional # If you want to provide return value it should only return text (str) def pprint( feature_command="custom feature (What ever input you provide when AI ask for input will be passed to this function)"): # write your code here to do something with the command # perform some tasks # return is optional return feature_command + ' Executed' obj = AdonisEngine(bot_name='alexa', input_mechanism=InputOutput.speech_to_text_deepspeech_streaming, output_mechanism=[InputOutput.text_output, InputOutput.text_to_speech], backend_tts_api='pyttsx3', wake_word_detection_status=True, wake_word_detection_mechanism=InputOutput.speech_to_text_deepspeech_streaming, shutdown_command='shutdown') # Check existing list of commands, Existing command you can not use while registering your function print(obj.check_registered_command()) # Register your function (Optional) obj.register_feature(feature_obj=pprint, feature_command='custom feature') # Start AI in background. It will always run forever until you don't stop it manually. obj.engine_start()
Whats now?
It will start your AI, it will ask you to give input and accordingly it will produce output. You can configure
input_mechanism
andoutput_mechanism
parameter for voice input/output or text input/output.Parameters-
4. What it can do (Features it supports)-
-
Currently it support only english language
-
Supports voice and text input/output.
-
Supports AI based voice input and by using google api voice input.
4.1. Supported Commands-
4.1. Supported Input/Output Methods (Which option do I need to choose?)-
5. Future/Request Features-
WIP You tell me
6. Contribute-
Guide Coming Soon
7. Connect me-
https://www.instagram.com/dipesh_pal17/
8. Donate-
Feel free to use my code, don't forget to mention credit. All the contributors will get credits in this repo.
Mention below line for credits-
Credits goes to-
https://jarvis-ai-api.herokuapp.com/
https://github.com/Dipeshpal/Jarvis_AI/
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.