From 934cd9bb84ac1d13c7b9d0edd233cd9f36a94b88 Mon Sep 17 00:00:00 2001 From: stdweird Date: Mon, 6 Jan 2025 15:34:19 +0100 Subject: [PATCH 1/4] add gpilot only warning to transcribe app page --- mkdocs/docs/HPC/transcribe.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/mkdocs/docs/HPC/transcribe.md b/mkdocs/docs/HPC/transcribe.md index 3f7ad669b490..7dd6beb9600a 100644 --- a/mkdocs/docs/HPC/transcribe.md +++ b/mkdocs/docs/HPC/transcribe.md @@ -2,6 +2,9 @@ ## What is Transcribe +!!! warning + The `Transcribe` application is currently only available to `gpilot` members. + `Transcribe` is a non-interactive application that offers audio transcription based on `OpenAI` `Whisper` (and derivatives thereoff). The main use case is sporadic transcription of audio or video files. There is intentionally no bulk mode (or API or library) From 00d01b1d92ac612063446458b6ca649495c797c4 Mon Sep 17 00:00:00 2001 From: stdweird Date: Mon, 6 Jan 2025 16:58:04 +0100 Subject: [PATCH 2/4] fix list layout, and add to navigation page --- config/templates/hpc.template | 1 + mkdocs/docs/HPC/transcribe.md | 19 ++++++++++--------- 2 files changed, 11 insertions(+), 9 deletions(-) diff --git a/config/templates/hpc.template b/config/templates/hpc.template index 8d3c039f99ae..019a198bd9fd 100644 --- a/config/templates/hpc.template +++ b/config/templates/hpc.template @@ -60,6 +60,7 @@ nav: - Python: python.md - Python virtual environments: setting_up_python_virtual_environments.md - VS Code Tunnel: vscodetunnel.md + - Transcribe: transcribe.md - FAQ: - Frequently Asked Questions: FAQ.md - Appendices: diff --git a/mkdocs/docs/HPC/transcribe.md b/mkdocs/docs/HPC/transcribe.md index 7dd6beb9600a..8aee22c028ff 100644 --- a/mkdocs/docs/HPC/transcribe.md +++ b/mkdocs/docs/HPC/transcribe.md @@ -11,15 +11,16 @@ The main use case is sporadic transcription of audio or video files. There is in to help with large scale projects. The supported flow is: - - Upload audio or video file using the `Files` interface of the web portal - - Configure transcription via the `Interactive Apps` -> `Transcribe` application (currently under `Testing` section at the bottom); - you can select `Whisper inputfile` and `Whisper languages`. - - Launch it and wait. Connecting to the running transcription is entirely optional; there is nothing interactive to do. - You will also receive an email when the transcritpion started. - - Upon completion, you will receive an email with link to the result directory. This info will also be shown in the application session under - `My interactive sessions` (but the session data is only available for a week). - - The result directory has a subdirectory per language with the text files and some metadata in JSON format of the transcritpion itself and input file. +- Upload audio or video file using the `Files` interface of the web portal +- Configure transcription via the `Interactive Apps` -> `Transcribe` application (currently under `Testing` section at the bottom); + you can select `Whisper inputfile` and `Whisper languages`. +- Launch it and wait. Connecting to the running transcription is entirely optional; there is nothing interactive to do. + You will also receive an email when the transcritpion started. +- Upon completion, you will receive an email with link to the result directory. This info will also be shown in the application session under + `My interactive sessions` (but the session data is only available for a week). + + The result directory has a subdirectory per language with the text files and some metadata in JSON format of the transcritpion itself and input file. + This is intentionally kept simple. There is also no risk of loosing previous results (although some previous result directories might get renamed when input file names are reused). From 2e3c33f123626f2311b06e7e257fadddde3ea49f Mon Sep 17 00:00:00 2001 From: Stijn De Weirdt Date: Mon, 6 Jan 2025 17:09:01 +0100 Subject: [PATCH 3/4] Update config/templates/hpc.template Co-authored-by: Kenneth Hoste --- config/templates/hpc.template | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/templates/hpc.template b/config/templates/hpc.template index 019a198bd9fd..c31b08ce517e 100644 --- a/config/templates/hpc.template +++ b/config/templates/hpc.template @@ -59,8 +59,8 @@ nav: - OpenFOAM: openFOAM.md - Python: python.md - Python virtual environments: setting_up_python_virtual_environments.md - - VS Code Tunnel: vscodetunnel.md - Transcribe: transcribe.md + - VS Code Tunnel: vscodetunnel.md - FAQ: - Frequently Asked Questions: FAQ.md - Appendices: From 867e20df526e15705a1448f379358eb4b8465c0d Mon Sep 17 00:00:00 2001 From: Stijn De Weirdt Date: Mon, 6 Jan 2025 17:09:32 +0100 Subject: [PATCH 4/4] Update mkdocs/docs/HPC/transcribe.md Co-authored-by: Kenneth Hoste --- mkdocs/docs/HPC/transcribe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/mkdocs/docs/HPC/transcribe.md b/mkdocs/docs/HPC/transcribe.md index 8aee22c028ff..c4202553279c 100644 --- a/mkdocs/docs/HPC/transcribe.md +++ b/mkdocs/docs/HPC/transcribe.md @@ -3,7 +3,7 @@ ## What is Transcribe !!! warning - The `Transcribe` application is currently only available to `gpilot` members. + The `Transcribe` application is currently only available to members of the `gpilot` user group. `Transcribe` is a non-interactive application that offers audio transcription based on `OpenAI` `Whisper` (and derivatives thereoff).