ASL-SIGN-LANGUAGE / README.md
Expanic's picture
Upload folder using huggingface_hub
764e222 verified
|
Raw
History Blame Contribute Delete
2.94 kB
---
title: ASL SIGN LANGUAGE
emoji: 🌍
colorFrom: blue
colorTo: green
sdk: docker
app_port: 7860
---
## Setup using Python virtual environment
First we create the virtual environment and clone the repository into it.
Then, we install all dependencies before running the application.
```sh
python3 -m venv /path/to/venv
cd /path/to/venv
git clone https://github.com/user/name_project
source bin/activate
cd sign-language-detection
python3 -m pip install -r requirements.txt
python3 app.py
```
## Usage
- Click on 'Start' on the homepage to begin sign language detection on your video feed
- Permissions for video feed usage must be set to 'Allow'
- Write letters in American Sign Language to form words or phrases which show up on the console on the right
- Click on 'Play' button below the console to convert your sentences from text-to-speech for seamless communication
- For non-ASL users, you can refer to the English to ASL converter on the homepage
- Follow 'Tips' under console for further instructions
## File Structure
```
.
β”œβ”€β”€ app.py.............................Runs the Flask application and deploys all webpages
β”‚Β Β  as well as calls necessary computational functions
β”œβ”€β”€ datasets...........................Contains tar.gz file of the dataset and
β”‚ some necessary statistics for the dataset
β”œβ”€β”€ LICENSE............................MIT LICENSE
β”œβ”€β”€ models.............................TFLITE version models of MobileNet and EfficientNet
β”‚Β Β  β”œβ”€β”€ model_efficientnet_v2s.tflite
β”‚Β Β  └── model_mobilenet_v2.tflite
β”œβ”€β”€ README.md
β”œβ”€β”€ requirements.txt
β”œβ”€β”€ screenshots........................Contains necessary visualizations about the
β”‚ model performance, data and website
β”œβ”€β”€ static.............................Contains all js, css files and images used in the website
β”‚Β Β  β”œβ”€β”€ connection.js
β”‚Β Β  β”œβ”€β”€ opencv.js
β”‚Β Β  └── style.css
β”œβ”€β”€ templates..........................Contains all HTML templates deployed in the website
β”‚Β Β  β”œβ”€β”€ about.html
β”‚Β Β  β”œβ”€β”€ index.html.....................HTML template of the page where sign detection occurs
β”‚Β Β  β”œβ”€β”€ landing.html
β”‚Β Β  └── layout.html
β”œβ”€β”€ train.py...........................Used to train the entire model, contains all
β”‚ ML techniques mentioned above
β”œβ”€β”€ webcam_detect.py...................Loads the model and predicts the class from the
β”‚ frame input given as softmax probability which is sent
β”‚ back to the client's end
└── webcam.py..........................Used for testing ASL Sign Detection and preiction locally
```