README.md

---
license: mit
---
# do-2021/activator-keyword-detector

This repo is a part of the "dis-cyril" project, a shameless Alexa clone built for a ML engineering course done at [Polytech Montpellier](https://www.polytech.umontpellier.fr/formation/cycle-ingenieur/devops/en-quelques-mots-do).

In this repo you can find a model that reacts to the activator catchphrase "dis-cyril", that enables the voice first app, just like an "Alexa!" would do.

## Setup

### Requirements

- Follow the required setup steps in the [Hugging face docs](https://www.polytech.umontpellier.fr/formation/cycle-ingenieur/devops/en-quelques-mots-do)
- Install pipenv with `pip install pipenv`


### Steps to follow

1. ``git clone https://huggingface.co/do-2021/activator-keyword-detector && cd activator-keyword-detector``
2. `pipenv shell`
3. `pipenv install`
4. `python main.py`