Acoustic model configuration for streaming ASR. More...

#include <cxx-api.h>

Collaboration diagram for sherpa_onnx::cxx::OnlineModelConfig:

Public Attributes
OnlineTransducerModelConfig	transducer

OnlineParaformerModelConfig	paraformer

OnlineZipformer2CtcModelConfig	zipformer2_ctc

OnlineNemoCtcModelConfig	nemo_ctc

OnlineToneCtcModelConfig	t_one_ctc

std::string	tokens

int32_t	num_threads = 1

std::string	provider = "cpu"

bool	debug = false

std::string	model_type

std::string	modeling_unit = "cjkchar"

std::string	bpe_vocab

std::string	tokens_buf

Detailed Description

Configure exactly one model family. If multiple model families are set, one of them will be chosen and the choice is implementation-defined.

Example using sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20:

OnlineModelConfig model;
model.transducer.encoder =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "encoder-epoch-99-avg-1.int8.onnx";
model.transducer.decoder =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "decoder-epoch-99-avg-1.onnx";
model.transducer.joiner =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/"
    "joiner-epoch-99-avg-1.int8.onnx";
model.tokens =
    "./sherpa-onnx-streaming-zipformer-bilingual-zh-en-2023-02-20/tokens.txt";
model.num_threads = 1;

Definition at line 120 of file cxx-api.h.

Member Data Documentation

◆ bpe_vocab

std::string sherpa_onnx::cxx::OnlineModelConfig::bpe_vocab

Optional BPE vocabulary.

Definition at line 144 of file cxx-api.h.

◆ debug

bool sherpa_onnx::cxx::OnlineModelConfig::debug = false

Enable verbose debug logging.

Definition at line 138 of file cxx-api.h.

◆ model_type

std::string sherpa_onnx::cxx::OnlineModelConfig::model_type

Optional explicit model type hint.

Definition at line 140 of file cxx-api.h.

◆ modeling_unit

std::string sherpa_onnx::cxx::OnlineModelConfig::modeling_unit = "cjkchar"

Modeling unit such as "cjkchar" or "bpe".

Definition at line 142 of file cxx-api.h.

◆ nemo_ctc

OnlineNemoCtcModelConfig sherpa_onnx::cxx::OnlineModelConfig::nemo_ctc

Streaming NeMo CTC configuration.

Definition at line 128 of file cxx-api.h.

◆ num_threads

int32_t sherpa_onnx::cxx::OnlineModelConfig::num_threads = 1

Number of inference threads.

Definition at line 134 of file cxx-api.h.

◆ paraformer

OnlineParaformerModelConfig sherpa_onnx::cxx::OnlineModelConfig::paraformer

Streaming Paraformer configuration.

Definition at line 124 of file cxx-api.h.

◆ provider

std::string sherpa_onnx::cxx::OnlineModelConfig::provider = "cpu"

Execution provider such as "cpu".

Definition at line 136 of file cxx-api.h.

◆ t_one_ctc

OnlineToneCtcModelConfig sherpa_onnx::cxx::OnlineModelConfig::t_one_ctc

Streaming T-One CTC configuration.

Definition at line 130 of file cxx-api.h.

◆ tokens

std::string sherpa_onnx::cxx::OnlineModelConfig::tokens

Token file path.

Definition at line 132 of file cxx-api.h.

◆ tokens_buf

std::string sherpa_onnx::cxx::OnlineModelConfig::tokens_buf

Optional in-memory token content. If non-empty, it is used instead of a file.

Definition at line 147 of file cxx-api.h.

◆ transducer

OnlineTransducerModelConfig sherpa_onnx::cxx::OnlineModelConfig::transducer

Streaming transducer configuration.

Definition at line 122 of file cxx-api.h.

◆ zipformer2_ctc

OnlineZipformer2CtcModelConfig sherpa_onnx::cxx::OnlineModelConfig::zipformer2_ctc

Streaming Zipformer2 CTC configuration.

Definition at line 126 of file cxx-api.h.

The documentation for this struct was generated from the following file:

c-api/cxx-api.h

Public Attributes