The goal of this project is to provide a system that runs entirely locally for speaker recognition and speech transcription.
- Adam Strom
- Aidan Horan
- Hannah Berthiaume
- Parker Rowe
|
├── /backend
| └── any files responsible for running our python flask backend server
|
├── /saved_models
| └── trained models -- NOTE: git does not track the models to save on storage space
|
├── /scripts
| └── shell scripts that are useful to us
|
├── /testing
| └── for experimenting with our models
|
├── /training
| |
│ |── /testing_data // any files used to test the model (audio data that the model has never seen before)
│ | └── *
| |
│ |── /training_data_wav // .wav files organized into folders
│ | |── /{class_name1}
│ | | |── {audio1.wav}
│ | | |── ....
│ | | └── {audioX.wav}
│ | |── ....
│ | └── /{class_nameX}
| |
| └── any files used for training our model using tensorflow
|
├── /ui
| └── a SvelteKit-based web GUI for interacting with our voice transcription system
|
├── /whisper.cpp
| └── a git submodule containing a high performance fork of OpenAI's whisper model (see https://github.com/ggerganov/whisper.cpp)
|
├── .gitignore // files that git should ignore
├── .gitmodules // information
└── README.md
- To clone the repo make sure you have Git installed on your computer. Then authenticate your GitHub account using either:
- ssh keys (this one is easier)
- Once done, run the following command in your terminal in whatever folder you want to save the repository
git clone git@github.com:parkuman/capstone.git
- GitHub personal access token
- Once done, run the following command in your terminal in whatever folder you want to save the repository
git clone https://github.com/parkuman/capstone.git
- ssh keys (this one is easier)
- Once cloned, check the READMEs in the other folders to see how to install those components.