# ESMC

## Tổng quan

ESMC (ESM Cambrian) là một họ mô hình ngôn ngữ protein do [BioHub](https://biohub.org/) phát hành. Đây là một bộ mã hóa Transformer hai chiều được huấn luyện với mục tiêu mô hình hóa ngôn ngữ có che (masked-language-modelling) trên các trình tự axit amin. Giống như [ESM-2](./esm), ESMC tạo ra các biểu diễn cho từng phần tử (residue), hữu ích cho các tác vụ mô hình hóa protein ở giai đoạn tiếp theo.

ESMC phù hợp để tinh chỉnh cho các tác vụ phân loại protein hoặc phân loại token. Nó cũng được sử dụng làm khung xương của [ESMFold2](./esmfold2), nơi nó tạo ra các biểu diễn được dùng làm đầu vào cho đầu gập (folding head).

Các checkpoint được huấn luyện trước có sẵn trên Hugging Face Hub:

- [`biohub/ESMC-300M`](https://huggingface.co/biohub/ESMC-300M)
- [`biohub/ESMC-600M`](https://huggingface.co/biohub/ESMC-600M)
- [`biohub/ESMC-6B`](https://huggingface.co/biohub/ESMC-6B)

## Ví dụ sử dụng

ESMC được đăng ký với các lớp tự động (`AutoModel`, `AutoModelForMaskedLM`, `AutoModelForSequenceClassification`, `AutoModelForTokenClassification`).

```python
import torch
from transformers import pipeline

extractor = pipeline(
    task="feature-extraction",
    model="biohub/ESMC-300M",
)
# Per-residue representations of shape (batch, sequence_length, hidden_size).
representations = extractor("MKTAYIAKQRQISFVKSHFSRQLEERLGLIEVQ", return_tensors="pt")
```

```python
import torch
from transformers import AutoModel, AutoTokenizer

tokenizer = AutoTokenizer.from_pretrained("biohub/ESMC-300M")
model = AutoModel.from_pretrained("biohub/ESMC-300M")

inputs = tokenizer("MKTAYIAKQRQISFVKSHFSRQLEERLGLIEVQ", return_tensors="pt")
with torch.no_grad():
    outputs = model(**inputs)

# Per-residue representations of shape (batch, sequence_length, hidden_size).
representations = outputs.last_hidden_state
```

## EsmcConfig[[transformers.EsmcConfig]]

#### transformers.EsmcConfig[[transformers.EsmcConfig]]

```python
transformers.EsmcConfig(transformers_version: str | None = None, architectures: list[str] | None = None, output_hidden_states: bool | None = False, return_dict: bool | None = True, dtype: str | torch.dtype | None = None, chunk_size_feed_forward: int = 0, is_encoder_decoder: bool = False, id2label: dict[int, str] | dict[str, str] | None = None, label2id: dict[str, int] | dict[str, str] | None = None, problem_type: Literal['regression', 'single_label_classification', 'multi_label_classification'] | None = None, vocab_size: int = 64, hidden_size: int = 2560, intermediate_size: int = 6912, num_hidden_layers: int = 80, num_attention_heads: int = 40, num_key_value_heads: int | None = None, hidden_act: str = 'silu', max_position_embeddings: int = 2048, initializer_range: float = 0.02, pad_token_id: int | None = 1, bos_token_id: int | None = 0, eos_token_id: int | list[int] | None = 2, tie_word_embeddings: bool = False, rope_parameters: transformers.modeling_rope_utils.RopeParameters | dict | None = None, attention_bias: bool = False, attention_dropout: int | float | None = 0.0, mlp_bias: bool = False, head_dim: int | None = None, mask_token_id: int | None = 32, classifier_dropout: float | None = 0.1)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/configuration_esmc.py#L30)

**Tham số:**

vocab_size (*int*, *optional*, mặc định là *64*) : 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*.

hidden_size (*int*, *optional*, mặc định là *2560*) : Kích thước của các biểu diễn ẩn.

intermediate_size (*int*, *optional*, mặc định là *6912*) : Kích thước của các biểu diễn MLP.

num_hidden_layers (*int*, *optional*, mặc định là *80*) : Số lượng lớp ẩn trong bộ giải mã Transformer.

num_attention_heads (*int*, *optional*, mặc định là *40*) : Số lượng đầu chú ý (attention heads) cho mỗi lớp chú ý trong bộ giải mã Transformer.

num_key_value_heads (*int*, *optional*) : Đây là số lượng key_value heads cần được sử dụng để triển khai Grouped Query Attention. Nếu *num_key_value_heads=num_attention_heads*, mô hình sẽ sử dụng Multi Head Attention (MHA), nếu *num_key_value_heads=1* mô hình sẽ sử dụng Multi Query Attention (MQA), ngược lại GQA sẽ được sử dụng. Khi chuyển đổi một checkpoint multi-head sang checkpoint GQA, mỗi nhóm key và value head nên được xây dựng bằng cách meanpooling tất cả các head gốc trong nhóm đó. Để biết thêm chi tiết, hãy xem [bài báo này](https://huggingface.co/papers/2305.13245). Nếu không được chỉ định, giá trị mặc định sẽ là *num_attention_heads*.

hidden_act (*str*, *optional*, mặc định là *silu*) : Hàm kích hoạt phi tuyến tính (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ, *"gelu"*, *"relu"*, *"silu"*, v.v.

max_position_embeddings (*int*, *optional*, mặc định là *2048*) : Độ dài chuỗi tối đa mà mô hình này có thể được sử dụng.

initializer_range (*float*, *optional*, 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ố.

pad_token_id (*int*, *optional*, mặc định là *1*) : Token id được sử dụng để padding trong bảng từ vựng.

bos_token_id (*int*, *optional*, mặc định là *0*) : Token id được sử dụng cho đầu luồng (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*) : Id của token được sử dụng cho end-of-stream trong bảng từ vựng.

tie_word_embeddings (*bool*, *optional*, mặc định là *False*) : Có nên gắn kết các embedding trọng số theo ánh xạ *tied_weights_keys* của mô hình hay không.

rope_parameters (*Union[~modeling_rope_utils.RopeParameters, dict]*, *optional*) : Từ điển chứa các tham số cấu hình cho các embedding RoPE. Từ điển phải chứa một giá trị cho *rope_theta* và tùy chọn các tham số được sử dụng để mở rộng trong trường hợp bạn muốn sử dụng RoPE với *max_position_embeddings* dài hơn.

attention_bias (*bool*, *optional*, mặc định là *False*) : 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.

attention_dropout (*Union[int, float]*, *optional*, mặc định là *0.0*) : Tỷ lệ dropout cho các xác suất chú ý.

mlp_bias (*bool*, *optional*, mặc định là *False*) : Có sử dụng bias trong các lớp up_proj, down_proj và gate_proj của các lớp MLP hay không.

head_dim (*int*, *optional*) : Kích thước chiều đầu chú ý. Nếu là None, giá trị mặc định sẽ là hidden_size // num_attention_heads

mask_token_id (*int*, *optional*, mặc định là 32) : Chỉ số của token mask trong bảng từ vựng (`"&amp;lt;mask>"`), được sử dụng cho mô hình hóa ngôn ngữ có mask.

classifier_dropout (*float*, *optional*, mặc định là 0.1) : Tỷ lệ dropout cho đầu phân loại.

Đây là lớp cấu hình để lưu trữ cấu hình của một EsmcModel. Nó được sử dụng để khởi tạo một mô hình Esmc 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ủa [biohub/ESMC-6B](https://huggingface.co/biohub/ESMC-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ụ:

```python
>>> from transformers import EsmcConfig, EsmcModel

>>> # Initializing an ESMC biohub/ESMC-6B style configuration
>>> configuration = EsmcConfig()

>>> # Initializing a model (with random weights) from the configuration
>>> model = EsmcModel(configuration)

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

## EsmcTokenizer[[transformers.EsmcTokenizer]]

#### transformers.EsmcTokenizer[[transformers.EsmcTokenizer]]

```python
transformers.EsmcTokenizer(unk_token = '<unk>', cls_token = '<cls>', pad_token = '<pad>', mask_token = '<mask>', eos_token = '<eos>', bos_token = None, chain_break_token = '|', extra_special_tokens = None, **kwargs)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/tokenization_esmc.py#L67)

**Tham số:**

unk_token (*str*, *optional*, mặc định là *"&amp;lt;unk>"*) : Token không xác định.

cls_token (*str*, *optional*, mặc định là *"&amp;lt;cls>"*) : Token phân loại (được thêm vào đầu mỗi chuỗi).

pad_token (*str*, *optional*, mặc định là *"&amp;lt;pad>"*) : Token đệm.

mask_token (*str*, *optional*, mặc định là *"&amp;lt;mask>"*) : Token mask, được sử dụng cho mô hình hóa ngôn ngữ có mask.

eos_token (*str*, *optional*, mặc định là *"&amp;lt;eos>"*) : Token kết thúc chuỗi (được thêm vào cuối mỗi chuỗi).

bos_token (*str*, *optional*, mặc định là *"&amp;lt;cls>"*) : Token bắt đầu chuỗi (được thêm vào đầu mỗi chuỗi). Khi không được đặt, sẽ sử dụng cls_token.

chain_break_token (*str*, *optional*, mặc định là *"|"*) : Token được chèn giữa các chuỗi trong đầu vào protein đa chuỗi. Được đăng ký như một token đặc biệt cụ thể của mô hình, do đó được hiển thị dưới dạng *chain_break_token* / *chain_break_token_id*.

extra_special_tokens (*list[str]*, *optional*) : Các token đặc biệt bổ sung cần đăng ký với tokenizer (được lấy lại từ cấu hình đã lưu).

Xây dựng một tokenizer ESMC.

Tokenizer này là một tokenizer ở cấp độ ký tự, được hỗ trợ bởi thư viện *tokenizers* của HuggingFace. Nó bọc mọi chuỗi bằng các token `&amp;lt;cls>` và `&amp;lt;eos>`, đồng thời hỗ trợ token ngắt chuỗi `|` cho các đầu vào đa chuỗi.

Ví dụ:

```python
>>> from transformers import EsmcTokenizer

>>> tokenizer = EsmcTokenizer()
>>> tokenizer("ACDEFGHIKLMNPQRSTVWY")["input_ids"]
[0, 5, 23, 13, 9, 18, 6, 21, 12, 15, 4, 20, 17, 14, 16, 10, 8, 11, 7, 22, 19, 2]
```

## EsmcModel[[transformers.EsmcModel]]

#### transformers.EsmcModel[[transformers.EsmcModel]]

```python
transformers.EsmcModel(config: EsmcConfig)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L306)

**Tham số:**

config ([EsmcConfig](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcConfig)) : 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()](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số của mô hình.

Mô hình Esmc 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](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.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 ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.EsmcModel.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.Tensor] = None, sequence_id: typing.Optional[torch.Tensor] = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L316)

**Tham số:**

input_ids (*torch.Tensor* có hình dạng *(batch_size, sequence_length)*, *tùy chọn*) : Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Mặc định, các token đệm (padding) sẽ bị bỏ qua. Có thể lấy chỉ số bằng cách sử dụng [*AutoTokenizer*]. Xem [*PreTrainedTokenizer.encode*] và [*PreTrainedTokenizer.__call__*] để biết chi tiết. [Input IDs là gì?](../glossary#input-ids)

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ì?](../glossary#attention-mask)

position_ids (*torch.Tensor* có shape *(batch_size, sequence_length)*, *tuỳ chọn*) : Vị trí của từng token trong chuỗi, được sử dụng bởi RoPE. Mặc định là `arange(sequence_length)`. Vị trí ESMC là tuyệt đối trên toàn bộ đầu vào và tiếp tục chạy *xuyên qua* các ranh giới chuỗi trong một đầu vào đa chuỗi. Cấu trúc chuỗi được mang riêng bởi `sequence_id`, vốn che khuất sự chú ý: khác với định dạng chuỗi đóng gói được sử dụng ở các nơi khác trong thư viện, đây do đó không phải là các id vị trí theo chuỗi bắt đầu lại từ 0, và cấu trúc chuỗi được cố ý không suy ra từ chúng.

sequence_id (*torch.Tensor* có shape *(batch_size, sequence_length)*, *tuỳ chọn*) : Tensor ID chuỗi dạng số nguyên cho việc che mặt nạ chú ý nhận thức chuỗi. Các token có cùng giá trị số nguyên không âm có thể chú ý đến nhau; các token có giá trị khác nhau thì không thể (che mặt nạ liên chuỗi). Các vị trí đệm nên được đặt thành `-1` và đầu vào phải được **đệm bên phải** (RoPE sử dụng vị trí tuyệt đối bắt đầu từ 0). Khi được cung cấp, `attention_mask` sẽ bị bỏ qua. Việc truyền `sequence_id` sẽ xây dựng một mặt nạ chú ý tùy chỉnh, điều này yêu cầu `torch>=2.6`. Đầu vào đa chuỗi ngoài ra còn yêu cầu `attn_implementation` không phải flash (`'sdpa'` / `'eager'` / `'flex_attention'`); flash attention chỉ hỗ trợ trường hợp đơn chuỗi.

**Trả về:** [*~modeling_outputs.BaseModelOutput*] hoặc *tuple(torch.Tensor)*

Một [*~modeling_outputs.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 phần tử khác nhau tùy thuộc vào cấu hình ([*EsmcConfig*]) và đầu vào.

Phương thức forward của [*EsmcModel*] ghi đè phương thức đặc biệt *__call__*.

Mặc dù công thức cho bước truyền tiến (forward pass) 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 đó 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)*, *optional*, được trả về khi *output_hidden_states=True* được truyền vào hoặc khi *config.output_hidden_states=True*) -- Tuple của các *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)*, *optional*, được trả về khi *output_attentions=True* được truyền vào hoặc khi *config.output_attentions=True*) -- Bộ 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ụ:

```python
>>> from transformers import AutoTokenizer, EsmcModel

>>> model = EsmcModel.from_pretrained("biohub/ESMC-300M")
>>> tokenizer = AutoTokenizer.from_pretrained("biohub/ESMC-300M")
>>> inputs = tokenizer(["MLKNVQVQLV"], return_tensors="pt")
>>> outputs = model(**inputs)
>>> outputs.last_hidden_state.shape
torch.Size([1, 12, 960])
```

## EsmcForMaskedLM[[transformers.EsmcForMaskedLM]]

#### transformers.EsmcForMaskedLM[[transformers.EsmcForMaskedLM]]

```python
transformers.EsmcForMaskedLM(config: EsmcConfig)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L414)

**Tham số:**

config ([EsmcConfig](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcConfig)) : 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()](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số của mô hình.

Mô hình Esmc với đầu `language modeling` ở trên."

Mô hình này kế thừa từ [PreTrainedModel](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.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 ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.EsmcForMaskedLM.forward]]

```python
forward(input_ids: typing.Optional[torch.Tensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.Tensor] = None, sequence_id: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.Tensor] = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L430)

**Tham số:**

input_ids (*torch.Tensor* có hình dạng *(batch_size, sequence_length)*, *tùy chọn*) : Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Mặc định, các token đệm (padding) sẽ bị bỏ qua. Có thể lấy chỉ số bằng cách sử dụng [*AutoTokenizer*]. Xem [*PreTrainedTokenizer.encode*] và [*PreTrainedTokenizer.__call__*] để biết chi tiết. [Input IDs là gì?](../glossary#input-ids)

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ì?](../glossary#attention-mask)

position_ids (*torch.Tensor* có hình dạng *(batch_size, sequence_length)*, *tùy chọn*) : Chỉ số của vị trí các token trong mỗi chuỗi đầu vào trong các nhúng vị trí. Được chọn trong khoảng *[0, config.n_positions - 1]*.  [Các ID vị trí là gì?](../glossary#position-ids)

sequence_id (*torch.Tensor* có hình dạng *(batch_size, sequence_length)*, *tùy chọn*) : Tensor ID chuỗi nguyên được chuyển tiếp đến bộ mã hóa để tạo mặt nạ chú ý nhận thức chuỗi. Xem [EsmcModel.forward()](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcModel.forward) để biết cách mã hóa.

labels (*torch.LongTensor* có hình dạng *(batch_size, sequence_length)*, *tùy chọn*) : Nhãn cho tổn thất mô hình hóa ngôn ngữ bị che. Các vị trí có nhãn `-100` sẽ bị bỏ qua. Các vị trí khác phải nằm trong `[0, config.vocab_size)`.

**Trả về:** [*~modeling_outputs.MaskedLMOutput*] hoặc *tuple(torch.Tensor)*

Một [*~modeling_outputs.MaskedLMOutput*] 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 phần tử khác nhau tùy thuộc vào cấu hình ([*EsmcConfig*]) và đầu vào.

Phương thức forward của [*EsmcForMaskedLM*] 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 (forward pass) 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 đó 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.

- **loss** (*torch.Tensor* có hình dạng *(1,)*, *tuỳ chọn*, được trả về khi *labels* được cung cấp) -- Tổn thất mô hình hóa ngôn ngữ có mặt nạ (MLM).
- **logits** (*torch.Tensor* có 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 từ vựng trước SoftMax).
- **hidden_states** (*tuple(torch.Tensor)*, *optional*, được trả về khi *output_hidden_states=True* được truyền vào hoặc khi *config.output_hidden_states=True*) -- Tuple của các *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)*, *optional*, được trả về khi *output_attentions=True* được truyền vào hoặc khi *config.output_attentions=True*) -- Bộ 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ụ:

```python
>>> from transformers import AutoTokenizer, EsmcForMaskedLM
>>> import torch

>>> model = EsmcForMaskedLM.from_pretrained("biohub/ESMC-300M")
>>> tokenizer = AutoTokenizer.from_pretrained("biohub/ESMC-300M")
>>> inputs = tokenizer(["MLKNVQ&amp;lt;mask>LV"], return_tensors="pt")
>>> outputs = model(**inputs)
>>> outputs.logits.shape
torch.Size([1, 11, 64])
```

## EsmcForSequenceClassification[[transformers.EsmcForSequenceClassification]]

#### transformers.EsmcForSequenceClassification[[transformers.EsmcForSequenceClassification]]

```python
transformers.EsmcForSequenceClassification(config: EsmcConfig)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L511)

**Tham số:**

config ([EsmcConfig](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcConfig)) : 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()](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.PreTrainedModel.from_pretrained) để tải trọng số của mô hình.

Model transformer ESMC với đầu phân loại/hồi quy chuỗi phía trên (một lớp tuyến tính phía trên đầu ra đã được pool) ví dụ cho các tác vụ GLUE.

Mô hình này kế thừa từ [PreTrainedModel](/docs/transformers/v5.23.0/vi/main_classes/model#transformers.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 ra, v.v.)

Mô hình này cũng là một lớp con của [torch.nn.Module](https://pytorch.org/docs/stable/nn.html#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[[transformers.EsmcForSequenceClassification.forward]]

```python
forward(input_ids: typing.Optional[torch.LongTensor] = None, attention_mask: typing.Optional[torch.Tensor] = None, position_ids: typing.Optional[torch.LongTensor] = None, inputs_embeds: typing.Optional[torch.Tensor] = None, labels: typing.Optional[torch.LongTensor] = None, **kwargs: *<class 'transformers.utils.generic.TransformersKwargs'>)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L521)

**Tham số:**

input_ids (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Mặc định, các token đệm (padding) sẽ bị bỏ qua. Có thể lấy chỉ số bằng cách sử dụng [AutoTokenizer](/docs/transformers/v5.23.0/vi/model_doc/auto#transformers.AutoTokenizer). Xem [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) và [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) để biết chi tiết. [ID đầu vào là gì?](../glossary#input-ids)

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ì?](../glossary#attention-mask)

position_ids (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Chỉ số của vị trí các token trong mỗi chuỗi đầu vào trong các embedding vị trí. Được chọn trong khoảng `[0, config.n_positions - 1]`.  [Position IDs là gì?](../glossary#position-ids)

inputs_embeds (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `input_ids`, bạn có thể chọn cách truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.

labels (`torch.LongTensor` có hình dạng `(batch_size,)`, *tùy chọn*) : Nhãn để tính toán tổn thất phân loại/hồi quy chuỗi. Chỉ số phải nằm trong `[0, ..., config.num_labels - 1]`. Nếu `config.num_labels == 1`, tổn thất hồi quy sẽ được tính toán (tổn thất Mean-Square). Nếu `config.num_labels > 1`, tổn thất phân loại sẽ được tính toán (Cross-Entropy).

**Trả về:** [SequenceClassifierOutput](/docs/transformers/v5.23.0/vi/main_classes/output#transformers.modeling_outputs.SequenceClassifierOutput) hoặc `tuple(torch.Tensor)`

Một [SequenceClassifierOutput](/docs/transformers/v5.23.0/vi/main_classes/output#transformers.modeling_outputs.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 phần tử khác nhau tùy thuộc vào cấu hình ([EsmcConfig](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcConfig)) và đầu vào.

Phương thức forward của [EsmcForSequenceClassification](/docs/transformers/v5.23.0/vi/model_doc/esmc#transformers.EsmcForSequenceClassification) 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, bạn 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ẽ bỏ qua chúng một cách im lặng.

- **loss** (`torch.Tensor` có shape `(1,)`, *optional*, được trả về khi `labels` được cung cấp) -- Loss phân loại (hoặc hồi quy nếu config.num_labels==1).
- **logits** (`torch.Tensor` có 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ề 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 các embedding, 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`) -- Bộ 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ụ về phân loại nhãn đơn:

```python
>>> import torch
>>> from transformers import AutoTokenizer, EsmcForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("biohub/ESMC-6B")
>>> model = EsmcForSequenceClassification.from_pretrained("biohub/ESMC-6B")

>>> 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 = EsmcForSequenceClassification.from_pretrained("biohub/ESMC-6B", 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:

```python
>>> import torch
>>> from transformers import AutoTokenizer, EsmcForSequenceClassification

>>> tokenizer = AutoTokenizer.from_pretrained("biohub/ESMC-6B")
>>> model = EsmcForSequenceClassification.from_pretrained("biohub/ESMC-6B", 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 = EsmcForSequenceClassification.from_pretrained(
...     "biohub/ESMC-6B", 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).loss
```

## EsmcForTokenClassification[[transformers.EsmcForTokenClassification]]

#### transformers.EsmcForTokenClassification[[transformers.EsmcForTokenClassification]]

```python
transformers.EsmcForTokenClassification(config)
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/models/esmc/modeling_esmc.py#L575)

#### forward[[transformers.EsmcForTokenClassification.forward]]

```python
forward(input_ids: torch.LongTensor | None = None, attention_mask: torch.Tensor | None = None, position_ids: torch.LongTensor | None = None, past_key_values: Cache | None = None, inputs_embeds: torch.Tensor | None = None, labels: torch.LongTensor | None = None, use_cache: bool | None = None, **kwargs: Unpack[TransformersKwargs])
```

[Nguồn](https://github.com/huggingface/transformers/blob/v5.23.0/src/transformers/modeling_layers.py#L287)

**Tham số:**

input_ids (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Chỉ số của các token trong chuỗi đầu vào theo từ vựng. Mặc định, các token đệm (padding) sẽ bị bỏ qua. Có thể lấy chỉ số bằng cách sử dụng [AutoTokenizer](/docs/transformers/v5.23.0/vi/model_doc/auto#transformers.AutoTokenizer). Xem [PreTrainedTokenizer.encode()](/docs/transformers/v5.23.0/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.encode) và [PreTrainedTokenizer.__call__()](/docs/transformers/v5.23.0/vi/internal/tokenization_utils#transformers.PreTrainedTokenizerBase.__call__) để biết chi tiết. [ID đầu vào là gì?](../glossary#input-ids)

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ì?](../glossary#attention-mask)

position_ids (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Chỉ số của vị trí các token trong mỗi chuỗi đầu vào trong các embedding vị trí. Được chọn trong khoảng `[0, config.n_positions - 1]`.  [Position IDs là gì?](../glossary#position-ids)

past_key_values (`Cache`, *optional*) : Các hidden-states đã được tính trước (key và values trong các khối self-attention và cross-attention) có thể được sử dụng để tăng tốc độ giải mã tuần tự. Thành phần này thường bao gồm `past_key_values` do mô hình trả về ở một giai đoạn giải mã trước đó, khi `use_cache=True` hoặc `config.use_cache=True`. Chỉ cho phép một instance của [Cache](/docs/transformers/v5.23.0/vi/internal/generation_utils#transformers.Cache) làm đầu vào, xem [hướng dẫn về kv cache](https://huggingface.co/docs/transformers/en/kv_cache) của chúng tôi. Nếu không truyền `past_key_values`, [DynamicCache](/docs/transformers/v5.23.0/vi/internal/generation_utils#transformers.DynamicCache) sẽ được khởi tạo theo mặc định. Mô hình sẽ xuất ra cùng định dạng cache được đưa vào làm đầu vào. Nếu sử dụng `past_key_values`, người dùng được kỳ vọng chỉ nhập các `input_ids` chưa được xử lý (những phần chưa có trạng thái key value tương ứng được cung cấp cho mô hình này) với shape `(batch_size, unprocessed_length)` thay vì toàn bộ `input_ids` với shape `(batch_size, sequence_length)`.

inputs_embeds (`torch.Tensor` có hình dạng `(batch_size, sequence_length, hidden_size)`, *tùy chọn*) : Tùy chọn, thay vì truyền `input_ids`, bạn có thể chọn cách truyền trực tiếp một biểu diễn nhúng. Điều này hữu ích nếu bạn muốn kiểm soát nhiều hơn cách chuyển đổi các chỉ số `input_ids` thành các vector liên quan so với ma trận tra cứu nhúng nội bộ của mô hình.

labels (`torch.LongTensor` có hình dạng `(batch_size, sequence_length)`, *tùy chọn*) : Nhãn để tính toán tổn thất phân loại token. Chỉ số phải nằm trong `[0, ..., config.num_labels - 1]`.

use_cache (`bool`, *tùy chọn*) : Nếu được đặt thành `True`, các trạng thái khóa và giá trị `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`).

**Trả về:** `TokenClassifierOutput`

Phương thức forward của `GenericForTokenClassification` 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, bạn 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ẽ bỏ qua chúng một cách im lặng.

