| Both sides previous revision Previous revision Next revision | Previous revision |
| dcc:itsol:whisper:running [2026/09/24 12:07] – New Whisper Guide camarocico | dcc:itsol:whisper:running [2026/09/25 10:21] (current) – alba |
|---|
| {{indexmenu_n>2}} | {{indexmenu_n>2}} |
| |
| ====== Run a Whisper Job ====== | ====== Run a Whisper job ====== |
| |
| - Log in to the [[https://portal.hb.hpc.rug.nl/|Hábrók web portal]]. The dashboard opens. | - Log in to the [[https://portal.hb.hpc.rug.nl/|Hábrók web portal]]. The dashboard opens. |
| The wizard opens in a new browser tab, and the dashboard stays open in the first one, so you can switch back to it at any time. | The wizard opens in a new browser tab, and the dashboard stays open in the first one, so you can switch back to it at any time. |
| |
| ===== Recommended Settings ===== | ===== Recommended settings ===== |
| |
| The form is filled in from top to bottom. For a normal transcription, use these settings: | The form is filled in from top to bottom. For a normal transcription, use these settings: |
| |''%%Show advanced options%%'' |Not selected | | |''%%Show advanced options%%'' |Not selected | |
| |
| They are recommended because naming the language avoids detection mistakes, alignment costs little and gives better timings, and diarization is slower and only worth running when you need speaker labels. A 4-hour limit covers a single recording of ordinary length while keeping the wait in the queue short. | The settings above are recommended because naming the language avoids detection mistakes, alignment costs little and gives better timings, and diarization is slower and only worth running when you need speaker labels. A 4-hour limit covers a single recording of ordinary length while keeping the wait in the queue short. |
| |
| These are starting values rather than guarantees. Long recordings, multiple files, or busy queue conditions may require more time. | These are starting values rather than guarantees. Long recordings, multiple files, or busy queue conditions may require more time. |
| {{ :dcc:itsol:whisper:fill_form.webm?800x450 |}} | {{ :dcc:itsol:whisper:fill_form.webm?800x450 |}} |
| |
| ===== The Job Header ===== | ===== The job header ===== |
| |
| The first four fields describe the job itself rather than the transcription. | The first four fields describe the job itself rather than the transcription. |
| |
| * ''%%Script Location%%'' is where the portal writes the job script. The default is a ''%%whisper/%%'' directory in your scratch space. If you followed this guide, leave it as it is; otherwise use ''%%Select Path%%'' to choose another directory, but never the ''%%input%%'' directory. | * ''%%Script Location%%'' is where the portal writes the job script. The default is a ''%%whisper/%%'' directory in your scratch space. If you followed this guide, leave it as it is; otherwise, use ''%%Select Path%%'' to choose another directory, but never the ''%%input%%'' directory. |
| * ''%%Script Name%%'' is the file name of that script. The default ''%%jobscript.sh%%'' is fine. | * ''%%Script Name%%'' is the file name of that script. The default ''%%jobscript.sh%%'' is fine. |
| * ''%%Job Name%%'' is the name you will see in the portal's job history. The default is ''%%Whisper%%''. A name that identifies the recording makes several jobs easier to tell apart. | * ''%%Job Name%%'' is the name you will see in the portal's job history. The default is ''%%Whisper%%''. A name that identifies the recording makes several jobs easier to tell apart. |
| * ''%%Hide script content%%'' is selected by default, which keeps the generated job script out of sight. Clear it if you want to read the script before submitting, for example to compare it with the script of an earlier job. The script is generated for you and everything in this guide works without touching it. If you know your way around Slurm you can edit it before you submit — to request a GPU other than the V100 the app asks for by default, for example. | * ''%%Hide script content%%'' is selected by default, which keeps the generated job script out of sight. Clear it if you want to read the script before submitting, for example to compare it with the script of an earlier job. The script is generated for you and everything in this guide works without touching it. If you know your way around Slurm you can edit it before you submit — to request a GPU other than the V100 the app asks for by default, for example. |
| |
| ===== Maximum Runtime ===== | ===== Maximum runtime ===== |
| |
| ''%%Maximum hours%%'' and ''%%Maximum minutes%%'' set a limit, not a prediction. The default is 4 hours. A job that reaches its limit is stopped even if transcription has not finished, and the form accepts at most 7 hours and 59 minutes. | ''%%Maximum hours%%'' and ''%%Maximum minutes%%'' set a limit, not a prediction. The default is 4 hours. A job that reaches its limit is stopped even if transcription has not finished, and the form accepts at most 7 hours and 59 minutes. |
| Choose the language that is spoken in the recording. This usually gives more predictable results than automatic detection. | Choose the language that is spoken in the recording. This usually gives more predictable results than automatic detection. |
| |
| The field is marked as required, but the list starts with an empty entry and that entry is accepted. Leave the language empty only when you do not know it. Automatic detection can make mistakes, especially for short recordings, background speech, closely related languages, or a strong and uncommon accent: a strongly accented English speaker has been detected as Welsh. | The field is marked as required, but the list starts with an empty entry, and that entry is accepted. Leave the language empty only when you do not know it. Automatic detection can make mistakes, especially for short recordings, background speech, closely related languages, or a strong and uncommon accent: a strongly accented English speaker could be detected as Welsh, for example. |
| |
| For recordings containing several languages, results may vary. If possible, split the recording into language-specific parts and process each part with the matching language selected. | For recordings containing several languages, results may vary. If possible, split the recording into language-specific parts and process each part with the matching language selected. |
| |
| ===== Skip Alignment ===== | ===== Skip alignment ===== |
| |
| Alignment improves the timing of words and subtitle segments after transcription. Leave ''%%Skip alignment%%'' cleared for normal use. | Alignment improves the timing of words and subtitle segments after transcription. Leave ''%%Skip alignment%%'' cleared for normal use. |
| A few languages use a language-specific alignment model that the app configures for you; all others use the default model that comes with the alignment step. You never need to enter a model name yourself. | A few languages use a language-specific alignment model that the app configures for you; all others use the default model that comes with the alignment step. You never need to enter a model name yourself. |
| |
| ===== Run Speaker Diarization ===== | ===== Run speaker diarization ===== |
| |
| Speaker diarization attempts to identify when different people are speaking. Select ''%%Run speaker diarization%%'' when speaker labels are useful. The checkbox itself is labelled ''%%Diarize%%''. | Speaker diarization attempts to identify when different people are speaking. Select ''%%Run speaker diarization%%'' when speaker labels are useful. The checkbox itself is labelled ''%%Diarize%%''. |
| Choosing ''%%3.1 (requires HF token)%%'' reveals a further ''%%HuggingFace token%%'' field, and the job will not start until you fill it in. Do not share that token or include it in support messages, screenshots, or copied job scripts. **This is a legacy model which will be removed in the near future**. | Choosing ''%%3.1 (requires HF token)%%'' reveals a further ''%%HuggingFace token%%'' field, and the job will not start until you fill it in. Do not share that token or include it in support messages, screenshots, or copied job scripts. **This is a legacy model which will be removed in the near future**. |
| |
| ===== Input and Output Directories ===== | ===== Input and output directories ===== |
| |
| Both directories default to a ''%%whisper/input/%%'' and a ''%%whisper/output/%%'' directory in your ''%%scratch%%'' space, and ''%%Select Path%%'' opens a browser to choose another. Confirm that: | Both directories default to a ''%%whisper/input/%%'' and a ''%%whisper/output/%%'' directory in your ''%%scratch%%'' space, and ''%%Select Path%%'' opens a browser to choose another. Confirm that: |
| The job stops with an error if the ''%%input%%'' directory does not exist, so create it before submitting. | The job stops with an error if the ''%%input%%'' directory does not exist, so create it before submitting. |
| |
| ===== Advanced Options ===== | ===== Advanced options ===== |
| |
| Most users should leave ''%%Show advanced options%%'' cleared. Selecting it reveals: | Most users should leave ''%%Show advanced options%%'' cleared. Selecting it reveals: |
| * ''%%Initial prompt to Whisper%%'' can provide spelling or context hints, such as names or specialist terminology. Write it as a sentence in the language of the recording, for example ''%%Interview about the Hábrók cluster with Castor and Pollux, mentioning Slurm, WhisperX and scratch storage.%%'' An initial prompt is guidance, not a guaranteed vocabulary list. Keep it short and check whether it improves the result on a sample recording. | * ''%%Initial prompt to Whisper%%'' can provide spelling or context hints, such as names or specialist terminology. Write it as a sentence in the language of the recording, for example ''%%Interview about the Hábrók cluster with Castor and Pollux, mentioning Slurm, WhisperX and scratch storage.%%'' An initial prompt is guidance, not a guaranteed vocabulary list. Keep it short and check whether it improves the result on a sample recording. |
| * ''%%Whisper model%%'' shows the model the selected task will use. The field accepts typing but reverts immediately; the model is set by the task and cannot be changed. | * ''%%Whisper model%%'' shows the model the selected task will use. The field accepts typing but reverts immediately; the model is set by the task and cannot be changed. |
| * ''%%Alignment model%%'' appears only when the language you selected has a language-specific alignment model, and it is filled in for you. For every other language the field stays hidden and the default alignment model is used. | * ''%%Alignment model%%'' appears only when the language you selected has a language-specific alignment model, and it is filled in for you. For every other language, the field stays hidden, and the default alignment model is used. |
| |
| ===== Submit and Monitor the Job ===== | ===== Submit and monitor the job ===== |
| |
| Click ''%%Submit%%'' at the bottom of the form. If you want to read or change the job script first, clear ''%%Hide script content%%'' in the job header. | Click ''%%Submit%%'' at the bottom of the form. If you want to read or change the job script first, clear ''%%Hide script content%%'' in the job header. |
| |
| Submitting does not take you anywhere: the form stays open, and a message at the top of the page confirms that the job has been submitted and offers a ''%%History page%%'' link. Follow it, or open ''%%History%%'' from the portal's menu. Either way you reach the same list, with one row per job you have submitted: | Submitting does not take you anywhere: the form stays open, and a message at the top of the page confirms that the job has been submitted and offers a ''%%History page%%'' link. Follow it, or open ''%%History%%'' from the portal's menu. Either way, you reach the same list, with one row per job you have submitted: |
| |
| ^Column ^What it shows ^ | ^Column ^What it shows ^ |