Transformers documentation
Wav2Vec2-BERT
Mô hình này được công bố trên HF papers vào ngày 2023-12-08 và được đóng góp cho Hugging Face Transformers vào ngày 2024-01-18.
Wav2Vec2-BERT
Tổng quan
Mô hình Wav2Vec2-BERT được đề xuất trong Seamless: Multilingual Expressive and Streaming Speech Translation bởi nhóm Seamless Communication từ Meta AI.
Mô hình này được huấn luyện trước trên 4,5 triệu giờ dữ liệu âm thanh không nhãn, bao phủ hơn 143 ngôn ngữ. Nó cần được tinh chỉnh để sử dụng cho các tác vụ hạ nguồn như Nhận dạng giọng nói tự động (ASR) hoặc Phân loại âm thanh.
Kết quả chính thức của mô hình có thể được tìm thấy trong Mục 3.2.1 của bài báo.
Tóm tắt từ bài báo như sau:
Những tiến bộ gần đây trong dịch thuật giọng nói tự động đã mở rộng đáng kể phạm vi ngôn ngữ, cải thiện khả năng đa phương thức và cho phép thực hiện nhiều tác vụ cũng như tính năng đa dạng. Tuy nhiên, so với hội thoại giữa người với người, các hệ thống dịch thuật giọng nói tự động quy mô lớn hiện nay vẫn thiếu những tính năng then chốt giúp giao tiếp qua máy móc trở nên liền mạch. Trong công trình này, chúng tôi giới thiệu một họ các mô hình cho phép dịch thuật đa ngôn ngữ và giàu cảm xúc theo phương thức streaming từ đầu đến cuối. Trước tiên, chúng tôi đóng góp một phiên bản cải tiến của mô hình đa ngôn ngữ và đa phương thức quy mô lớn SeamlessM4T—SeamlessM4T v2. Mô hình mới hơn này, tích hợp khung UnitY2 được cập nhật, đã được huấn luyện trên nhiều dữ liệu ngôn ngữ nguồn thấp hơn. Phiên bản mở rộng của SeamlessAlign bổ sung 114.800 giờ dữ liệu được căn chỉnh tự động, nâng tổng số lên 76 ngôn ngữ. SeamlessM4T v2 cung cấp nền tảng để khởi tạo hai mô hình mới nhất của chúng tôi: SeamlessExpressive và SeamlessStreaming. SeamlessExpressive cho phép dịch thuật bảo toàn phong cách giọng nói và ngữ điệu. So với các nỗ lực trước đây trong nghiên cứu giọng nói giàu cảm xúc, công trình của chúng tôi giải quyết một số khía cạnh của ngữ điệu chưa được khám phá nhiều, chẳng hạn như tốc độ nói và các khoảng dừng, đồng thời bảo toàn phong cách giọng nói của người nói. Về SeamlessStreaming, mô hình của chúng tôi tận dụng cơ chế Efficient Monotonic Multihead Attention (EMMA) để tạo ra bản dịch đích có độ trễ thấp mà không cần chờ câu nguồn hoàn chỉnh. Là mô hình đầu tiên thuộc loại này, SeamlessStreaming cho phép dịch đồng thời giọng nói sang giọng nói/văn bản cho nhiều ngôn ngữ nguồn và đích. Để đánh giá hiệu suất của các mô hình này, chúng tôi kết hợp các chỉ số tự động mới và các phiên bản sửa đổi của các chỉ số hiện có để đánh giá ngữ điệu, độ trễ và độ bền vững. Đối với đánh giá của con người, chúng tôi điều chỉnh các giao thức hiện có để đo lường các thuộc tính liên quan nhất trong việc bảo toàn ý nghĩa, tính tự nhiên và tính biểu cảm. Để đảm bảo các mô hình của chúng tôi có thể được sử dụng một cách an toàn và có trách nhiệm, chúng tôi đã triển khai nỗ lực red-teaming đầu tiên được biết đến cho dịch thuật máy đa phương thức, một hệ thống phát hiện và giảm thiểu độc tính được thêm vào, một đánh giá có hệ thống về thiên kiến giới tính, và một cơ chế đánh dấu nước địa phương không thể nghe thấy được thiết kế để làm giảm tác động của deepfake. Do đó, chúng tôi kết hợp các thành phần chính từ SeamlessExpressive và SeamlessStreaming để tạo thành Seamless, hệ thống công khai đầu tiên mở ra giao tiếp đa ngôn ngữ giàu cảm xúc theo thời gian thực. Tóm lại, Seamless mang đến cho chúng tôi cái nhìn then chốt về nền tảng kỹ thuật cần thiết để biến Universal Speech Translator từ một khái niệm khoa học viễn tưởng thành công nghệ thực tế. Cuối cùng, các đóng góp trong công trình này—including mô hình, mã nguồn và trình phát hiện đánh dấu nước—được công bố công khai và có thể truy cập tại liên kết bên dưới.
Mô hình này được đóng góp bởi ylacombe. Mã gốc có thể được tìm thấy tại đây.
Mẹo sử dụng
- Wav2Vec2-BERT tuân theo cùng kiến trúc như Wav2Vec2-Conformer, nhưng sử dụng một lớp tích chập chiều sâu nhân quả và dùng làm đầu vào một biểu diễn mel-spectrogram của âm thanh thay vì dạng sóng thô.
- Wav2Vec2-BERT có thể sử dụng một trong các loại sau: không dùng position embeddings, position embeddings kiểu Shaw, position embeddings kiểu Transformer-XL, hoặc rotary position embeddings, bằng cách đặt giá trị đúng cho
config.position_embeddings_type. - Wav2Vec2-BERT cũng giới thiệu một mạng adapter dựa trên Conformer thay vì một mạng tích chập đơn giản.
Tài nguyên
- Bạn cũng có thể điều chỉnh các notebook này về cách tinh chỉnh mô hình nhận dạng giọng nói bằng tiếng Anh và cách tinh chỉnh mô hình nhận dạng giọng nói bằng bất kỳ ngôn ngữ nào.
- Xem thêm: Hướng dẫn tác vụ phân loại âm thanh
Wav2Vec2BertConfig
lớp transformers.Wav2Vec2BertConfig
< source >( 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 = Nonevocab_size: int | None = Nonehidden_size: int = 1024num_hidden_layers: int = 24num_attention_heads: int = 16intermediate_size: int = 4096feature_projection_input_dim: int = 160hidden_act: str = 'swish'hidden_dropout: float | int = 0.0activation_dropout: float | int = 0.0attention_dropout: float | int = 0.0feat_proj_dropout: float | int = 0.0final_dropout: float | int = 0.1layerdrop: float | int = 0.1initializer_range: float = 0.02layer_norm_eps: float = 1e-05apply_spec_augment: bool = Truemask_time_prob: float | int = 0.05mask_time_length: int = 10mask_time_min_masks: int = 2mask_feature_prob: float | int = 0.0mask_feature_length: int = 10mask_feature_min_masks: int = 0ctc_loss_reduction: str = 'sum'ctc_zero_infinity: bool = Falseuse_weighted_layer_sum: bool = Falseclassifier_proj_size: int = 768tdnn_dim: list[int] | tuple[int, ...] = (512, 512, 512, 512, 1500)tdnn_kernel: list[int] | tuple[int, ...] = (5, 3, 3, 1, 1)tdnn_dilation: list[int] | tuple[int, ...] = (1, 2, 3, 1, 1)xvector_output_dim: int = 512pad_token_id: int | None = 0bos_token_id: int | None = 1eos_token_id: int | list[int] | None = 2add_adapter: bool = Falseadapter_kernel_size: int = 3adapter_stride: int = 2num_adapter_layers: int = 1adapter_act: str = 'relu'use_intermediate_ffn_before_adapter: bool = Falseoutput_hidden_size: int | None = Noneposition_embeddings_type: typing.Optional[typing.Literal['rotary', 'relative', 'relative_key']] = 'relative_key'rotary_embedding_base: int = 10000max_source_positions: int = 5000left_max_position_embeddings: int = 64right_max_position_embeddings: int = 8conv_depthwise_kernel_size: int = 31conformer_conv_dropout: float | int = 0.1 )
Tham số
- vocab_size (
int, tùy chọn) — 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ởiinput_ids. - 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à16) — 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. - feature_projection_input_dim (
int, tùy chọn, mặc định là 160) — Kích thước đầu vào của mô hình này, tức là kích thước sau khi xử lý âm thanh đầu vào bằng SeamlessM4TFeatureExtractor hoặc Wav2Vec2BertProcessor. - hidden_act (
str, tùy chọn, mặc định làswish) — 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. - hidden_dropout (
Union[float, int], tùy chọn, mặc định là0.0) — Xác suất dropout cho tất cả các lớp fully connected trong embeddings, encoder và pooler. - activation_dropout (
Union[float, int], tùy chọn, mặc định là0.0) — 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.0) — Tỷ lệ dropout cho các xác suất chú ý. - feat_proj_dropout (
float, tùy chọn, mặc định là 0.0) — Xác suất dropout cho phép chiếu đặc trưng. - final_dropout (
float, tùy chọn, mặc định là 0.1) — Xác suất dropout cho lớp chiếu cuối cùng của Wav2Vec2BertForCTC. - 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. - 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ố. - layer_norm_eps (
float, tùy chọn, mặc định là1e-05) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization). - apply_spec_augment (
bool, tùy chọn, mặc định làTrue) — Liệu có áp dụng tăng cường dữ liệu SpecAugment cho đầu ra của bộ mã hóa đặc trưng hay không. Để tham khảo, xem SpecAugment: A Simple Data Augmentation Method for Automatic Speech Recognition. - mask_time_prob (
float, optional, defaults to 0.05) — Percentage (between 0 and 1) of all feature vectors along the time axis which will be masked. The masking procedure generatesmask_time_prob*len(time_axis)/mask_time_length ``independent masks over the axis. If reasoning from the probability of each feature vector to be chosen as the start of the vector span to be masked, *mask_time_prob* should beprob_vector_start*mask_time_length. Note that overlap may decrease the actual percentage of masked vectors. This is only relevant ifapply_spec_augment is True`. - mask_time_length (
int, tùy chọn, mặc định là 10) — Chiều dài của khoảng vector dọc theo trục thời gian. - mask_time_min_masks (
int, tùy chọn, mặc định là 2) — Số lượng tối thiểu các mặt nạ có độ dàimask_feature_lengthđược tạo dọc theo trục thời gian, cho mỗi bước thời gian, bất kểmask_feature_prob. Chỉ liên quan nếumask_time_prob*len(time_axis)/mask_time_length < mask_time_min_masks. - mask_feature_prob (
float, tùy chọn, mặc định là 0.0) — Tỷ lệ phần trăm (từ 0 đến 1) của tất cả các vector đặc trưng dọc theo trục đặc trưng sẽ bị che. Quy trình che tạo ramask_feature_prob*len(feature_axis)/mask_time_lengthcác mặt nạ độc lập trên trục. Nếu suy luận từ xác suất của mỗi vector đặc trưng được chọn làm điểm bắt đầu của khoảng vector sẽ bị che, mask_feature_prob nên làprob_vector_start*mask_feature_length. Lưu ý rằng sự chồng lấn có thể làm giảm tỷ lệ phần trăm thực tế của các vector bị che. Điều này chỉ liên quan nếuapply_spec_augment is True. - mask_feature_length (
int, tùy chọn, mặc định là 10) — Chiều dài của khoảng vector dọc theo trục đặc trưng. - mask_feature_min_masks (
int, tùy chọn, mặc định là 0) — Số lượng tối thiểu các mặt nạ có độ dàimask_feature_lengthđược tạo ra dọc theo trục đặc trưng, ở mỗi bước thời gian, bất kể giá trị củamask_feature_prob. Chỉ có ý nghĩa nếumask_feature_prob*len(feature_axis)/mask_feature_length < mask_feature_min_masks. - ctc_loss_reduction (
str, tùy chọn, mặc định làsum) — Chỉ định phương pháp giảm (reduction) áp dụng cho đầu ra củatorch.nn.CTCLoss. Chỉ liên quan khi huấn luyện. - ctc_zero_infinity (
bool, tuỳ chọn, mặc định làFalse) — Có nên đặt bằng 0 các loss vô hạn và các gradient liên quan củatorch.nn.CTCLosshay không. Các loss vô hạn chủ yếu xảy ra khi các đầu vào quá ngắn để có thể căn chỉnh với các target. Chỉ liên quan khi huấn luyện một instance của Wav2Vec2BertForCTC. - use_weighted_layer_sum (
bool, tùy chọn, mặc định làFalse) — Có sử dụng trung bình có trọng số của đầu ra các lớp với trọng số được học hay không. Chỉ liên quan khi sử dụng một instance của Wav2Vec2BertForSequenceClassification. - classifier_proj_size (
int, tùy chọn, mặc định là 768) — Kích thước của phép chiếu trước khi lấy trung bình token (mean-pooling) cho phân loại. - tdnn_dim (
tuple[int]hoặclist[int], tùy chọn, mặc định là(512, 512, 512, 512, 1500)) — Một tuple các số nguyên xác định số lượng kênh đầu ra của mỗi lớp tích chập 1D trong module TDNN của mô hình XVector. Độ dài của tdnn_dim xác định số lượng lớp TDNN. - tdnn_kernel (
tuple[int]hoặclist[int], tùy chọn, mặc định là(5, 3, 3, 1, 1)) — Một tuple các số nguyên xác định kích thước kernel của từng lớp tích chập 1D trong module TDNN của mô hình XVector. Độ dài của tdnn_kernel phải khớp với độ dài của tdnn_dim. - tdnn_dilation (
tuple[int]hoặclist[int], tùy chọn, mặc định là(1, 2, 3, 1, 1)) — Một tuple các số nguyên xác định hệ số giãn nở (dilation factor) của từng lớp tích chập 1D trong module TDNN của mô hình XVector. Độ dài của tdnn_dilation phải khớp với độ dài của tdnn_dim. - xvector_output_dim (
int, tùy chọn, mặc định là 512) — Kích thước của các vector nhúng XVector. - 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. - bos_token_id (
int, tùy chọn, mặc định là1) — Token id được sử dụng cho beginning-of-stream trong bảng từ vựng. - eos_token_id (
Union[int, list[int]], tùy chọn, mặc định là2) — Token id được sử dụng cho end-of-stream trong bảng từ vựng. - add_adapter (
bool, tuỳ chọn, mặc định làFalse) — Liệu có nên xếp chồng một mạng attention tích chập lên trên Encoder của Wav2Vec2Bert hay không. Có thể rất hữu ích để khởi động nóng Wav2Vec2Bert cho các mô hình SpeechEncoderDecoder. - adapter_kernel_size (
int, tuỳ chọn, mặc định là 3) — Kích thước kernel của các lớp tích chập trong mạng adapter. Chỉ liên quan nếuadd_adapter is True. - adapter_stride (
int, tuỳ chọn, mặc định là 2) — Stride của các lớp convolution trong mạng adapter. Chỉ liên quan nếuadd_adapter is True. - num_adapter_layers (
int, tuỳ chọn, mặc định là 1) — Số lượng lớp tích chập cần được sử dụng trong mạng adapter. Chỉ liên quan nếuadd_adapter is True. - adapter_act (
strhoặcfunction, tùy chọn, mặc định là"relu") — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong các lớp adapter. Nếu là chuỗi,"gelu","relu","selu","swish"và"gelu_new"được hỗ trợ. - use_intermediate_ffn_before_adapter (
bool, tuỳ chọn, mặc định làFalse) — Liệu một khối feed-forward trung gian có nên được xếp chồng lên Encoder của Wav2Vec2Bert và đặt trước mạng adapter hay không. Chỉ liên quan nếuadd_adapter is True. - output_hidden_size (
int, tùy chọn) — Kích thước chiều của lớp đầu ra bộ mã hóa. Nếu không được định nghĩa, giá trị mặc định là hidden-size. Chỉ có liên quan nếuadd_adapter is True. - position_embeddings_type (
str, tuỳ chọn, mặc định là"relative_key") — Có thể được chỉ định thành:rotary, cho các nhúng vị trí quay (rotary position embeddings).relative, cho các nhúng vị trí tương đối.relative_key, cho các nhúng vị trí tương đối như được định nghĩa bởi Shaw trong Self-Attention with Relative Position Representations (Shaw et al.). Nếu để làNone, sẽ không áp dụng nhúng vị trí tương đối.
- rotary_embedding_base (
int, tuỳ chọn, mặc định là 10000) — Nếu sử dụng nhúng vị trí"rotary", định nghĩa kích thước của cơ sở nhúng. - max_source_positions (
int, tùy chọn, mặc định là 5000) — nếu sử dụng position embeddings"relative", định nghĩa vị trí đầu vào nguồn tối đa. - left_max_position_embeddings (
int, tùy chọn, mặc định là 64) — Nếu sử dụng position embeddings"relative_key"(còn gọi là Shaw), tham số này định nghĩa giá trị cắt (clipping) bên trái cho các vị trí tương đối. - right_max_position_embeddings (
int, tùy chọn, mặc định là 8) — Nếu sử dụng position embeddings"relative_key"(còn gọi là Shaw), định nghĩa giá trị cắt phía phải cho các vị trí tương đối. - conv_depthwise_kernel_size (
int, tùy chọn, mặc định là 31) — Kích thước kernel của lớp convolution depthwise 1D trong các khối Conformer. - conformer_conv_dropout (
float, tùy chọn, mặc định là 0.1) — Xác suất dropout cho tất cả các lớp tích chập trong các khối Conformer.
Đây là lớp cấu hình để lưu trữ cấu hình của một Wav2Vec2 BertModel. Nó được sử dụng để khởi tạo một mô hình Wav2Vec2 Bert theo các đối số được chỉ định, xác định kiến trúc của 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ấu hình của facebook/w2v-bert-2.0
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 Wav2Vec2BertConfig, Wav2Vec2BertModel
>>> # Initializing a Wav2Vec2Bert facebook/wav2vec2-bert-rel-pos-large style configuration
>>> configuration = Wav2Vec2BertConfig()
>>> # Initializing a model (with random weights) from the facebook/wav2vec2-bert-rel-pos-large style configuration
>>> model = Wav2Vec2BertModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configWav2Vec2BertProcessor
lớp transformers.Wav2Vec2BertProcessor
< source >( feature_extractortokenizer )
Tạo một Wav2Vec2BertProcessor đó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.
Wav2Vec2BertProcessor cung cấp đầy đủ các chức năng của Wav2Vec2FeatureExtractor và Wav2Vec2CTCTokenizer. Xem ~Wav2Vec2FeatureExtractor và ~Wav2Vec2CTCTokenizer để biết thêm thông tin.
__call__
< source >( audio: typing.Union[numpy.ndarray, ForwardRef('torch.Tensor'), list[numpy.ndarray], list['torch.Tensor'], NoneType] = Nonetext: str | list[str] | None = None**kwargs: *<class 'transformers.models.wav2vec2_bert.processing_wav2vec2_bert.Wav2Vec2BertProcessorKwargs'> ) → BatchEncoding
Tham số
- audio (
Union[numpy.ndarray, torch.Tensor, list[numpy.ndarray], list[torch.Tensor]], optional) — Â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]], 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 đặtis_split_into_words=Trueđể tránh nhầm lẫn với các đầu vào dạng lô. - return_tensors (
strhoặ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ượngtorch.Tensorcủa PyTorch.'np': Trả về các đối tượngnp.ndarraycủ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ề
Một BatchEncoding với các trường sau:
- input_features — Các đặc trưng đầu vào âm thanh để đưa vào mô hình. Được trả về khi
audiokhông phảiNone. - attention_mask — Danh sách các chỉ số xác định những mốc thời gian nào mà mô hình cần chú ý khi
audiokhông phảiNone. Khi chỉ cótextđược chỉ định, trả về mặt nạ chú ý của token. - labels — Danh sách các id token để đưa vào mô hình. Được trả về khi cả
textvàaudiođều không phảiNone. - input_ids — Danh sách các token id để đưa vào mô hình. Được trả về khi
textkhông phảiNonevàaudiolàNone.
Nếu input_features không phải là None, phương thức này sẽ chuyển các đối số input_features và kwargs đến pad() của SeamlessM4TFeatureExtractor để đệm các đặc trưng đầu vào.
Nếu labels không phải là None, phương thức này sẽ chuyển các đối số labels và kwargs đến pad() của PreTrainedTokenizer để đệm nhãn.
Vui lòng tham khảo docstring của hai phương thức trên để biết thêm thông tin.
from_pretrained
< source >( pretrained_model_name_or_path: str | os.PathLikecache_dir: str | os.PathLike | None = Noneforce_download: bool = Falselocal_files_only: bool = Falsetoken: str | bool | None = Nonerevision: str = 'main'**kwargs )
Tham số
- pretrained_model_name_or_path (
strhoặcos.PathLike) — Đây có thể là:- một chuỗi, model id của một feature_extractor được huấn luyện trước lưu trữ trong một kho model trên huggingface.co.
- đường dẫn đến một thư mục chứa tệp feature extractor được lưu bằng phương thức
save_pretrained(), ví dụ:
./my_model_directory/. - đường dẫn đến tệp JSON bộ trích xuất đặc trưng đã lưu tệp, ví dụ:
./my_model_directory/preprocessor_config.json.
- **kwargs —
Các đối số từ khóa bổ sung được truyền đến cả
from_pretrained() và
~tokenization_utils_base.PreTrainedTokenizer.from_pretrained.
Tạo một processor liên kết với một model được huấn luyện trước.
Phương thức lớp này đơn giản là gọi phương thức from_pretrained() của bộ trích xuất đặc trưng, ImageProcessingMixin của bộ xử lý ảnh và
~tokenization_utils_base.PreTrainedTokenizer.from_pretrainedcủa bộ phân từ. Vui lòng tham khảo các docstring của các phương thức ở trên để biết thêm thông tin.
save_pretrained
< source >( save_directorypush_to_hub: bool = False**kwargs )
Tham số
- save_directory (
strhoặcos.PathLike) — Thư mục nơi tệp JSON của bộ trích xuất đặc trưng và các tệp tokenizer sẽ được lưu (thư mục sẽ được tạo nếu chưa tồn tại). - push_to_hub (
bool, tùy chọn, mặc định làFalse) — Có đẩy mô hình của bạn lên Hugging Face model hub sau khi lưu hay không. Bạn có thể chỉ định kho lưu trữ muốn đẩy đến bằngrepo_id(mặc định sẽ là tên củasave_directorytrong namespace của bạn). - kwargs (
dict[str, Any], tùy chọn) — Các đối số từ khóa bổ sung được truyền đến phương thức push_to_hub().
Lưu các thuộc tính của bộ xử lý này (bộ trích xuất đặc trưng, bộ phân từ…) vào thư mục được chỉ định để có thể tải lại bằng phương thức from_pretrained().
Phương thức lớp này đơn giản chỉ gọi save_pretrained() và save_pretrained(). Vui lòng tham khảo docstring của các phương thức ở trên để biết thêm thông tin.
Phương pháp này chuyển tiếp tất cả các đối số của nó đến batch_decode() của PreTrainedTokenizer. Vui lòng tham khảo docstring của phương pháp này để biết thêm thông tin.
Phương pháp này chuyển tiếp tất cả các đối số của nó đến decode() của PreTrainedTokenizer. Vui lòng tham khảo docstring của phương pháp này để biết thêm thông tin.
Wav2Vec2BertModel
lớp transformers.Wav2Vec2BertModel
< source >( config: Wav2Vec2BertConfig )
Tham số
- config (Wav2Vec2BertConfig) — 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 Wav2Vec2 Bert cơ bản, xuất ra các hidden-state thô mà không có bất kỳ head cụ thể nào ở phía trên.
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
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonemask_time_indices: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → Wav2Vec2BaseModelOutput or tuple(torch.Tensor)
Tham số
- input_features (
torch.Tensorcó shape(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 Wav2Vec2FeatureExtractor. Xem Wav2Vec2FeatureExtractor.call() để biết thêm chi tiết (Wav2Vec2BertProcessor sử dụng Wav2Vec2FeatureExtractor để xử lý âm thanh). - attention_mask (
torch.Tensorcó 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.
- mask_time_indices (
torch.BoolTensorcó shape(batch_size, sequence_length), tuỳ chọn) — Các chỉ số để mask các đặc trưng đã trích xuất cho contrastive loss. Khi ở chế độ training, model học cách dự đoán các đặc trưng đã trích xuất bị mask trong không gian config.proj_codevector_dim.
Trả về
Wav2Vec2BaseModelOutput hoặc tuple(torch.Tensor)
Một Wav2Vec2BaseModelOutput 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 (Wav2Vec2BertConfig) và đầu vào.
Phương thức forward của Wav2Vec2BertModel 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
Modulesau đó thay vì gọi hàm này, vì instanceModulesẽ đả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.Tensorcó 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.extract_features (
torch.Tensorcó hình dạng(batch_size, sequence_length, conv_dim[-1])) — Chuỗi các vector đặc trưng đã trích xuất từ lớp tích chập cuối cùng của mô hình.hidden_states (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — Bộ tuple cáctorch.Tensor(một cho đầu ra của embeddings + 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 đầu ra của lớp nhúng ban đầu.
attentions (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_attentions=Trueđược truyền vào hoặc khiconfig.output_attentions=True) — Tuple củatorch.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.
Wav2Vec2BertForCTC
lớp transformers.Wav2Vec2BertForCTC
< source >( config: Wav2Vec2BertConfigtarget_lang: str | None = None )
Tham số
- config (Wav2Vec2BertConfig) — 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.
- target_lang (
str, tùy chọn) — Id của ngôn ngữ cho trọng số adapter. Trọng số adapter được lưu dưới định dạng adapter..safetensors hoặc adapter. .bin. Chỉ liên quan khi sử dụng một instance của UniSpeechSatForCTC với adapters. Mặc định sử dụng ‘eng’.
Mô hình Wav2Vec2Bert với đầu language modeling phía trên cho Connectionist Temporal Classification (CTC).
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
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CausalLMOutput or tuple(torch.Tensor)
Tham số
- input_features (
torch.Tensorcó shape(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 Wav2Vec2FeatureExtractor. Xem Wav2Vec2FeatureExtractor.call() để biết thêm chi tiết (Wav2Vec2BertProcessor sử dụng Wav2Vec2FeatureExtractor để xử lý âm thanh). - attention_mask (
torch.Tensorcó 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.
- labels (
torch.LongTensorcó shape(batch_size, target_length), tùy chọn) — Nhãn cho phân loại thời gian kết nối (connectionist temporal classification). Lưu ý rằngtarget_lengthphải nhỏ hơn hoặc bằng chiều dài chuỗi của logits đầu ra. Các chỉ số được chọn trong[-100, 0, ..., config.vocab_size - 1]. Tất cả các nhãn được đặt thành-100sẽ bị bỏ qua (masked), loss chỉ được tính cho các nhãn trong[0, ..., config.vocab_size - 1].
Trả về
CausalLMOutput hoặc tuple(torch.Tensor)
Một CausalLMOutput 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 (Wav2Vec2BertConfig) và đầu vào.
Phương thức forward của Wav2Vec2BertForCTC 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
Modulesau đó thay vì gọi hàm này, vì instanceModulesẽ đả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.
loss (
torch.Tensorcó shape(1,), tùy chọn, được trả về khilabelsđược cung cấp) — Loss của language modeling (cho next-token prediction).logits (
torch.Tensorcó hình dạng(batch_size, sequence_length, config.vocab_size)) — Điểm dự đoán của đầu mô hình hóa ngôn ngữ (điểm cho mỗi token trong từ vựng trước SoftMax).hidden_states (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — Bộ tuple củatorch.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ề khioutput_attentions=Trueđược truyền vào hoặc khiconfig.output_attentions=True) — Tuple củatorch.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, Wav2Vec2BertForCTC
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> processor = AutoProcessor.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForCTC.from_pretrained("facebook/w2v-bert-2.0")
>>> # audio file is decoded on the fly
>>> inputs = processor(dataset[0]["audio"]["array"], sampling_rate=sampling_rate, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_ids = torch.argmax(logits, dim=-1)
>>> # transcribe speech
>>> transcription = processor.batch_decode(predicted_ids)
>>> transcription[0]
...
>>> inputs["labels"] = processor(text=dataset[0]["text"], return_tensors="pt").input_ids
>>> # compute loss
>>> loss = model(**inputs).loss
>>> round(loss.item(), 2)
...Wav2Vec2BertForSequenceClassification
lớp transformers.Wav2Vec2BertForSequenceClassification
< source >( config: Wav2Vec2BertConfig )
Tham số
- config (Wav2Vec2BertConfig) — 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 Wav2Vec2Bert với một đầu phân loại chuỗi phía trên (một lớp tuyến tính trên đầu ra đã được gộp) cho các tác vụ như SUPERB Keyword Spotting.
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
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → SequenceClassifierOutput or tuple(torch.Tensor)
Tham số
- input_features (
torch.Tensorcó shape(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 Wav2Vec2FeatureExtractor. Xem Wav2Vec2FeatureExtractor.call() để biết thêm chi tiết (Wav2Vec2BertProcessor sử dụng Wav2Vec2FeatureExtractor để xử lý âm thanh). - attention_mask (
torch.Tensorcó 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.
- labels (
torch.LongTensorcó shape(batch_size,), tùy chọn) — Nhãn để tính loss cho phân loại/hồi quy chuỗi. Chỉ số phải nằm trong[0, ..., config.num_labels - 1]. Nếuconfig.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếuconfig.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
Trả về
SequenceClassifierOutput hoặc tuple(torch.Tensor)
Một SequenceClassifierOutput 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 (Wav2Vec2BertConfig) và đầu vào.
Phương thức forward của Wav2Vec2BertForSequenceClassification 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
Modulesau đó thay vì gọi hàm này, vì instanceModulesẽ đả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.
loss (
torch.Tensorcó shape(1,), optional, được trả về khilabelsđược cung cấp) — Loss phân loại (hoặc hồi quy nếu config.num_labels==1).logits (
torch.Tensorcó hình dạng(batch_size, config.num_labels)) — Điểm phân loại (hoặc hồi quy nếu config.num_labels==1) (trước SoftMax).hidden_states (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — Bộ tuple củatorch.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ề khioutput_attentions=Trueđược truyền vào hoặc khiconfig.output_attentions=True) — Tuple củatorch.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ụ về phân loại nhãn đơn:
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_id = logits.argmax().item()
>>> model.config.id2label[predicted_class_id]
...
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0", num_labels=num_labels)
>>> labels = torch.tensor([1])
>>> loss = model(**inputs, labels=labels).loss
>>> round(loss.item(), 2)
...Ví dụ về phân loại đa nhãn:
>>> import torch
>>> from transformers import AutoTokenizer, Wav2Vec2BertForSequenceClassification
>>> tokenizer = AutoTokenizer.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained("facebook/w2v-bert-2.0", problem_type="multi_label_classification")
>>> inputs = tokenizer("Hello, my dog is cute", return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> predicted_class_ids = torch.arange(0, logits.shape[-1])[torch.sigmoid(logits).squeeze(dim=0) > 0.5]
>>> # To train a model on `num_labels` classes, you can pass `num_labels=num_labels` to `.from_pretrained(...)`
>>> num_labels = len(model.config.id2label)
>>> model = Wav2Vec2BertForSequenceClassification.from_pretrained(
... "facebook/w2v-bert-2.0", num_labels=num_labels, problem_type="multi_label_classification"
... )
>>> labels = torch.sum(
... torch.nn.functional.one_hot(predicted_class_ids[None, :].clone(), num_classes=num_labels), dim=1
... ).to(torch.float)
>>> loss = model(**inputs, labels=labels).lossWav2Vec2BertForAudioFrameClassification
lớp transformers.Wav2Vec2BertForAudioFrameClassification
< source >( config: Wav2Vec2BertConfig )
Tham số
- config (Wav2Vec2BertConfig) — 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 Wav2Vec2 Bert với một đầu phân loại khung (frame classification head) ở trên cùng cho các tác vụ như Phân tách người nói (Speaker Diarization).
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
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → TokenClassifierOutput or tuple(torch.Tensor)
Tham số
- input_features (
torch.Tensorcó shape(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 Wav2Vec2FeatureExtractor. Xem Wav2Vec2FeatureExtractor.call() để biết thêm chi tiết (Wav2Vec2BertProcessor sử dụng Wav2Vec2FeatureExtractor để xử lý âm thanh). - attention_mask (
torch.Tensorcó 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.
- labels (
torch.LongTensorcó shape(batch_size,), tùy chọn) — Nhãn để tính loss cho phân loại/hồi quy chuỗi. Chỉ số phải nằm trong[0, ..., config.num_labels - 1]. Nếuconfig.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếuconfig.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
Trả về
TokenClassifierOutput hoặc tuple(torch.Tensor)
Một TokenClassifierOutput 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 (Wav2Vec2BertConfig) và đầu vào.
Phương thức forward của Wav2Vec2BertForAudioFrameClassification 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
Modulesau đó thay vì gọi hàm này, vì instanceModulesẽ đả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.
loss (
torch.Tensorcó shape(1,), tuỳ chọn, được trả về khilabelsđược cung cấp) — Loss phân loại.logits (
torch.Tensorcó hình dạng(batch_size, sequence_length, config.num_labels)) — Điểm phân loại (trước SoftMax).hidden_states (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — Bộ tuple củatorch.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ề khioutput_attentions=Trueđược truyền vào hoặc khiconfig.output_attentions=True) — Tuple củatorch.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 AutoFeatureExtractor, Wav2Vec2BertForAudioFrameClassification
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForAudioFrameClassification.from_pretrained("facebook/w2v-bert-2.0")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(dataset[0]["audio"]["array"], return_tensors="pt", sampling_rate=sampling_rate)
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> probabilities = torch.sigmoid(logits[0])
>>> # labels is a one-hot array of shape (num_frames, num_speakers)
>>> labels = (probabilities > 0.5).long()
>>> labels[0].tolist()
...Wav2Vec2BertForXVector
lớp transformers.Wav2Vec2BertForXVector
< source >( config: Wav2Vec2BertConfig )
Tham số
- config (Wav2Vec2BertConfig) — 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 Wav2Vec2Bert với đầu trích xuất đặc trưng XVector ở trên cùng cho các tác vụ như Xác minh người nói.
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
< source >( input_features: typing.Optional[torch.Tensor]attention_mask: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → XVectorOutput or tuple(torch.Tensor)
Tham số
- input_features (
torch.Tensorcó shape(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 Wav2Vec2FeatureExtractor. Xem Wav2Vec2FeatureExtractor.call() để biết thêm chi tiết (Wav2Vec2BertProcessor sử dụng Wav2Vec2FeatureExtractor để xử lý âm thanh). - attention_mask (
torch.Tensorcó 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.
- labels (
torch.LongTensorcó shape(batch_size,), tùy chọn) — Nhãn để tính loss cho phân loại/hồi quy chuỗi. Chỉ số phải nằm trong[0, ..., config.num_labels - 1]. Nếuconfig.num_labels == 1, loss hồi quy sẽ được tính (Mean-Square loss). Nếuconfig.num_labels > 1, loss phân loại sẽ được tính (Cross-Entropy).
Trả về
XVectorOutput hoặc tuple(torch.Tensor)
Một XVectorOutput 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 (Wav2Vec2BertConfig) và đầu vào.
Phương thức forward của Wav2Vec2BertForXVector 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
Modulesau đó thay vì gọi hàm này, vì instanceModulesẽ đả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.
loss (
torch.Tensorcó shape(1,), tuỳ chọn, được trả về khilabelsđược cung cấp) — Loss phân loại.logits (
torch.Tensorcó hình dạng(batch_size, config.xvector_output_dim)) — Trạng thái ẩn phân loại trước AMSoftmax.embeddings (
torch.Tensorcó hình dạng(batch_size, config.xvector_output_dim)) — Các embedding của câu nói được sử dụng cho việc truy xuất dựa trên độ tương tự vector.hidden_states (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — Bộ tuple cáctorch.Tensor(một cho đầu ra của embeddings + 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 đầu ra của lớp nhúng ban đầu.
attentions (
tuple(torch.Tensor), tuỳ chọn, được trả về khioutput_attentions=Trueđược truyền vào hoặc khiconfig.output_attentions=True) — Tuple củatorch.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 AutoFeatureExtractor, Wav2Vec2BertForXVector
>>> from datasets import load_dataset
>>> import torch
>>> dataset = load_dataset("hf-internal-testing/librispeech_asr_demo", "clean", split="validation")
>>> dataset = dataset.sort("id")
>>> sampling_rate = dataset.features["audio"].sampling_rate
>>> feature_extractor = AutoFeatureExtractor.from_pretrained("facebook/w2v-bert-2.0")
>>> model = Wav2Vec2BertForXVector.from_pretrained("facebook/w2v-bert-2.0")
>>> # audio file is decoded on the fly
>>> inputs = feature_extractor(
... [d["array"] for d in dataset[:2]["audio"]], sampling_rate=sampling_rate, return_tensors="pt", padding=True
... )
>>> with torch.no_grad():
... embeddings = model(**inputs).embeddings
>>> embeddings = torch.nn.functional.normalize(embeddings, dim=-1).cpu()
>>> # the resulting embeddings can be used for cosine similarity-based retrieval
>>> cosine_sim = torch.nn.CosineSimilarity(dim=-1)
>>> similarity = cosine_sim(embeddings[0], embeddings[1])
>>> threshold = 0.7 # the optimal threshold is dataset-dependent
>>> if similarity < threshold:
... print("Speakers are not the same!")
>>> round(similarity.item(), 2)
...