Transformers documentation
Convolutional Vision Transformer (CvT)
Mô hình này được công bố trên HF papers vào ngày 2021-03-29 và được đóng góp cho Hugging Face Transformers vào ngày 2022-05-18.
Convolutional Vision Transformer (CvT)
Convolutional Vision Transformer (CvT) là một mô hình kết hợp những điểm mạnh của mạng nơ-ron tích chập (CNN) và Vision transformer cho các tác vụ thị giác máy tính. Nó đưa các lớp tích chập vào kiến trúc vision transformer, cho phép mô hình nắm bắt các mẫu cục bộ trong hình ảnh trong khi vẫn duy trì ngữ cảnh toàn cục do các cơ chế tự chú ý cung cấp.
Bạn có thể tìm thấy tất cả các checkpoint của CvT dưới tổ chức Microsoft.
Mô hình này được đóng góp bởi anujunj.
Nhấp vào các mô hình CvT ở thanh bên phải để xem thêm các ví dụ về cách áp dụng CvT cho các tác vụ thị giác máy tính khác nhau.
Ví dụ dưới đây minh họa cách phân loại một hình ảnh bằng Pipeline hoặc lớp AutoModel.
from transformers import pipeline
pipeline = pipeline(
task="image-classification",
model="microsoft/cvt-13",
device=0
)
pipeline("https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg")import requests
import torch
from PIL import Image
from transformers import AutoImageProcessor, AutoModelForImageClassification
image_processor = AutoImageProcessor.from_pretrained("microsoft/cvt-13")
model = AutoModelForImageClassification.from_pretrained(
"microsoft/cvt-13",
device_map="auto"
)
url = "https://huggingface.co/datasets/huggingface/documentation-images/resolve/main/pipeline-cat-chonk.jpeg"
image = Image.open(requests.get(url, stream=True).raw)
inputs = image_processor(image, return_tensors="pt").to(model.device)
with torch.no_grad():
logits = model(**inputs).logits
predicted_class_id = logits.argmax(dim=-1).item()
class_labels = model.config.id2label
predicted_class_label = class_labels[predicted_class_id]
print(f"The predicted class label is: {predicted_class_label}")Tài nguyên
Tham khảo bộ notebooks ViT này để xem các ví dụ về suy luận và tinh chỉnh trên các tập dữ liệu tùy chỉnh. Thay thế ViTFeatureExtractor và ViTForImageClassification trong các notebooks này bằng AutoImageProcessor và CvtForImageClassification.
CvtConfig
lớp transformers.CvtConfig
< 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 = Nonenum_channels: int = 3patch_sizes: list[int] | tuple[int, ...] = (7, 3, 3)patch_stride: list[int] | tuple[int, ...] = (4, 2, 2)patch_padding: list[int] | tuple[int, ...] = (2, 1, 1)embed_dim: list[int] | tuple[int, ...] = (64, 192, 384)num_heads: list[int] | tuple[int, ...] = (1, 3, 6)depth: list[int] | tuple[int, ...] = (1, 2, 10)mlp_ratio: list[float] | tuple[float, ...] = (4.0, 4.0, 4.0)attention_drop_rate: list[float] | tuple[float, ...] = (0.0, 0.0, 0.0)drop_rate: list[float] | tuple[float, ...] = (0.0, 0.0, 0.0)drop_path_rate: list[float] | tuple[float, ...] = (0.0, 0.0, 0.1)qkv_bias: list[bool] | tuple[bool, ...] = (True, True, True)cls_token: list[bool] | tuple[bool, ...] = (False, False, True)qkv_projection_method: list[str] | tuple[str, ...] = ('dw_bn', 'dw_bn', 'dw_bn')kernel_qkv: list[int] | tuple[int, ...] = (3, 3, 3)padding_kv: list[int] | tuple[int, ...] = (1, 1, 1)stride_kv: list[int] | tuple[int, ...] = (2, 2, 2)padding_q: list[int] | tuple[int, ...] = (1, 1, 1)stride_q: list[int] | tuple[int, ...] = (1, 1, 1)initializer_range: float = 0.02layer_norm_eps: float = 1e-12 )
Tham số
- num_channels (
int, tùy chọn, mặc định là3) — Số lượng kênh đầu vào. - patch_sizes (
Union[list[int], tuple[int, ...]], tùy chọn, mặc định là(7, 3, 3)) — Kích thước patch ở mỗi giai đoạn của mô hình. - patch_stride (
list[int], tùy chọn, mặc định là[4, 2, 2]) — Kích thước bước (stride) của patch embedding cho mỗi encoder. - patch_padding (
list[int], tùy chọn, mặc định là[2, 1, 1]) — Kích thước padding của patch embedding cho mỗi encoder. - embed_dim (
Union[list[int], tuple[int, ...]], tuỳ chọn, mặc định là(64, 192, 384)) — Kích thước của các embedding và trạng thái ẩn. - num_heads (
Union[list[int], tuple[int, ...]], tùy chọn, mặc định là(1, 3, 6)) — Số lượng đầu chú ý cho mỗi lớp chú ý trong bộ giải mã Transformer. - depth (
list[int], tùy chọn, mặc định là[1, 2, 10]) — Số lượng lớp trong mỗi khối encoder. - mlp_ratio (
Union[list[float], tuple[float, ...]], tuỳ chọn, mặc định là(4.0, 4.0, 4.0)) — Tỷ lệ giữa chiều ẩn của MLP và chiều nhúng. - attention_drop_rate (
list[float], tùy chọn, mặc định là[0.0, 0.0, 0.0]) — Tỷ lệ dropout cho các xác suất chú ý. - drop_rate (
list[float], tùy chọn, mặc định là[0.0, 0.0, 0.0]) — Tỷ lệ dropout cho xác suất của các nhúng patch. - drop_path_rate (
Union[list[float], tuple[float, ...]], tuỳ chọn, mặc định là(0.0, 0.0, 0.1)) — Tỷ lệ drop path cho việc hợp nhất patch. - qkv_bias (
Union[list[bool], tuple[bool, ...]], tùy chọn, mặc định là(True, True, True)) — Có thêm bias cho queries, keys và values hay không. - cls_token (
list[bool], tùy chọn, mặc định là[False, False, True]) — Có thêm token phân loại vào đầu ra của mỗi giai đoạn trong 3 giai đoạn cuối hay không. - qkv_projection_method (
list[string], tuỳ chọn, mặc định là [“dw_bn”, “dw_bn”, “dw_bn”]`) — Phương pháp chiếu cho query, key và value. Mặc định là depth-wise convolutions với batch norm. Để sử dụng Linear projection, hãy dùng “avg”. - kernel_qkv (
list[int], tùy chọn, mặc định là[3, 3, 3]) — Kích thước kernel cho query, key và value trong lớp attention - padding_kv (
list[int], tùy chọn, mặc định là[1, 1, 1]) — Kích thước padding cho key và value trong lớp attention - stride_kv (
list[int], tùy chọn, mặc định là[2, 2, 2]) — Kích thước bước (stride) cho key và value trong lớp attention - padding_q (
list[int], tùy chọn, mặc định là[1, 1, 1]) — Kích thước padding cho query trong lớp attention - stride_q (
list[int], tùy chọn, mặc định là[1, 1, 1]) — Kích thước stride cho query trong lớp attention - 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-12) — Giá trị epsilon được sử dụng bởi các lớp chuẩn hóa lớp (layer normalization).
Đây là lớp cấu hình để lưu trữ cấu hình của một CvtModel. Nó được sử dụng để khởi tạo một mô hình Cvt 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 microsoft/cvt-13
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 CvtConfig, CvtModel
>>> # Initializing a Cvt msft/cvt style configuration
>>> configuration = CvtConfig()
>>> # Initializing a model (with random weights) from the msft/cvt style configuration
>>> model = CvtModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCvtModel
lớp transformers.CvtModel
< source >( config: CvtConfigadd_pooling_layer = True )
Tham số
- config (CvtConfig) — 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 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.
- add_pooling_layer (
bool, tùy chọn, mặc định làTrue) — Có thêm một lớp pooling hay không
Mô hình Cvt thuần túy, 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 >( pixel_values: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → BaseModelOutputWithCLSToken or tuple(torch.Tensor)
Tham số
- pixel_values (
torch.Tensorcó hình dạng(batch_size, num_channels, image_size, image_size), tùy chọn) — Các tensor tương ứng với các hình ảnh đầu vào. Giá trị pixel có thể được lấy bằng cách sử dụng ConvNextImageProcessor. Xem ConvNextImageProcessor.call() để biết chi tiết (processor_classsử dụng ConvNextImageProcessor để xử lý hình ảnh). - output_hidden_states (
bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xemhidden_statestrong phần tensor trả về để biết thêm chi tiết. - return_dict (
bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.
Trả về
BaseModelOutputWithCLSToken hoặc tuple(torch.Tensor)
Một BaseModelOutputWithCLSToken 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 (CvtConfig) và đầu vào.
Phương thức forward của CvtModel 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), tùy chọn) — 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.cls_token_value (
torch.Tensorcó hình dạng(batch_size, 1, hidden_size)) — Token phân loại 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ề khioutput_hidden_states=Trueđược truyền vào hoặc khiconfig.output_hidden_states=True) — 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.
CvtForImageClassification
lớp transformers.CvtForImageClassification
< source >( config: CvtConfig )
Tham số
- config (CvtConfig) — 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 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.
Model transformer Cvt với đầu phân loại hình ảnh phía trên (một lớp tuyến tính phía trên trạng thái ẩn cuối cùng của token [CLS]) ví dụ cho ImageNet.
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 >( pixel_values: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.Tensor] = Noneoutput_hidden_states: bool | None = Nonereturn_dict: bool | None = None**kwargs ) → ImageClassifierOutputWithNoAttention or tuple(torch.Tensor)
Tham số
- pixel_values (
torch.Tensorcó hình dạng(batch_size, num_channels, image_size, image_size), tùy chọn) — Các tensor tương ứng với các hình ảnh đầu vào. Giá trị pixel có thể được lấy bằng cách sử dụng ConvNextImageProcessor. Xem ConvNextImageProcessor.call() để biết chi tiết (processor_classsử dụng ConvNextImageProcessor để xử lý hình ảnh). - labels (
torch.LongTensorcó shape(batch_size,), tùy chọn) — Nhãn để tính loss phân loại/hồi quy ảnh. Các 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). - output_hidden_states (
bool, tùy chọn) — Có trả về trạng thái ẩn (hidden states) của tất cả các lớp hay không. Xemhidden_statestrong phần tensor trả về để biết thêm chi tiết. - return_dict (
bool, tùy chọn) — Có nên trả về một ModelOutput thay vì một tuple thông thường hay không.
Trả về
ImageClassifierOutputWithNoAttention hoặc tuple(torch.Tensor)
Một ImageClassifierOutputWithNoAttention 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 (CvtConfig) và đầu vào.
Phương thức forward của CvtForImageClassification 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) — 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 giai đoạn) có hình dạng(batch_size, num_channels, height, width). Hidden-states (còn được gọi là feature maps) của mô hình tại đầu ra của mỗi giai đoạn.
Ví dụ:
>>> from transformers import AutoImageProcessor, CvtForImageClassification
>>> import torch
>>> from datasets import load_dataset
>>> dataset = load_dataset("huggingface/cats-image")
>>> image = dataset["test"]["image"][0]
>>> image_processor = AutoImageProcessor.from_pretrained("microsoft/cvt-13")
>>> model = CvtForImageClassification.from_pretrained("microsoft/cvt-13")
>>> inputs = image_processor(image, return_tensors="pt")
>>> with torch.no_grad():
... logits = model(**inputs).logits
>>> # model predicts one of the 1000 ImageNet classes
>>> predicted_label = logits.argmax(-1).item()
>>> print(model.config.id2label[predicted_label])
...