From fcb263129579f452cefd989dd20cf755346a81c2 Mon Sep 17 00:00:00 2001 From: Zohaib Rauf Date: Fri, 2 Feb 2024 21:30:05 -0800 Subject: [PATCH] Updated readme and gitignore --- OS/01/.gitignore | 160 ++++++++++++++++++++++++- OS/01/README.md | 12 +- OS/01/core/stt/whisper-rust/.gitignore | 11 +- 3 files changed, 175 insertions(+), 8 deletions(-) diff --git a/OS/01/.gitignore b/OS/01/.gitignore index 4c842e4..6769e21 100644 --- a/OS/01/.gitignore +++ b/OS/01/.gitignore @@ -1,2 +1,160 @@ +# Byte-compiled / optimized / DLL files +__pycache__/ +*.py[cod] +*$py.class + +# C extensions +*.so + +# Distribution / packaging +.Python +build/ +develop-eggs/ +dist/ +downloads/ +eggs/ +.eggs/ +lib/ +lib64/ +parts/ +sdist/ +var/ +wheels/ +share/python-wheels/ +*.egg-info/ +.installed.cfg +*.egg +MANIFEST + +# PyInstaller +# Usually these files are written by a python script from a template +# before PyInstaller builds the exe, so as to inject date/other infos into it. +*.manifest +*.spec + +# Installer logs +pip-log.txt +pip-delete-this-directory.txt + +# Unit test / coverage reports +htmlcov/ +.tox/ +.nox/ +.coverage +.coverage.* +.cache +nosetests.xml +coverage.xml +*.cover +*.py,cover +.hypothesis/ +.pytest_cache/ +cover/ + +# Translations +*.mo +*.pot + +# Django stuff: +*.log +local_settings.py +db.sqlite3 +db.sqlite3-journal + +# Flask stuff: +instance/ +.webassets-cache + +# Scrapy stuff: +.scrapy + +# Sphinx documentation +docs/_build/ + +# PyBuilder +.pybuilder/ +target/ + +# Jupyter Notebook +.ipynb_checkpoints + +# IPython +profile_default/ +ipython_config.py + +# pyenv +# For a library or package, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# .python-version + +# pipenv +# According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control. +# However, in case of collaboration, if having platform-specific dependencies or dependencies +# having no cross-platform support, pipenv may install dependencies that don't work, or not +# install all needed dependencies. +#Pipfile.lock + +# poetry +# Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control. +# This is especially recommended for binary packages to ensure reproducibility, and is more +# commonly ignored for libraries. +# https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control +#poetry.lock + +# pdm +# Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control. +#pdm.lock +# pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it +# in version control. +# https://pdm.fming.dev/#use-with-ide +.pdm.toml + +# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm +__pypackages__/ + +# Celery stuff +celerybeat-schedule +celerybeat.pid + +# SageMath parsed files +*.sage.py + +# Environments .env -.DS_Store \ No newline at end of file +.venv +env/ +venv/ +ENV/ +env.bak/ +venv.bak/ + +# Spyder project settings +.spyderproject +.spyproject + +# Rope project settings +.ropeproject + +# mkdocs documentation +/site + +# mypy +.mypy_cache/ +.dmypy.json +dmypy.json + +# Pyre type checker +.pyre/ + +# pytype static type analyzer +.pytype/ + +# Cython debug symbols +cython_debug/ + +# PyCharm +# JetBrains specific template is maintained in a separate JetBrains.gitignore that can +# be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore +# and can be added to the global gitignore or merged into this file. For a more nuclear +# option (not recommended) you can uncomment the following to ignore the entire idea folder. +#.idea/ \ No newline at end of file diff --git a/OS/01/README.md b/OS/01/README.md index e55bcdb..e4c881b 100644 --- a/OS/01/README.md +++ b/OS/01/README.md @@ -1,9 +1,9 @@ # Setup -1. Install Rust and Python dependencies -2. Go to core/stt and run `cargo build --release` -3. Download GGML Whisper model from https://huggingface.co/ggerganov/whisper.cpp -4. Copy .env.example to .env and put the path to model -5. Run `python core/i_endpoint.py` to start the server -6. Run `python core/test_cli.py PATH_TO_FILE` to test sending audio to service and getting transcription back over websocket \ No newline at end of file +1. Install [Rust](https://www.rust-lang.org/tools/install) and Python dependencies `pip install -r requirements.txt`. +2. Go to **core/stt** and run `cargo build --release`. +3. Download GGML Whisper model from [Huggingface](https://huggingface.co/ggerganov/whisper.cpp). +4. In core, copy `.env.example` to `.env` and put the path to model. +5. Run `python core/i_endpoint.py` to start the server. +6. Run `python core/test_cli.py PATH_TO_FILE` to test sending audio to service and getting transcription back over websocket. \ No newline at end of file diff --git a/OS/01/core/stt/whisper-rust/.gitignore b/OS/01/core/stt/whisper-rust/.gitignore index 1de5659..71ab9a4 100644 --- a/OS/01/core/stt/whisper-rust/.gitignore +++ b/OS/01/core/stt/whisper-rust/.gitignore @@ -1 +1,10 @@ -target \ No newline at end of file +# Generated by Cargo +# will have compiled files and executables +debug/ +target/ + +# These are backup files generated by rustfmt +**/*.rs.bk + +# MSVC Windows builds of rustc generate these, which store debugging information +*.pdb \ No newline at end of file