Skip to content

Commit

Permalink
Adding note on running buzz from source on macos (#886)
Browse files Browse the repository at this point in the history
  • Loading branch information
raivisdejus committed Aug 16, 2024
1 parent 67fea79 commit 1c26bec
Showing 1 changed file with 18 additions and 12 deletions.
30 changes: 18 additions & 12 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,12 @@ Log files contain valuable information about what the Buzz was doing before the

**Test on latest version**

To see if your issue has already been fixed, try running the latest version of the Buzz. To get it log in to the GitHub and go to [Actions section](https://github.com/chidiwilliams/buzz/actions?query=branch%3Amain). Latest development versions attached to Artifacts section of successful builds.
To see if your issue has already been fixed, try running the latest version of the Buzz. To get it log in to the GitHub and go to [Actions section](https://github.com/chidiwilliams/buzz/actions/workflows/ci.yml?query=branch%3Amain). Latest development versions attached to Artifacts section of successful builds.

Linux versions get also pushed to the snap. To install latest development version use `snap install buzz --channel latest/edge`



## Running Buzz locally

### Linux (Ubuntu)
Expand All @@ -54,6 +56,21 @@ On versions prior to Ubuntu 24.04 install `sudo apt-get install --no-install-rec
7. Build Buzz `poetry build`
8. Run Buzz `python -m buzz`

#### Necessary dependencies for Faster Whisper on GPU

All the dependencies for GPU support should be included in the dependency packages already installed,
but if you get issues running Faster Whisper on GPU, install [CUDA 12](https://developer.nvidia.com/cuda-downloads), [cuBLASS](https://developer.nvidia.com/cublas) and [cuDNN](https://developer.nvidia.com/cudnn).

#### Error for Faster Whisper on GPU `Could not load library libcudnn_ops_infer.so.8`

You need to add path to the library to the `LD_LIBRARY_PATH` environment variable.
Check exact path to your poetry virtual environment, it may be different for you.

```
export LD_LIBRARY_PATH=/home/PutYourUserNameHere/.cache/pypoetry/virtualenvs/buzz-captions-JjGFxAW6-py3.12/lib/python3.12/site-packages/nvidia/cudnn/lib/:$LD_LIBRARY_PATH
```


### Mac

1. Clone the repository `git clone --recursive https://github.com/chidiwilliams/buzz.git`
Expand All @@ -65,19 +82,8 @@ On versions prior to Ubuntu 24.04 install `sudo apt-get install --no-install-rec
7. Build Buzz `poetry build`
8. Run Buzz `python -m buzz`

#### Necessary dependencies for Faster Whisper on GPU

All the dependencies for GPU support should be included in the dependency packages already installed,
but if you get issues running Faster Whisper on GPU, install [CUDA 12](https://developer.nvidia.com/cuda-downloads), [cuBLASS](https://developer.nvidia.com/cublas) and [cuDNN](https://developer.nvidia.com/cudnn).

#### Error for Faster Whisper on GPU `Could not load library libcudnn_ops_infer.so.8`

You need to add path to the library to the `LD_LIBRARY_PATH` environment variable.
Check exact path to your poetry virtual environment, it may be different for you.

```
export LD_LIBRARY_PATH=/home/PutYourUserNameHere/.cache/pypoetry/virtualenvs/buzz-captions-JjGFxAW6-py3.12/lib/python3.12/site-packages/nvidia/cudnn/lib/:$LD_LIBRARY_PATH
```
### Windows

Assumes you have [Git](https://git-scm.com/downloads) and [python](https://www.python.org/downloads) installed and added to PATH.
Expand Down

0 comments on commit 1c26bec

Please sign in to comment.