Skip to content

Deployment and Instrumentation

To run locally:

git clone https://github.com/KevKibe/African-Whisper.git

Set up Environment Variables

  • Set environment variables using export by running this in the terminal, with the appropriate variables
    export HUGGINGFACE_TOKEN="your_huggingface_token"
    export MODEL_NAME="your_model_name"
    

Run Application

  • Run this command to launch the endpoint:

    make up
    

  • Test it out by accessing the Swagger UI at http://localhost:8000/docs and uploading either an .mp3 file or a .wav file and a task either transcribe or translate.

To deploy to a production environment:

Set up Environment Variables

  1. Set environment variables using export by running this in the terminal, with the appropriate variables:
export HUGGINGFACE_TOKEN="your_huggingface_token"
export MODEL_NAME="your_model_name"
  1. To deploy a docker container running the application and monitoring endpoints.
    make deploy
    
  2. To rebuild the image, before deploying:
    make build
    
  3. To shut down the deployment:
    make down
    
  4. To add custom flags:

    docker-compose -f src/deployment/docker-compose.yaml
    

  5. http://localhost:8000 - Application. /docs for Swagger UI.

  6. http://localhost:3000 - Grafana dashboard.
  7. http://localhost:9090 - Prometheus dashboard