Transformers documentation

Nemotron ASR Streaming

You are viewing main version, which requires installation from source. If you'd like regular pip install, checkout the latest stable version (v5.22.2).
Hugging Face's logo
Join the Hugging Face community

and get access to the augmented documentation experience

to get started

Mô hình này được công bố trên HF papers vào ngày 2023-05-08 và được đóng góp cho Hugging Face Transformers vào ngày 2026-06-18.

Nemotron ASR Streaming

Tổng quan

Nemotron ASR Streaming là mô hình nhận dạng giọng nói tiếng Anh 600M tham số từ NVIDIA, được xây dựng cho việc chuyển văn bản chất lượng cao trong cả các thiết lập streaming độ trễ thấp và batch thông lượng cao, với dấu câu và chữ hoa bản địa. Đối với streaming, nó cung cấp các kích thước chunk có thể cấu hình—80ms, 160ms, 560ms và 1120ms, cho phép người dùng đánh đổi giữa độ trễ và độ chính xác để phù hợp với ứng dụng của họ. Kiến trúc FastConformer-RNNT nhận thức bộ nhớ đệm của nó là trung tâm của khả năng này: khác với streaming có bộ đệm truyền thống, vốn xử lý lại lặp đi lặp lại các cửa sổ âm thanh chồng chéo, mô hình chỉ xử lý mỗi chunk mới đến trong khi tái sử dụng ngữ cảnh encoder được lưu trong bộ nhớ đệm từ các chunk trước. Điều này loại bỏ tính toán dư thừa, cải thiện đáng kể hiệu quả và giảm thiểu độ trễ đầu-cuối mà không hy sinh độ chính xác, khiến nó rất phù hợp với các tác vụ chuyển văn bản thời gian thực.

Cách sử dụng

Chuyển văn bản từ giọng nói offline

Pipeline
AutoModel
from transformers import pipeline

pipe = pipeline(
    "automatic-speech-recognition",
    model="nvidia/nemotron-speech-streaming-en-0.6b",
)
out = pipe("https://huggingface.co/datasets/hf-internal-testing/dummy-audio-samples/resolve/main/bcn_weather.mp3")
print(out)

Chuyển văn bản trực tiếp

Đây là một tính năng thử nghiệm và API có thể thay đổi.

Đối với chuyển văn bản thời gian thực, âm thanh được chia thành các đoạn theo:

from threading import Thread
from transformers import AutoModelForRNNT, AutoProcessor, TextIteratorStreamer
from transformers.audio_utils import load_audio

model_id = "nvidia/nemotron-speech-streaming-en-0.6b"
processor = AutoProcessor.from_pretrained(model_id)
model = AutoModelForRNNT.from_pretrained(model_id, device_map="auto")

processor.set_num_lookahead_tokens(6)
print(f"Streaming latency: {processor.streaming_latency_ms} ms")

sampling_rate = processor.feature_extractor.sampling_rate
audio = load_audio(
    "https://huggingface.co/datasets/hf-internal-testing/dummy-audio-samples/resolve/main/obama.mp3",
    sampling_rate=sampling_rate,
)

first_chunk_inputs = processor(
    audio[: processor.num_samples_first_audio_chunk],
    sampling_rate=sampling_rate,
    is_streaming=True,
    is_first_audio_chunk=True,
    return_tensors="pt",
)
first_chunk_inputs = first_chunk_inputs.to(model.device, dtype=model.dtype)


def input_features_generator():
    yield first_chunk_inputs.input_features[:, : processor.num_mel_frames_first_audio_chunk, :]

    mel_frame_idx = processor.num_mel_frames_first_audio_chunk
    hop_length = processor.feature_extractor.hop_length
    n_fft = processor.feature_extractor.n_fft

    start_idx = mel_frame_idx * hop_length - n_fft // 2
    while (end_idx := start_idx + processor.num_samples_per_audio_chunk) < audio.shape[0]:
        inputs = processor(
            audio[start_idx:end_idx],
            sampling_rate=sampling_rate,
            is_streaming=True,
            is_first_audio_chunk=False,
            return_tensors="pt",
        )
        inputs = inputs.to(model.device, dtype=model.dtype)
        yield inputs.input_features

        mel_frame_idx += processor.num_mel_frames_per_audio_chunk
        start_idx = mel_frame_idx * hop_length - n_fft // 2


streamer = TextIteratorStreamer(processor.tokenizer, skip_special_tokens=True)
generate_kwargs = {
    **first_chunk_inputs,
    "input_features": input_features_generator(),
    "streamer": streamer,
}
thread = Thread(target=model.generate, kwargs=generate_kwargs)
thread.start()

# Iterate over the streamer to get text chunks as they are generated
print("Model output (streaming):", end=" ", flush=True)
for text_chunk in streamer:
    print(text_chunk, end="", flush=True)
thread.join()

Độ trễ phát trực tiếp

Độ trễ được xác định bởi num_lookahead_tokens, tức là ngữ cảnh chú ý phía trước (lookahead, trong các khung encoder được lấy mẫu con) mà mỗi khối chờ đợi trước khi được phát ra. Giá trị lớn hơn cho phép mỗi khối nhìn thấy nhiều âm thanh tương lai hơn: độ chính xác tốt hơn với cái giá là độ trễ cao hơn. Kiểm tra các đánh đổi được hỗ trợ, chọn một phương án và đọc lại độ trễ kết quả:

from transformers import AutoProcessor

processor = AutoProcessor.from_pretrained("nvidia/nemotron-speech-streaming-en-0.6b")

# Each supported `num_lookahead_tokens` mapped to its streaming latency in milliseconds:
print(processor.supported_streaming_latencies_ms)
# {13: 1120, 6: 560, 1: 160, 0: 80}

# Select a right attention context (this also re-derives the streaming chunk sizes used above):
processor.set_num_lookahead_tokens(6)

# Latency of the current selection:
print(processor.streaming_latency_ms)
# 560

set_num_lookahead_tokens xác định kích thước các khối mà bộ xử lý phát ra, và num_lookahead_tokens tương ứng phải được truyền đến generate (trong đoạn mã ở trên, nó được truyền qua **inputs/**first_chunk_inputs, vốn mang theo num_lookahead_tokens). Chế độ streaming của generate sẽ gây ra lỗi nếu tham số này bị bỏ qua.

NemotronAsrStreamingConfig

lớp transformers.NemotronAsrStreamingConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0id2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Noneis_encoder_decoder: bool = Truevocab_size: int = 1025decoder_hidden_size: int = 640num_decoder_layers: int = 2hidden_act: str = 'relu'max_symbols_per_step: int = 10encoder_config: dict | transformers.configuration_utils.PreTrainedConfig | None = Nonepad_token_id: int = 0blank_token_id: int = 1024 )

Tham số

  • is_encoder_decoder (bool, tùy chọn, mặc định là True) — Xác định xem mô hình có được sử dụng như một encoder/decoder hay không.
  • vocab_size (int, tùy chọn, mặc định là 1025) — Kích thước từ vựng của mô hình. Xác định số lượng token khác nhau có thể được biểu diễn bởi input_ids.
  • decoder_hidden_size (int, tuỳ chọn, mặc định là 640) — Kích thước ẩn của mạng dự đoán LSTM (pred_hidden của NeMo). Mạng kết hợp chiếu cả đầu ra của encoder và decoder về kích thước này (joint_hidden của NeMo, mà tất cả các checkpoint đã biết đều đặt bằng pred_hidden).
  • num_decoder_layers (int, tùy chọn, mặc định là 2) — Số lượng lớp LSTM trong mạng dự đoán.
  • hidden_act (str, tùy chọn, mặc định là "relu") — Hàm kích hoạt trong mạng liên hợp.
  • max_symbols_per_step (int, tùy chọn, mặc định là 10) — Số lượng ký tự không trống tối đa được phát ra cho mỗi bước thời gian của bộ mã hóa trong quá trình giải mã tham lam.
  • encoder_config (Union[dict, NemotronAsrStreamingEncoderConfig], tùy chọn) — Đối tượng cấu hình hoặc từ điển của encoder.
  • pad_token_id (int, tùy chọn, mặc định là 0) — Token id được sử dụng để đệm (padding) trong từ vựng.
  • blank_token_id (int, tùy chọn, mặc định là 1024) — ID của token trống. Khác với pad_token_id đối với RNN-T.

Đây là lớp cấu hình để lưu trữ cấu hình của một NemotronAsrStreamingForRNNT. Nó được sử dụng để khởi tạo một mô hình Nemotron Asr Streaming theo các đối số được chỉ định, xác định kiến trúc mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như của nvidia/nemotron-speech-streaming-en-0.6b

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import NemotronAsrStreamingForRNNT, NemotronAsrStreamingConfig

>>> # Initializing a NemotronAsrStreaming RNN-T configuration
>>> configuration = NemotronAsrStreamingConfig()

>>> # Initializing a model from the configuration
>>> model = NemotronAsrStreamingForRNNT(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

NemotronAsrStreamingEncoderConfig

lớp transformers.NemotronAsrStreamingEncoderConfig

< >

( transformers_version: str | None = Nonearchitectures: list[str] | None = Noneoutput_hidden_states: bool | None = Falsereturn_dict: bool | None = Truedtype: str | torch.dtype | None = Nonechunk_size_feed_forward: int = 0is_encoder_decoder: bool = Falseid2label: dict[int, str] | dict[str, str] | None = Nonelabel2id: dict[str, int] | dict[str, str] | None = Noneproblem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = Nonehidden_size: int = 1024num_hidden_layers: int = 24num_attention_heads: int = 8intermediate_size: int = 4096hidden_act: str = 'silu'attention_bias: bool = Trueconvolution_bias: bool = Trueconv_kernel_size: int = 9subsampling_factor: int = 8subsampling_conv_channels: int = 256num_mel_bins: int = 80subsampling_conv_kernel_size: int = 3subsampling_conv_stride: int = 2dropout: float | int = 0.1dropout_positions: float | int = 0.0layerdrop: float | int = 0.1activation_dropout: float | int = 0.1attention_dropout: float | int = 0.1max_position_embeddings: int = 5000scale_input: bool = Trueinitializer_range: float = 0.02sliding_window: int = 71default_num_lookahead_tokens: int = 13 )

Tham số

  • hidden_size (int, tùy chọn, mặc định là 1024) — Kích thước của các biểu diễn ẩn.
  • num_hidden_layers (int, tùy chọn, mặc định là 24) — Số lượng lớp ẩn trong bộ giải mã Transformer.
  • num_attention_heads (int, tùy chọn, mặc định là 8) — Số lượng đầu attention cho mỗi lớp attention trong bộ giải mã Transformer.
  • intermediate_size (int, tùy chọn, mặc định là 4096) — Kích thước của các biểu diễn MLP.
  • hidden_act (str, tùy chọn, mặc định là silu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, "gelu", "relu", "silu", v.v.
  • attention_bias (bool, tùy chọn, mặc định là True) — Có sử dụng bias trong các lớp chiếu query, key, value và output trong quá trình self-attention hay không.
  • convolution_bias (bool, tùy chọn, mặc định là True) — Có sử dụng bias trong các phép convolution của module convolution trong conformer hay không.
  • conv_kernel_size (int, tùy chọn, mặc định là 9) — Kích thước kernel của các lớp tích chập trong khối Conformer.
  • subsampling_factor (int, tùy chọn, mặc định là 8) — Hệ số mà theo đó chuỗi đầu vào được lấy mẫu con.
  • subsampling_conv_channels (int, tùy chọn, mặc định là 256) — Số lượng kênh trong các lớp tích chập hạ mẫu.
  • num_mel_bins (int, tùy chọn, mặc định là 80) — Số lượng đặc trưng mel.
  • subsampling_conv_kernel_size (int, tùy chọn, mặc định là 3) — Kích thước nhân của các lớp tích chập lấy mẫu con.
  • subsampling_conv_stride (int, tuỳ chọn, mặc định là 2) — Bước nhảy (stride) của các lớp tích chập hạ mẫu (subsampling convolution).
  • dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ cho tất cả các lớp dropout.
  • dropout_positions (float, tùy chọn, mặc định là 0.0) — Tỷ lệ dropout cho các vị trí trong chuỗi đầu vào.
  • layerdrop (Union[float, int], tùy chọn, mặc định là 0.1) — Xác suất LayerDrop. Xem [bài báo LayerDrop](xem https://huggingface.co/papers/1909.11556) để biết thêm chi tiết.
  • activation_dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các kích hoạt bên trong lớp liên kết đầy đủ.
  • attention_dropout (Union[float, int], tùy chọn, mặc định là 0.1) — Tỷ lệ dropout cho các xác suất chú ý.
  • max_position_embeddings (int, tùy chọn, mặc định là 5000) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng.
  • scale_input (bool, tùy chọn, mặc định là True) — Có nên mở rộng các embedding đầu vào hay không.
  • initializer_range (float, tùy chọn, mặc định là 0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số.
  • sliding_window (int, tùy chọn, mặc định là 71) — Kích thước của cửa sổ trượt chú ý K/V (tính theo các khung encoder đã lấy mẫu thưa). Giá trị này bằng left_context + 1 (khung hiện tại cộng với ngữ cảnh bên trái), do đó ngữ cảnh chú ý bên trái là sliding_window - 1 — giống nhau trên tất cả các lookahead được hỗ trợ.
  • default_num_lookahead_tokens (int, tùy chọn, mặc định là 13) — Bối cảnh chú ý phía bên phải (lookahead, tính theo các khung encoder đã lấy mẫu thưa) được sử dụng khi không có giá trị nào được truyền vào forward. Tập hợp các giá trị được hỗ trợ mà mô hình đã được huấn luyện nằm trên NemotronAsrStreamingProcessor.

Đây là lớp cấu hình để lưu trữ cấu hình của một NemotronAsrStreamingForRNNT. Nó được sử dụng để khởi tạo một mô hình Nemotron Asr Streaming theo các đối số được chỉ định, xác định kiến trúc mô hình. Khởi tạo một cấu hình với các giá trị mặc định sẽ tạo ra một cấu hình tương tự như của nvidia/nemotron-speech-streaming-en-0.6b

Các đối tượng cấu hình kế thừa từ PreTrainedConfig và có thể được sử dụng để kiểm soát đầu ra của mô hình. Đọc tài liệu từ PreTrainedConfig để biết thêm thông tin.

Ví dụ:

>>> from transformers import NemotronAsrStreamingEncoder, NemotronAsrStreamingEncoderConfig

>>> # Initializing a `NemotronAsrStreamingEncoder` configuration
>>> configuration = NemotronAsrStreamingEncoderConfig()

>>> # Initializing a model from the configuration
>>> model = NemotronAsrStreamingEncoder(configuration)

>>> # Accessing the model configuration
>>> configuration = model.config

NemotronAsrStreamingFeatureExtractor

lớp transformers.NemotronAsrStreamingFeatureExtractor

< >

( feature_size = 80sampling_rate = 16000hop_length = 160n_fft = 512win_length = 400preemphasis = 0.97padding_value = 0.0mel_filters_dtype = 'float32'**kwargs )

Tham số

  • feature_size (int, tùy chọn, mặc định là 80) — Kích thước chiều của các đặc trưng đã trích xuất.
  • sampling_rate (int, tùy chọn, mặc định là 16000) — Tần số lấy mẫu (tính bằng hertz (Hz)) mà các tệp âm thanh cần được số hóa.
  • hop_length (int, tùy chọn, mặc định là 160) — Chiều dài của các cửa sổ chồng lấn cho STFT được sử dụng để lấy các hệ số Mel Frequency.
  • n_fft (int, tùy chọn, mặc định là 512) — Kích thước của phép biến đổi Fourier.
  • win_length (int, tùy chọn, mặc định là 400) — Chiều dài cửa sổ cho phép tính STFT.
  • preemphasis (float, tùy chọn, mặc định là 0.97) — Hệ số của bộ lọc preemphasis. 0.0 có nghĩa là không có bộ lọc preemphasis.
  • padding_value (float, tùy chọn, mặc định là 0.0) — Giá trị đệm được dùng để đệm âm thanh. Nên tương ứng với các khoảng im lặng.
  • mel_filters_dtype (str, tuỳ chọn, mặc định là "float32") — Độ chính xác của bộ lọc mel và cửa sổ STFT được lưu trữ. Một số checkpoint giữ các hằng số này ở độ chính xác giảm ("bfloat16" cho Nemotron 3.5 Transcribe): khi đó, bộ lọc và cửa sổ sẽ được làm tròn về dtype đó khi tính toán đặc trưng, để các đặc trưng log-mel khớp với front-end gốc; bản thân spectrogram luôn được tính trong float32.

Tạo một bộ trích xuất đặc tính NemotronAsrStreaming.

Feature extractor này kế thừa từ SequenceFeatureExtractor, bao gồm hầu hết các phương thức chính. Người dùng nên tham khảo lớp cha này để biết thêm thông tin về các phương thức đó.

Lớp này trích xuất các đặc trưng mel-filter bank từ giọng nói thô bằng cách sử dụng một cài đặt numpy tùy chỉnh của Short Time Fourier Transform, vốn nên khớp với tương đương torch.stft của pytorch.

NemotronAsrStreamingProcessor

lớp transformers.NemotronAsrStreamingProcessor

< >

( feature_extractortokenizerblank_token = '<blank>'supported_num_lookahead_tokens = Nonedefault_num_lookahead_tokens = None )

Tham số

  • feature_extractor (NemotronAsrStreamingFeatureExtractor) — Bộ trích xuất đặc trưng là một đầu vào bắt buộc.
  • tokenizer (ParakeetTokenizer) — Tokenizer là đầu vào bắt buộc.
  • blank_token (str, tùy chọn, mặc định là "<blank>") — Token trống cho việc giải mã RNN-T.
  • supported_num_lookahead_tokens (list[int], tùy chọn) — Các ngữ cảnh chú ý bên phải (lookahead, trong các khung encoder được lấy mẫu con) mà mô hình đã được huấn luyện. Bộ xử lý là nguồn sự thật duy nhất cho tập hợp này: set_num_lookahead_tokens() sẽ kiểm tra tính hợp lệ dựa trên tập hợp đó. Mặc định là tập hợp nhận thức bộ đệm NeMo [13, 6, 1, 0].
  • default_num_lookahead_tokens (int, tùy chọn) — Bối cảnh bên phải được dùng để xác định kích thước các khối streaming và được phát ra bởi call(); thay đổi nó bằng set_num_lookahead_tokens(). Mặc định là mục đầu tiên của supported_num_lookahead_tokens.

Tạo một NemotronAsrStreamingProcessor, đóng gói một bộ trích xuất đặc trưng và một bộ phân từ thành một bộ xử lý duy nhất.

NemotronAsrStreamingProcessor cung cấp đầy đủ các chức năng của NemotronAsrStreamingFeatureExtractor và ParakeetTokenizer. Xem ~NemotronAsrStreamingFeatureExtractor và ~ParakeetTokenizer để biết thêm thông tin.

__call__

< >

( audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence['torch.Tensor']]text: str | list[str] | list[list[str]] | None = Nonesampling_rate: int | None = Noneis_streaming: bool = Falseis_first_audio_chunk: bool | None = True**kwargs: *<class 'transformers.processing_utils.ProcessingKwargs'> ) → BatchFeature

Tham số

  • audio (Union[numpy.ndarray, torch.Tensor, collections.abc.Sequence[numpy.ndarray], collections.abc.Sequence[torch.Tensor]]) — Âm thanh hoặc lô âm thanh cần được chuẩn bị. Mỗi âm thanh có thể là một mảng NumPy hoặc tensor PyTorch. Trong trường hợp là mảng NumPy/tensor PyTorch, mỗi âm thanh nên có hình dạng (C, T), trong đó C là số kênh và T là độ dài mẫu của âm thanh.
  • text (Union[str, list[str], list[list[str]]], tùy chọn) — Chuỗi hoặc lô các chuỗi cần được mã hóa. Mỗi chuỗi có thể là một chuỗi ký tự hoặc một danh sách các chuỗi ký tự (chuỗi đã được tách token trước). Nếu bạn truyền vào dữ liệu đầu vào đã được tách token trước, hãy đặt is_split_into_words=True để tránh nhầm lẫn với các đầu vào dạng lô.
  • sampling_rate (int, tùy chọn) — Tần số lấy mẫu của âm thanh đầu vào, tính bằng Hz. Giá trị này phải khớp với tần số lấy mẫu mà bộ trích xuất đặc trưng kỳ vọng (mặc định là 16000 Hz). Nếu được cung cấp, nó sẽ được kiểm tra đối chiếu với tần số lấy mẫu kỳ vọng của bộ xử lý, và một lỗi sẽ được ném ra nếu chúng không khớp. Nếu không được cung cấp, một cảnh báo sẽ được phát ra và tần số lấy mẫu mặc định sẽ được giả định.
  • is_streaming (bool, tùy chọn, mặc định là False) — Có xử lý âm thanh ở chế độ streaming hay không. Khi True, âm thanh có thể được truyền theo từng phần, sử dụng is_first_audio_chunk để phân biệt phần đầu tiên với các phần tiếp theo.
  • is_first_audio_chunk (bool, tuỳ chọn, mặc định là True) — Chỉ định liệu âm thanh hiện tại có phải là khối đầu tiên của một phiên streaming hay không. Bộ trích xuất đặc trưng sử dụng center=True cho khối đầu tiên (và cho việc sử dụng offline) và center=False cho các khối tiếp theo, để STFT theo từng khối tái tạo lại, theo từng khung, một lượt xử lý toàn bộ câu nói. Phải là True khi is_streaming=False.
  • return_mm_token_type_ids (bool, kwargs) — Có nên trả về các id loại token đa phương tiện (multimodal token type ids) chỉ định vị trí của các token placeholder đa phương tiện hay không.
  • return_text_replacement_offsets (bool, kwargs) — Có nên trả về các vị trí ký tự cho mỗi placeholder đa phương thức và phần thay thế của nó hay không.
  • return_tensors (str hoặc TensorType, tùy chọn) — Nếu được đặt, sẽ trả về tensor của một framework cụ thể. Các giá trị chấp nhận được là:
    • 'pt': Trả về các đối tượng torch.Tensor của PyTorch.
    • 'np': Trả về các đối tượng np.ndarray của NumPy.
  • **kwargs (ProcessingKwargs, optional) — Các tùy chọn xử lý bổ sung cho từng modality (text, images, videos, audio). Các tham số cụ thể của model được liệt kê ở trên; xem lớp TypedDict để biết danh sách đầy đủ các đối số được hỗ trợ.

Trả về

BatchFeature

đầu ra của feature-extractor (và tokenizer tùy chọn), được bổ sung thêm:

  • num_lookahead_tokens — Ngữ cảnh chú ý phía bên phải (lookahead, trong các khung encoder được lấy mẫu con), tức là default_num_lookahead_tokens (được đặt thông qua set_num_lookahead_tokens()). Truyền nó vào forward của model/encoder (hoặc generate); nó đóng vai trò của num_delay_tokens của Voxtral Realtime.

decode

< >

( *argsdurations = None**kwargs )

Truyền các đối số tới decode() và xử lý hậu kỳ các mốc thời gian ở cấp độ token (nếu durations được cung cấp) theo cách của thư viện NeMo.

NemotronAsrStreamingEncoderModelOutput

lớp transformers.NemotronAsrStreamingEncoderModelOutput

< >

( last_hidden_state: typing.Optional[torch.Tensor] = Nonepooler_output: typing.Optional[torch.Tensor] = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = Noneattention_mask: typing.Optional[torch.Tensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Nonepadding_cache: transformers.models.nemotron_asr_streaming.modeling_nemotron_asr_streaming.NemotronAsrStreamingEncoderCausalConvPaddingCache | None = None )

Tham số

  • last_hidden_state (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size)) — Chuỗi các trạng thái ẩn (hidden-states) tại đầu ra của lớp cuối cùng của mô hình.
  • pooler_output (torch.Tensor có hình dạng (batch_size, hidden_size)) — Trạng thái ẩn của lớp cuối cùng cho token đầu tiên của chuỗi (token phân loại) sau khi được xử lý thêm qua các lớp dùng cho tác vụ tiền huấn luyện bổ trợ. Ví dụ, đối với các mô hình thuộc họ BERT, giá trị này trả về token phân loại sau khi được xử lý qua một lớp tuyến tính và một hàm kích hoạt tanh. Trọng số của lớp tuyến tính được huấn luyện từ mục tiêu dự đoán câu tiếp theo (phân loại) trong quá trình tiền huấn luyện.
  • hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Tuple của torch.Tensor (một cho đầu ra của embeddings, nếu model có lớp embedding, + một cho đầu ra của mỗi lớp) có shape (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

  • attention_mask (torch.Tensor có shape (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện attention trên các chỉ số token padding sau khi nén chuỗi. Được trả về vì độ dài chuỗi có thể khác với độ dài chuỗi đầu vào. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.
  • past_key_values (Cache, tùy chọn) — Bộ nhớ đệm K/V trượt cửa sổ của cơ chế chú ý đã cập nhật từ bộ mã hóa. Truyền vào lần gọi chunk tiếp theo.
  • padding_cache (NemotronAsrStreamingEncoderCausalConvPaddingCache, optional) — Bộ đệm streaming thống nhất hỗ trợ các lớp Conv2d subsampling và Conv1d depthwise của conformer.

Mở rộng ParakeetEncoderModelOutput với các bộ nhớ đệm (cache) tùy chọn cho streaming. Các bộ nhớ đệm chỉ được điền dữ liệu cho các model nhận thức được cache khi use_cache=True.

NemotronAsrStreamingRNNTOutput

lớp transformers.NemotronAsrStreamingRNNTOutput

< >

( last_hidden_state: typing.Optional[torch.Tensor] = Nonepooler_output: typing.Optional[torch.Tensor] = Nonehidden_states: tuple[torch.Tensor, ...] | None = Noneattentions: tuple[torch.Tensor, ...] | None = Noneloss: typing.Optional[torch.Tensor] = Nonelogits: typing.Optional[torch.Tensor] = Nonedecoder_cache: transformers.models.nemotron_asr_streaming.generation_nemotron_asr_streaming.NemotronAsrStreamingRNNTDecoderCache | None = Noneencoder_past_key_values: transformers.cache_utils.Cache | None = Nonepadding_cache: transformers.models.nemotron_asr_streaming.modeling_nemotron_asr_streaming.NemotronAsrStreamingEncoderCausalConvPaddingCache | None = None )

encoder_past_key_values (Cache, tuỳ chọn): Bộ nhớ đệm (cache) cửa sổ trượt K/V cho chú ý (attention) của bộ mã hóa (encoder), được cập nhật và trả về khi mã hóa âm thanh với use_cache=True (streaming nhận thức cache). Truyền nó vào bước forward của khối (chunk) tiếp theo. padding_cache (NemotronAsrStreamingEncoderCausalConvPaddingCache, tuỳ chọn): Bộ nhớ đệm conv streaming thống nhất (subsampling Conv2d + conformer depthwise Conv1d) đã được cập nhật, trả về khi mã hóa âm thanh với use_cache=True. Truyền nó vào bước forward của khối tiếp theo.

NemotronAsrStreamingEncoder

lớp transformers.NemotronAsrStreamingEncoder

< >

( config: NemotronAsrStreamingEncoderConfig )

Tham số

  • config (NemotronAsrStreamingEncoderConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

Mô hình Encoder NemotronAsrStreaming, dựa trên kiến trúc Fast Conformer.

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( input_features: Tensorattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneoutput_attention_mask: bool = Trueuse_cache: bool | None = Nonepadding_cache: transformers.models.nemotron_asr_streaming.modeling_nemotron_asr_streaming.NemotronAsrStreamingEncoderCausalConvPaddingCache | None = Nonenum_lookahead_tokens: int | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → BaseModelOutput or tuple(torch.Tensor)

Tham số

  • input_features (torch.Tensor có hình dạng (batch_size, sequence_length, feature_dim)) — Các tensor tương ứng với các đặc trưng âm thanh đầu vào. Các đặc trưng âm thanh có thể được lấy bằng cách sử dụng feature_extractor_class. Xem feature_extractor_class.__call__ để biết chi tiết (processor_class sử dụng feature_extractor_class để xử lý âm thanh).
  • attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • position_ids (torch.LongTensor có hình dạng (batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng [0, config.n_positions - 1].

    ID vị trí là gì?

  • past_key_values (Cache, tùy chọn) — Bộ nhớ đệm K/V cửa sổ trượt (DynamicCache được xây dựng từ config.sliding_window) cho chú ý streaming nhận thức bộ nhớ đệm.
  • output_attention_mask (bool, tùy chọn, mặc định là True) — Có trả về output attention mask hay không. Chỉ có hiệu lực khi attention_mask được cung cấp.
  • use_cache (bool, tùy chọn) — Nếu đặt thành True, các trạng thái key value của past_key_values sẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xem past_key_values).
  • padding_cache (NemotronAsrStreamingEncoderCausalConvPaddingCache, optional) — Bộ đệm streaming thống nhất hỗ trợ các lớp Conv2d subsampling và Conv1d depthwise của conformer.
  • num_lookahead_tokens (int, tùy chọn) — Ghi đè ngữ cảnh chú ý bên phải (lookahead, trong các khung encoder được lấy mẫu con) cho lần truyền tiến này. Kết hợp với ngữ cảnh bên trái config.sliding_window - 1. Mặc định là config.default_num_lookahead_tokens.

Trả về

BaseModelOutput hoặc tuple(torch.Tensor)

Một BaseModelOutput hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (None) và đầu vào.

Phương thức forward của NemotronAsrStreamingEncoder ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • last_hidden_state (torch.Tensor có hình dạng (batch_size, sequence_length, hidden_size)) — Chuỗi các hidden-state tại đầu ra của lớp cuối cùng của mô hình.

  • hidden_states (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_hidden_states=True được truyền vào hoặc khi config.output_hidden_states=True) — Bộ tuple của torch.Tensor (một cho đầu ra của embeddings, nếu mô hình có lớp embedding, + một cho đầu ra của mỗi lớp) có hình dạng (batch_size, sequence_length, hidden_size).

    Trạng thái ẩn của mô hình tại đầu ra của mỗi lớp cùng với các đầu ra embedding ban đầu tùy chọn.

  • attentions (tuple(torch.Tensor), tuỳ chọn, được trả về khi output_attentions=True được truyền vào hoặc khi config.output_attentions=True) — Tuple của torch.Tensor (một cho mỗi lớp) có hình dạng (batch_size, num_heads, sequence_length, sequence_length).

    Trọng số chú ý sau softmax của attention, được sử dụng để tính trung bình có trọng số trong các đầu self-attention.

Ví dụ:

>>> from transformers import AutoProcessor, NemotronAsrStreamingEncoder
>>> from datasets import load_dataset, Audio

>>> model_id = "nvidia/nemotron-speech-streaming-en-0.6b"
>>> processor = AutoProcessor.from_pretrained(model_id)
>>> encoder = NemotronAsrStreamingEncoder.from_pretrained(model_id)

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> ds = ds.cast_column("audio", Audio(sampling_rate=processor.feature_extractor.sampling_rate))

>>> inputs = processor(ds[0]["audio"]["array"])
>>> encoder_outputs = encoder(**inputs)

>>> print(encoder_outputs.last_hidden_state.shape)

NemotronAsrStreamingForRNNT

lớp transformers.NemotronAsrStreamingForRNNT

< >

( config: NemotronAsrStreamingConfig )

Tham số

  • config (NemotronAsrStreamingConfig) — Lớp cấu hình mô hình chứa tất cả các tham số của mô hình. Khởi tạo bằng tệp cấu hình sẽ không tải trọng số liên quan đến mô hình, chỉ tải cấu hình. Xem phương thức from_pretrained() để tải trọng số của mô hình.

NemotronAsrStreaming Encoder với đầu RNN-T (Recurrent Neural Network Transducer).

Mô hình này kế thừa từ PreTrainedModel. Xem tài liệu của lớp cha để biết các phương thức chung mà thư viện triển khai cho tất cả các mô hình của nó (chẳng hạn như tải xuống hoặc lưu trữ, thay đổi kích thước các nhúng đầu vào, cắt tỉa các đầu, v.v.)

Mô hình này cũng là một lớp con của torch.nn.Module trong PyTorch. Hãy sử dụng nó như một Module PyTorch thông thường và tham khảo tài liệu PyTorch cho mọi vấn đề liên quan đến cách sử dụng và hành vi chung.

forward

< >

( input_features: typing.Optional[torch.Tensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Nonedecoder_input_ids: typing.Optional[torch.LongTensor] = Nonedecoder_cache: transformers.models.nemotron_asr_streaming.generation_nemotron_asr_streaming.NemotronAsrStreamingRNNTDecoderCache | None = Noneuse_decoder_cache: bool | None = Noneencoder_outputs: transformers.models.nemotron_asr_streaming.modeling_nemotron_asr_streaming.NemotronAsrStreamingEncoderModelOutput | None = Nonelabels: typing.Optional[torch.Tensor] = Nonenum_lookahead_tokens: int | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → NemotronAsrStreamingRNNTOutput or tuple(torch.Tensor)

Tham số

  • input_features (torch.Tensor có hình dạng (batch_size, sequence_length, feature_dim), tùy chọn) — Các tensor tương ứng với các đặc trưng âm thanh đầu vào. Các đặc trưng âm thanh có thể được lấy bằng cách sử dụng feature_extractor_class. Xem feature_extractor_class.__call__ để biết chi tiết (processor_class sử dụng feature_extractor_class để xử lý âm thanh).
  • attention_mask (torch.Tensor có hình dạng (batch_size, sequence_length), tùy chọn) — Mặt nạ để tránh thực hiện chú ý trên các chỉ số token đệm. Các giá trị mặt nạ được chọn trong [0, 1]:
    • 1 cho các token không bị che,
    • 0 cho các token bị che.

    Mặt nạ chú ý là gì?

  • decoder_input_ids (torch.LongTensor có hình dạng (batch_size, 1), tùy chọn) — Các id token đầu vào của bộ giải mã cho suy luận một bước.
  • decoder_cache (NemotronAsrStreamingRNNTDecoderCache, optional) — Bộ đệm LSTM của bộ giải mã. Được tái sử dụng khi dự đoán khoảng trắng để bỏ qua bước LSTM.
  • use_decoder_cache (bool, tùy chọn) — Có cấp phát và sử dụng bộ đệm giải mã (decoder cache) khi không có bộ đệm nào được cung cấp hay không.
  • encoder_outputs (NemotronAsrStreamingEncoderModelOutput, tuỳ chọn) — Đầu ra của bộ mã hóa đã được tính trước (last_hidden_state, pooler_output, …).
  • labels (torch.Tensor có shape (batch_size, sequence_length), tùy chọn) — Nhãn để tính toán tổn thất mô hình hóa ngôn ngữ có che (masked language modeling loss). Chỉ số phải nằm trong [0, ..., config.vocab_size] hoặc -100 (xem docstring của input_ids). Các token có chỉ số được đặt thành -100 sẽ bị bỏ qua (che), tổn thất chỉ được tính cho các token có nhãn nằm trong [0, ..., config.vocab_size].
  • num_lookahead_tokens (int, tùy chọn) — Bối cảnh chú ý phía bên phải (lookahead, tính theo các khung encoder đã lấy mẫu thưa) được chuyển tiếp đến encoder. Mặc định là config.encoder_config.default_num_lookahead_tokens.

Trả về

NemotronAsrStreamingRNNTOutput hoặc tuple(torch.Tensor)

Một NemotronAsrStreamingRNNTOutput hoặc một tuple của torch.Tensor (nếu return_dict=False được truyền hoặc khi config.return_dict=False) bao gồm các thành phần khác nhau tùy thuộc vào cấu hình (None) và đầu vào.

Phương thức forward của NemotronAsrStreamingForRNNT ghi đè lên phương thức đặc biệt __call__.

Mặc dù công thức cho bước truyền tiến cần được định nghĩa bên trong hàm này, người dùng nên gọi instance của Module sau đó thay vì gọi hàm này, vì instance Module sẽ đảm nhận việc thực hiện các bước tiền xử lý và hậu xử lý, trong khi hàm này sẽ lặng lẽ bỏ qua chúng.

  • encoder_past_key_values (Cache, tuỳ chọn) — Bản cập nhật của cache trượt cửa sổ K/V cho encoder attention, được trả về khi mã hóa âm thanh với use_cache=True (streaming nhận thức cache). Hãy truyền nó vào bước forward của chunk tiếp theo.
  • padding_cache (NemotronAsrStreamingEncoderCausalConvPaddingCache, optional) — Bộ đệm conv streaming thống nhất đã cập nhật (subsampling Conv2d + conformer depthwise Conv1d), được trả về khi mã hóa âm thanh với use_cache=True. Truyền nó vào bước forward của chunk tiếp theo.

Ví dụ:

>>> from transformers import AutoProcessor, NemotronAsrStreamingForRNNT
>>> from datasets import load_dataset, Audio

>>> model_id = "nvidia/nemotron-speech-streaming-en-0.6b"
>>> processor = AutoProcessor.from_pretrained(model_id)
>>> model = NemotronAsrStreamingForRNNT.from_pretrained(model_id)

>>> ds = load_dataset("hf-internal-testing/librispeech_asr_dummy", "clean", split="validation")
>>> ds = ds.cast_column("audio", Audio(sampling_rate=processor.feature_extractor.sampling_rate))

>>> inputs = processor(ds[0]["audio"]["array"])
>>> outputs = model(**inputs)

generate

< >

( inputs = Nonegeneration_config = None**kwargs )

Update on GitHub