This class is the parameters parser for class WhisperSpeechTranscription. More...
Inheritance diagram for WhisperSpeechTranscription_ParamsParser:Classes | |
| struct | parser_version_type |
Public Member Functions | |
| WhisperSpeechTranscription_ParamsParser () | |
| ~WhisperSpeechTranscription_ParamsParser () override=default | |
| bool | parseParams (const yarp::os::Searchable &config) override |
| Parse the DeviceDriver parameters. | |
| std::string | getDeviceClassName () const override |
| Get the name of the DeviceDriver class. | |
| std::string | getDeviceName () const override |
| Get the name of the device (i.e. | |
| std::string | getDocumentationOfDeviceParams () const override |
| Get the documentation of the DeviceDriver's parameters. | |
| std::vector< std::string > | getListOfParams () const override |
| Return a list of all params used by the device. | |
| bool | getParamValue (const std::string ¶mName, std::string ¶mValue) const override |
| Return the value (represented as a string) of the requested parameter. | |
| std::string | getConfiguration () const override |
| Return the configuration of the device. | |
Public Member Functions inherited from yarp::dev::IDeviceDriverParams | |
| virtual | ~IDeviceDriverParams () |
Public Attributes | |
| const std::string | m_device_classname = {"WhisperSpeechTranscription"} |
| const std::string | m_device_name = {"yarp_whisperSpeechTranscription"} |
| bool | m_parser_is_strict = false |
| const parser_version_type | m_parser_version = {} |
| std::string | m_provided_configuration |
| const std::string | m_model_context_defaultValue = {""} |
| const std::string | m_model_name_defaultValue = {""} |
| const std::string | m_language_defaultValue = {"auto"} |
| const std::string | m_remove_symbols_defaultValue = {"1"} |
| std::string | m_model_context = {} |
| std::string | m_model_name = {} |
| std::string | m_language = {"auto"} |
| int | m_remove_symbols = {1} |
This class is the parameters parser for class WhisperSpeechTranscription.
These are the used parameters:
| Group name | Parameter name | Type | Units | Default Value | Required | Description | Notes |
|---|---|---|---|---|---|---|---|
| - | model_context | string | - | - | 0 | context of Whisper model | Here are additional notes |
| - | model_name | string | - | - | 1 | name of Whisper model | Here are additional notes |
| - | language | string | - | auto | 0 | Language (??? TBC) | Here are additional notes |
| - | remove_symbols | int | - | 1 | 0 | If symbols from output text, (i.e. ...[bla bla]...) are removed | Here are additional notes |
The device can be launched by yarpdev using one of the following examples (with and without all optional parameters):
Definition at line 44 of file WhisperSpeechTranscription_ParamsParser.h.
| WhisperSpeechTranscription_ParamsParser::WhisperSpeechTranscription_ParamsParser | ( | ) |
Definition at line 23 of file WhisperSpeechTranscription_ParamsParser.cpp.
|
overridedefault |
|
overridevirtual |
Return the configuration of the device.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 68 of file WhisperSpeechTranscription_ParamsParser.cpp.
|
inlineoverridevirtual |
Get the name of the DeviceDriver class.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 74 of file WhisperSpeechTranscription_ParamsParser.h.
|
inlineoverridevirtual |
Get the name of the device (i.e.
the plugin name).
Implements yarp::dev::IDeviceDriverParams.
Definition at line 75 of file WhisperSpeechTranscription_ParamsParser.h.
|
overridevirtual |
Get the documentation of the DeviceDriver's parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 175 of file WhisperSpeechTranscription_ParamsParser.cpp.
|
overridevirtual |
Return a list of all params used by the device.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 28 of file WhisperSpeechTranscription_ParamsParser.cpp.
|
overridevirtual |
Return the value (represented as a string) of the requested parameter.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 39 of file WhisperSpeechTranscription_ParamsParser.cpp.
|
overridevirtual |
Parse the DeviceDriver parameters.
Implements yarp::dev::IDeviceDriverParams.
Definition at line 78 of file WhisperSpeechTranscription_ParamsParser.cpp.
| const std::string WhisperSpeechTranscription_ParamsParser::m_device_classname = {"WhisperSpeechTranscription"} |
Definition at line 51 of file WhisperSpeechTranscription_ParamsParser.h.
| const std::string WhisperSpeechTranscription_ParamsParser::m_device_name = {"yarp_whisperSpeechTranscription"} |
Definition at line 52 of file WhisperSpeechTranscription_ParamsParser.h.
| std::string WhisperSpeechTranscription_ParamsParser::m_language = {"auto"} |
Definition at line 70 of file WhisperSpeechTranscription_ParamsParser.h.
| const std::string WhisperSpeechTranscription_ParamsParser::m_language_defaultValue = {"auto"} |
Definition at line 65 of file WhisperSpeechTranscription_ParamsParser.h.
| std::string WhisperSpeechTranscription_ParamsParser::m_model_context = {} |
Definition at line 68 of file WhisperSpeechTranscription_ParamsParser.h.
| const std::string WhisperSpeechTranscription_ParamsParser::m_model_context_defaultValue = {""} |
Definition at line 63 of file WhisperSpeechTranscription_ParamsParser.h.
| std::string WhisperSpeechTranscription_ParamsParser::m_model_name = {} |
Definition at line 69 of file WhisperSpeechTranscription_ParamsParser.h.
| const std::string WhisperSpeechTranscription_ParamsParser::m_model_name_defaultValue = {""} |
Definition at line 64 of file WhisperSpeechTranscription_ParamsParser.h.
| bool WhisperSpeechTranscription_ParamsParser::m_parser_is_strict = false |
Definition at line 53 of file WhisperSpeechTranscription_ParamsParser.h.
| const parser_version_type WhisperSpeechTranscription_ParamsParser::m_parser_version = {} |
Definition at line 59 of file WhisperSpeechTranscription_ParamsParser.h.
| std::string WhisperSpeechTranscription_ParamsParser::m_provided_configuration |
Definition at line 61 of file WhisperSpeechTranscription_ParamsParser.h.
| int WhisperSpeechTranscription_ParamsParser::m_remove_symbols = {1} |
Definition at line 71 of file WhisperSpeechTranscription_ParamsParser.h.
| const std::string WhisperSpeechTranscription_ParamsParser::m_remove_symbols_defaultValue = {"1"} |
Definition at line 66 of file WhisperSpeechTranscription_ParamsParser.h.