Metadata-Version: 2.4
Name: voice-speak-up
Version: 1.0.1
Summary: A seamless 3-step pipeline to add voice-controlled support to many fields.
Author-email: NLPBros <brainsparkteam@gmail.com>
Project-URL: Homepage, https://github.com/Brainspark1/speak_up.git
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Requires-Python: >=3.7
Description-Content-Type: text/markdown
Requires-Dist: numpy
Requires-Dist: opencv_python
Requires-Dist: pandas
Requires-Dist: scikit-learn
Requires-Dist: SpeechRecognition
Requires-Dist: mlx_whisper
Requires-Dist: torch
Requires-Dist: transformers
Requires-Dist: evaluate
Requires-Dist: datasets
Requires-Dist: faster_whisper
Requires-Dist: stable_retro
Requires-Dist: pygame

# Speak Up

## Description
speak_up is a Python library targeted towards developers with the purpose of granting them the ability to more seamlessly integrate Voice-Controlled User Interfaces (VUIs) into their existing Graphical User Interface (GUI).

The library aims to provide a robust pipeline that allows users to utilize GAMEBERT, a BERT machine learning model trained on highly generic video game commands and terminology following the generic formula, “character, do action on target with item,” enabling developers to only be required to pass in single JSON file specifying RAM addresses for each character, action, item and target in a game to each existing element. 

We have also included a correction classification layer within GAMEBERT that devs can utilize if needed for their VUI.

To install and get started with speak_up, simply run in terminal:

```bash
pip install voice-speak-up
```

#### Library Link: [https://pypi.org/project/voice-speak-up/](https://pypi.org/project/voice-speak-up/)
#### Model Link: [Saggarwal/GAMEBERT](https://huggingface.co/Saggarwal/GAMEBERT)

## Contributors
- Nihaal Garud
- Sarthak Aggarwal
- Joshua Lopez
- Harshad Goswami

#### Sources Used: [https://docs.google.com/document/d/1cd7PCkatlefb_9DGq6SDzNG8A8YLyz7AKGU2WP7HmGI/edit?tab=t.0](https://docs.google.com/document/d/1cd7PCkatlefb_9DGq6SDzNG8A8YLyz7AKGU2WP7HmGI/edit?usp=sharing)
