Skip to content

Commit

Permalink
Merge pull request #55 from UPPMAX/jayant-yadav-whisper
Browse files Browse the repository at this point in the history
Added GUI instructions
  • Loading branch information
jayant-yadav authored May 6, 2024
2 parents 433a9f9 + 1189c3f commit fe2c1ba
Showing 1 changed file with 16 additions and 2 deletions.
18 changes: 16 additions & 2 deletions docs/software/whisper.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,8 +26,22 @@ Currently Loaded Modules:

## Usage

Whisper can be run as a command-line tool or as a Python library.
An interactive Whisper GUI can be run by running the following command on terminal: `whisper-gui.sh`.
Whisper as an inference service is available in the form of Graphical User Interface (GUI).
Whisper can also be run as a command-line tool or as a Python library.

### GUI

1. Login to [Rackham](https://rackham-gui.uppmax.uu.se/) or [Bianca](https://bianca.uppmax.uu.se/) via ThinLinc.
2. Load Whisper module as instructed in [Module Loading](http://docs.uppmax.uu.se/software/whisper/#module-loading) section.
3. Transfer your data from your local machine to Wharf ([WinSCP](http://docs.uppmax.uu.se/cluster_guides/transfer_bianca/#winscp-windows) client, [FileZilla](http://docs.uppmax.uu.se/cluster_guides/transfer_bianca/#filezilla-linuxmacoswindows) client or other ways via [terminal](http://docs.uppmax.uu.se/cluster_guides/transfer_bianca/)) and then to your project folder (Bianca: `/cygnus/proj/`) .
4. Go to your project folder where you will also find `whisper-gui.sh` file, right click inside this folder and select "Open Terminal Here" and run the following command: `./whisper-gui.sh &`. This will run the Whisper service.
5. Select appropriate options, or use the following for the best results:
device: gpu
SLURM job name: [give any name without space]
Total audio length in minutes : [give a rough average if transcribing files in bulk]
Model: large-v2
by word timestamps: by_sentence
6. Monitor your job using `jobinfo` command on terminal or on `[job_name].out` that gets created in the same folder. Where `[job_name]` is the SLURM job name that you gave ealier.

### Command-line

Expand Down

0 comments on commit fe2c1ba

Please sign in to comment.