Shams Virtual Assistant

Shams is an Arabic application that allows you to give voice commands to your phone in an Egyptian accent

Table of Contents

• Introduction
  • Why?
  • What is this repository for?
  • Features
  • System Architecture
  • Mobile Architecture
• Getting Started
  • Prerequisites
  • Installation
• Contributing
• Contributors

Introduction

Shams is an open-source Arabic personal assistant mobile application.

Shams do commands when you ask to.

You can talk to Shams in an Egyptian accent and Shams will respond to you.

You can also text Shams and Shams will also respond to you.

Why?

According to the statistics we have collected Arabic and its dialects have little ground in the area of research within Natural Language Processing (NLP). compared to English Even though Arabic is one of the most used languages around the globe.

What is this repository for?

This repository contains the stable release of the following:

• Shams Main server
• Named Entity Recognition (NER) server
• Intent classification training code
• The Android application

Features

• Calendar Management
• Email Management
• Translation
• Contact Management

System Architecture

Mobile Architecture

Getting Started

Prerequisites

Each server has its own prerequisites

1. Shams main Server

   • Python 3.8
   • Python Requirements file

2. Ner server

   • Python 3.6
   • Python Requirements file

3. Intent classification

   Kaggle notebook has all the requirements https://www.kaggle.com/ahmedabdelgawad/arabic-intent-classification

4. Android application

   All the prerequisites in the Gradle file

Installation

Read the doc of each repo to get more information about the installation

Docker Image

• There will be an official docker image in the future

Contributing

If you have an idea for improving Shams, do not hesitate.

Shams needs open source to live, the more data Shams has, the more skillful she becomes.

Contributors

Ahmed Abdelgawad

AbdelRahman Refaat

Ahmed Saad

Hager Osama

Ahmed Essam