Apply suggestions from code review

Co-authored-by: Josh <josh.t.richards@gmail.com>
Signed-off-by: Marcel Klehr <mklehr@gmx.net>
This commit is contained in:
Marcel Klehr
2024-06-24 12:40:25 +02:00
committed by GitHub
parent 6927517899
commit fe598387c3
2 changed files with 3 additions and 3 deletions

View File

@@ -11,7 +11,7 @@ This app uses `ctransformers <https://github.com/marella/ctransformers>`_ under
* `Llama3 8b Instruct <https://huggingface.co/QuantFactory/Meta-Llama-3-8B-Instruct-GGUF>`_ (reasonable quality; fast; good acclaim; multilingual output may not be optimal)
* `Llama3 70B Instruct <https://huggingface.co/QuantFactory/Meta-Llama-3-70B-Instruct-GGUF>`_ (good quality; good acclaim; good multilingual output)
This app supports input and output in other languages than English, if the underlying model supports the language.
This app supports input and output in languages other than English if the underlying model supports the language.
Requirements
------------
@@ -76,7 +76,7 @@ Nextcloud customers should file bugs directly with our Support system.
Known Limitations
-----------------
* We currently only support languages that the underlying model supports; correctness of language use in other languages than English may be poor depending on the language's coverage in the model's training data (We recommended model Llama 3 or other models explicitly trained on multiple languages)
* We currently only support languages that the underlying model supports; correctness of language use in languages other than English may be poor depending on the language's coverage in the model's training data (We recommended model Llama 3 or other models explicitly trained on multiple languages)
* Language models can be bad at reasoning tasks
* Language models are likely to generate false information and should thus only be used in situations that are not critical. It's recommended to only use AI at the beginning of a creation process and not at the end, so that outputs of AI serve as a draft for example and not as final product. Always check the output of language models before using it.
* Make sure to test the language model you are using it for whether it meets the use-case's quality requirements

View File

@@ -6,7 +6,7 @@ App: Local Whisper Speech-To-Text (stt_whisper2)
The *stt_whisper2* app is one of the apps that provide Speech-To-Text functionality in Nextcloud and act as a media transcription backend for the :ref:`Nextcloud Assistant app<ai-app-assistant>`, the *talk* app and :ref:`other apps making use of the core Translation API<stt-consumer-apps>`. The *stt_whisper2* app specifically runs only open source models and does so entirely on-premises. Nextcloud can provide customer support upon request, please talk to your account manager for the possibilities.
This app supports input and output in other languages than English, if the underlying model supports the language.
This app supports input and output in languages other than English if the underlying model supports the language.
This app uses `faster-whisper <https://github.com/SYSTRAN/faster-whisper>`_ under the hood. Output quality will differ depending on which model you use, we recommend the following models: