Differences

This shows you the differences between two versions of the page.

--- dcc:itsol:whisper:setup [2024/07/31 08:32] – created giulio
+++ dcc:itsol:whisper:setup [2025/10/20 13:16] (current) – Updated explanation on what folders to create giulio
@@ Line 1: / Line 1: @@
-====== Tool setup and installation ======
+{{indexmenu_n>1}}
+===== Initial Setup =====
+==== Setting up on HPC using the portal ====
+The guide below will take you through some basic steps to start running automatic transcription jobs on the High Performance Computing (HPC) cluster from a Windows computer. Before you can get started with setting Whisper up, you need to first [[https://portal.hb.hpc.rug.nl/public/start.html|Request a Hábrók (HPC) account or log into the HPC portal]]
+{{ :dcc:itsol:whisper:hb_portal_1.png?direct&900 | }}
+Once you have an HPC account, you can navigate to the ''Files'' tab in the top menu bar and select ''/scratch/p-number''. Before we can run the script for the transcription, we need to make sure that folders are set up correctly in your HPC environment.
+{{ :dcc:itsol:whisper:hb_portal_2a.png?direct&900 | }}
+In this window, you will be able to manage your files and folders in HPC. To begin with, make sure that you are in the folder with your p-number in the ''/scratch/'' partition of Hábrók. In the next steps, you will need to create a main folder for Whisper, then two subfolders for the input and output data. To create the main folder, click on ''New Directory'' as shown below. Please make sure that you write "whisper" in lower case. When the folder appears in your window, click on its name to open the next window.
+{{ :dcc:itsol:whisper:hb_portal_3.png?direct&900 | }}
+Once inside the Whisper main folder, you need to create two subfolders. Once again, use ''New Directory'' to create each new folder. Call them "input" and "output", respectively, taking care to use lower case letters. Do not worry if your do not see any ''.sh'' file or ''slurm'' file in your file view. They will come later.
+{{ :dcc:itsol:whisper:hb_portal_4.png?direct&900 | }}
+==== Building the virtual environment and installing Whisper ====
+**Note: This step is only needed the first time you set up Whisper.** After you have installed the program for the first time, you can skip directly to the next part of the guide to run the program.
+When logged into your session in the terminal, you will have a prompt where you can enter commands. In order to run Whisper, you will need to create the proper environment in your HPC session. To do so, copy the grey-highlighted lines below one by one into your terminal and run them separately by pressing enter.
+**Note**: To copy text into the terminal, ''ctrl+V'' will not work. Use either the right mouse click, then select paste from the drop-down menu, or, if you have a mouse wheel, click on the terminal with the mouse wheel to paste the text directly after you copied it.
+**Steps to follow to install whisper**:
+  * First, you need to load a module that Whisper will need to run. To do so, copy-paste the line highlighted in grey below into the terminal, as shown in the figure.
+    * <code> module load PyTorch/2.1.2-foss-2023a-CUDA-12.1.1</code> {{ :dcc:itsol:whisper:insta_4a.png?direct&600 | }}
+  * Then you need to create the virtual environment where you will install whisper. Copy-paste the line below into the terminal.
+    * <code> python3 -m venv $HOME/.envs/whisper </code> {{ :dcc:itsol:whisper:insta_5a.png?direct&600 | }}
+  * Now, activate the newly created environment by copy-pasting the line below.
+    * <code> source $HOME/.envs/whisper/bin/activate </code> {{ :dcc:itsol:whisper:insta_6a.png?direct&600 | }}
+  * Before you install Whisper, you need to make sure to have the latest version of some programs. Copy the two lines below separately into the terminal, as shown in the figures:
+    * <code> pip install --upgrade pip </code> {{ :dcc:itsol:whisper:insta_7a.png?direct&600 | }}
+    * <code> pip install --upgrade wheel </code> {{ :dcc:itsol:whisper:insta_8a.png?direct&600 | }}
+  * Finally, you can install Whisper by running the command below:
+    * <code> pip install git+https://github.com/openai/whisper.git </code> {{ :dcc:itsol:whisper:insta_9a.png?direct&600 | }}
+  * If everything went well, you should see the following screen: {{ :dcc:itsol:whisper:insta_10a.png?direct&600 | }}
+  * As a final step, type <code> deactivate </code> into the terminal, then press "enter". After this initial installation, you won't need to manually activate the whisper environment anymore. {{ :dcc:itsol:whisper:insta_11a.png?direct&600 | }}
+  * If you wish to fully close the environment and also close the HPC session directly, type <code> exit </code> instead of <code> deactivate </code>.
+**Note**: The version numbers displayed in this guide for the programs you have installed and upgraded reflect the most recent versions at the time this guide was written. The numbers you will see displayed might have changed if newer versions have been released.
-This page is under construction.
 [[dcc:itsol:whisper:scripts| → Move to the next step]]