{"id":13800862,"url":"https://github.com/IBM/MAX-speech-to-text-converter","last_synced_at":"2025-05-13T09:31:59.322Z","repository":{"id":37602012,"uuid":"178269980","full_name":"IBM/MAX-Speech-to-Text-Converter","owner":"IBM","description":"Converts spoken words into text form.","archived":false,"fork":false,"pushed_at":"2024-02-11T04:27:22.000Z","size":1795,"stargazers_count":76,"open_issues_count":7,"forks_count":32,"subscribers_count":23,"default_branch":"master","last_synced_at":"2025-05-07T05:42:15.701Z","etag":null,"topics":["ai","codait","docker-image","ibm","machine-learning","natural-language-processing","speech-recognition","speech-to-text"],"latest_commit_sha":null,"homepage":"https://developer.ibm.com/exchanges/models/all/max-speech-to-text-converter/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/IBM.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-03-28T19:33:56.000Z","updated_at":"2024-08-21T23:55:35.000Z","dependencies_parsed_at":"2024-01-05T20:57:19.351Z","dependency_job_id":"f3769e65-a00c-4987-8318-775e9626c158","html_url":"https://github.com/IBM/MAX-Speech-to-Text-Converter","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM%2FMAX-Speech-to-Text-Converter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM%2FMAX-Speech-to-Text-Converter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM%2FMAX-Speech-to-Text-Converter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/IBM%2FMAX-Speech-to-Text-Converter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/IBM","download_url":"https://codeload.github.com/IBM/MAX-Speech-to-Text-Converter/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":253913248,"owners_count":21983287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","codait","docker-image","ibm","machine-learning","natural-language-processing","speech-recognition","speech-to-text"],"created_at":"2024-08-04T00:01:17.067Z","updated_at":"2025-05-13T09:31:56.834Z","avatar_url":"https://github.com/IBM.png","language":"Python","funding_links":[],"categories":["Data \u0026 AI"],"sub_categories":[],"readme":"[![Build Status](https://travis-ci.com/IBM/MAX-Speech-To-Text-Converter.svg?branch=master)](https://travis-ci.com/IBM/MAX-Speech-To-Text-Converter)\n[![Website Status](https://img.shields.io/website/http/max-speech-to-text-converter.codait-prod-41208c73af8fca213512856c7a09db52-0000.us-east.containers.appdomain.cloud/swagger.json.svg?label=api+demo)](http://max-speech-to-text-converter.codait-prod-41208c73af8fca213512856c7a09db52-0000.us-east.containers.appdomain.cloud)\n\n[\u003cimg src=\"docs/deploy-max-to-ibm-cloud-with-kubernetes-button.png\" width=\"400px\"\u003e](http://ibm.biz/max-to-ibm-cloud-tutorial) \n\n# IBM Developer Model Asset Exchange: Speech to Text Converter\n\nThis repository contains code to instantiate and deploy a speech recognition model. The model takes a short (~5 second),\nsingle channel `WAV` file containing English language speech as an input and returns a string containing the predicted\nspeech.\n\nThe model expects 16kHz audio, but will resample the input if it is not already 16kHz. Note this will likely negatively\nimpact the accuracy of the model.\n\nThe code for this model comes from Mozilla's [Project DeepSpeech](https://github.com/mozilla/DeepSpeech) and is based\non [Baidu's Deep Speech research paper](https://arxiv.org/abs/1412.5567).\n\n\nThe model files are hosted on\n[IBM Cloud Object Storage](https://max-cdn.cdn.appdomain.cloud/max-speech-to-text-converter/1.0.0/assets.tar.gz).\nThe code in this repository deploys the model as a web service in a Docker container. This repository was developed as\n[IBM Code Model Asset Exchange](https://developer.ibm.com/code/exchanges/models/) and the public API is powered by\n[IBM Cloud](https://ibm.biz/Bdz2XM).\n\n## Model Metadata\n| Domain | Application | Industry  | Framework | Training Data | Input Data Format |\n| ------------- | --------  | -------- | --------- | --------- | -------------- | \n| Audio | Speech Recognition | General | TensorFlow | Mozilla Common Voice | Audio (16 bit, 16 kHz, mono WAV file)| \n\n## References\n\n* _Awni Hannun, Carl Case, Jared Casper, Bryan Catanzaro, Greg Diamos, Erich Elsen, Ryan Prenger, Sanjeev Satheesh, Shubho Sengupta, Adam Coates, Andrew Y. Ng_, [\"Deep Speech: Scaling up end-to-end speech recognition\"](https://arxiv.org/abs/1412.5567), arXiv:1412.5567\n* [Mozilla DeepSpeech](https://github.com/mozilla/DeepSpeech)\n\n## Licenses\n\n| Component | License | Link  |\n| ------------- | --------  | -------- |\n| This repository | [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) | [LICENSE](LICENSE) |\n| Model Weights | [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/) | [Mozilla DeepSpeech](https://github.com/mozilla/DeepSpeech#getting-the-pre-trained-model)|\n| Model Code (3rd party) | [Mozilla Public License 2.0](https://www.mozilla.org/en-US/MPL/2.0/) | [DeepSpeech LICENSE](https://github.com/mozilla/DeepSpeech/blob/master/LICENSE)|\n| Test Samples | Various | [Asset README](samples/README.md) |\n\n## Pre-requisites:\n\n* `docker`: The [Docker](https://www.docker.com/) command-line interface. Follow the [installation instructions](https://docs.docker.com/install/) for your system.\n* The minimum recommended resources for this model is 2GB Memory and 2 CPUs.\n* If you are on x86-64/AMD64, your CPU must support [AVX](https://en.wikipedia.org/wiki/Advanced_Vector_Extensions) at the minimum.\n\n# Deployment options\n\n* [Deploy from Quay](#deploy-from-quay)\n* [Deploy on Red Hat OpenShift](#deploy-on-red-hat-openshift)\n* [Deploy on Kubernetes](#deploy-on-kubernetes)\n* [Run Locally](#run-locally)\n\n## Deploy from Quay\n\nTo run the docker image, which automatically starts the model serving API, run:\n\n```\n$ docker run -it -p 5000:5000 quay.io/codait/max-speech-to-text-converter\n```\n\nThis will pull a pre-built image from the Quay.io container registry (or use an existing image if already cached locally) and run it.\nIf you'd rather checkout and build the model locally you can follow the [run locally](#run-locally) steps below.\n\n## Deploy on Red Hat OpenShift\n\nYou can deploy the model-serving microservice on Red Hat OpenShift by following the instructions for the OpenShift web console or the OpenShift Container Platform CLI [in this tutorial](https://developer.ibm.com/tutorials/deploy-a-model-asset-exchange-microservice-on-red-hat-openshift/), specifying `quay.io/codait/max-speech-to-text-converter` as the image name.\n\n## Deploy on Kubernetes\n\nYou can also deploy the model on Kubernetes using the latest docker image on Quay.\n\nOn your Kubernetes cluster, run the following commands:\n\n```\n$ kubectl apply -f https://raw.githubusercontent.com/IBM/max-speech-to-text-converter/master/max-speech-to-text-converter.yaml\n```\n\nThe model will be available internally at port `5000`, but can also be accessed externally through the `NodePort`.\n\n## Run Locally\n\n1. [Build the Model](#1-build-the-model)\n2. [Deploy the Model](#2-deploy-the-model)\n3. [Use the Model](#3-use-the-model)\n4. [Development](#4-development)\n5. [Cleanup](#5-cleanup)\n\n### 1. Build the Model\n\nClone this repository locally. In a terminal, run the following command:\n\n```\n$ git clone https://github.com/IBM/max-speech-to-text-converter.git\n```\n\nChange directory into the repository base folder:\n\n```\n$ cd max-speech-to-text-converter\n```\n\nTo build the docker image locally, run: \n\n```\n$ docker build -t max-speech-to-text-converter .\n```\n\nAll required model assets will be downloaded during the build process. _Note_ that currently this docker image is CPU\nonly (we will add support for GPU images later).\n\n\n### 2. Deploy the Model\n\nTo run the docker image, which automatically starts the model serving API, run:\n\n```\n$ docker run -it -p 5000:5000 max-speech-to-text-converter\n```\n\n### 3. Use the Model\n\nThe API server automatically generates an interactive Swagger documentation page. Go to `http://localhost:5000` to load\nit. From there you can explore the API and also create test requests.\n\nUse the `model/predict` endpoint to load a test audio file (you can use one of the test audio files from the `samples`\nfolder) and get predicted text from the API.\n\n![Swagger Doc Screenshot](docs/swagger-screenshot.png)\n\nYou can also test it on the command line, for example:\n\n```bash\n$ curl -F \"audio=@samples/8455-210777-0068.wav\" -X POST http://localhost:5000/model/predict\n```\n\nYou should see a JSON response like that below:\n\n```json\n{\"status\": \"ok\", \"prediction\": \"your power is sufficient i said\"}\n```\n\n### 4. Development\n\nTo run the Flask API app in debug mode, edit `config.py` to set `DEBUG = True` under the application settings. You will\nthen need to rebuild the docker image (see [step 1](#1-build-the-model)).\n\n### 5. Cleanup\n\nTo stop the Docker container, type `CTRL` + `C` in your terminal.\n\n## Resources and Contributions\n   \nIf you are interested in contributing to the Model Asset Exchange project or have any queries, please follow the instructions [here](https://github.com/CODAIT/max-central-repo).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIBM%2FMAX-speech-to-text-converter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FIBM%2FMAX-speech-to-text-converter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FIBM%2FMAX-speech-to-text-converter/lists"}