# Word Activation Recognition
> tensorflow project - feature: recognition of activation phrases. ( can be useful to wake : LLM and STT inferences )
## Description
`word_activation_recognition` est une bibliothèque Python pour la détection de phrases d'activation audio. Elle peut être utilisée pour réveiller des inférences LLM (modèles de langage large) et STT (reconnaissance vocale).
## Installation
Pour installer la bibliothèque, vous pouvez utiliser pip :
```bash
pip install word_activation_recognition
```
## Usage
Voici un exemple d'utilisation de la bibliothèque :
```python
from word_activation_recognition import AudioClassifier
from word_activation_recognition.activation_defaults import Files_WordRecognition_tflite
def activation_callback():
print('Activation detected')
MODEL_FILE = Files_WordRecognition_tflite.model
LABELS_FILE = Files_WordRecognition_tflite.labels_file
classifier = AudioClassifier(callback_start_assistant=activation_callback, model=MODEL_FILE, labels_file=LABELS_FILE)
classifier.run()
```
## Développement
Pour cloner le dépôt et installer les dépendances pour le développement :
```bash
# Clonez le dépôt
git clone https://github.com/yourusername/word_activation_recognition.git
# Allez dans le répertoire du projet
cd word_activation_recognition
# Installez les dépendances
pip install -r requirements.txt
# Exécutez les tests
pytest
```
## Tests
Les tests unitaires sont situés dans le répertoire `tests`. Pour exécuter les tests, utilisez la commande suivante :
```bash
pytest
```
## Contribuer
Les contributions sont les bienvenues ! Veuillez soumettre une pull request avec une description détaillée des modifications.
## Licence
Ce projet est sous licence MIT. Voir le fichier [LICENSE](./LICENSE) pour plus de détails.
## Auteur
`word_activation_recognition` a été développé par 0x07cb.
## Liens utiles
- [Repository GitHub](https://github.com/yourusername/word_activation_recognition)
Raw data
{
"_id": null,
"home_page": "https://github.com/smartestmanuniverse/word_activation_recognition",
"name": "word-activation-recognition",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": "0x07cb",
"author_email": "83157348+0x07CB@users.noreply.github.com",
"download_url": "https://files.pythonhosted.org/packages/b4/9d/3b572f64f1cdde583992e50efa48ad018c168e8a49a3b51fefb4d481f083/word_activation_recognition-0.1.1.tar.gz",
"platform": null,
"description": "# Word Activation Recognition\n> tensorflow project - feature: recognition of activation phrases. ( can be useful to wake : LLM and STT inferences )\n\n## Description\n\n`word_activation_recognition` est une biblioth\u00e8que Python pour la d\u00e9tection de phrases d'activation audio. Elle peut \u00eatre utilis\u00e9e pour r\u00e9veiller des inf\u00e9rences LLM (mod\u00e8les de langage large) et STT (reconnaissance vocale).\n\n## Installation\n\nPour installer la biblioth\u00e8que, vous pouvez utiliser pip :\n\n```bash\npip install word_activation_recognition\n```\n\n## Usage\n\nVoici un exemple d'utilisation de la biblioth\u00e8que :\n\n```python\nfrom word_activation_recognition import AudioClassifier\nfrom word_activation_recognition.activation_defaults import Files_WordRecognition_tflite\n\ndef activation_callback():\n print('Activation detected')\n\nMODEL_FILE = Files_WordRecognition_tflite.model\nLABELS_FILE = Files_WordRecognition_tflite.labels_file\n\nclassifier = AudioClassifier(callback_start_assistant=activation_callback, model=MODEL_FILE, labels_file=LABELS_FILE)\nclassifier.run()\n```\n\n## D\u00e9veloppement\n\nPour cloner le d\u00e9p\u00f4t et installer les d\u00e9pendances pour le d\u00e9veloppement :\n\n```bash\n# Clonez le d\u00e9p\u00f4t\ngit clone https://github.com/yourusername/word_activation_recognition.git\n\n# Allez dans le r\u00e9pertoire du projet\ncd word_activation_recognition\n\n# Installez les d\u00e9pendances\npip install -r requirements.txt\n\n# Ex\u00e9cutez les tests\npytest\n```\n\n## Tests\n\nLes tests unitaires sont situ\u00e9s dans le r\u00e9pertoire `tests`. Pour ex\u00e9cuter les tests, utilisez la commande suivante :\n\n```bash\npytest\n```\n\n## Contribuer\n\nLes contributions sont les bienvenues ! Veuillez soumettre une pull request avec une description d\u00e9taill\u00e9e des modifications.\n\n## Licence\n\nCe projet est sous licence MIT. Voir le fichier [LICENSE](./LICENSE) pour plus de d\u00e9tails.\n\n## Auteur\n\n`word_activation_recognition` a \u00e9t\u00e9 d\u00e9velopp\u00e9 par 0x07cb.\n\n## Liens utiles\n\n- [Repository GitHub](https://github.com/yourusername/word_activation_recognition)\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A library for audio keyword detection and processing with TensorFlow Lite models",
"version": "0.1.1",
"project_urls": {
"Homepage": "https://github.com/smartestmanuniverse/word_activation_recognition"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f100c743e4f3b191a9c7a4ecb84bd111a0a0347b7ec5d43a6e21894dff5fc12",
"md5": "7bda9e689bafc2b33cf4d14a45a2a689",
"sha256": "b49b40579f0edc3938269b336da1b5e62729702de7a6251d83ef46d8abf07ca2"
},
"downloads": -1,
"filename": "word_activation_recognition-0.1.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7bda9e689bafc2b33cf4d14a45a2a689",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 5346299,
"upload_time": "2024-07-23T11:43:36",
"upload_time_iso_8601": "2024-07-23T11:43:36.365369Z",
"url": "https://files.pythonhosted.org/packages/1f/10/0c743e4f3b191a9c7a4ecb84bd111a0a0347b7ec5d43a6e21894dff5fc12/word_activation_recognition-0.1.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b49d3b572f64f1cdde583992e50efa48ad018c168e8a49a3b51fefb4d481f083",
"md5": "dde9fa863adfe53eb08d8f48463c44ad",
"sha256": "1c29acc984121229a4201b7553ecc17ae5ca994f7452bc35876cef3eefe07050"
},
"downloads": -1,
"filename": "word_activation_recognition-0.1.1.tar.gz",
"has_sig": false,
"md5_digest": "dde9fa863adfe53eb08d8f48463c44ad",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 5346308,
"upload_time": "2024-07-23T11:43:38",
"upload_time_iso_8601": "2024-07-23T11:43:38.678778Z",
"url": "https://files.pythonhosted.org/packages/b4/9d/3b572f64f1cdde583992e50efa48ad018c168e8a49a3b51fefb4d481f083/word_activation_recognition-0.1.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-23 11:43:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "smartestmanuniverse",
"github_project": "word_activation_recognition",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"requirements": [],
"lcname": "word-activation-recognition"
}
JSON
