Transformers documentation
Code World Model (CWM)
<— Bản quyền 2025 thuộc về Đội ngũ HuggingFace. Bảo lưu mọi quyền.
Được cấp phép theo Giấy phép Apache, Phiên bản 2.0 (“Giấy phép”); bạn không được sử dụng tệp này ngoại trừ tuân thủ Giấy phép. Bạn có thể nhận một bản sao của Giấy phép tại
http://www.apache.org/licenses/LICENSE-2.0
Trừ khi luật áp dụng yêu cầu hoặc có thỏa thuận bằng văn bản, phần mềm được phân phối theo Giấy phép được phân phối trên cơ sở “NGUYÊN TRẠNG”, KHÔNG CÓ BẢO HÀNH HOẶC ĐIỀU KIỆN BẤT KỲ, dù là rõ ràng hay ngụ ý. Xem Giấy phép để biết ngôn ngữ cụ thể điều chỉnh các quyền và hạn chế theo Giấy phép.
⚠️ Lưu ý rằng tệp này ở định dạng Markdown nhưng chứa cú pháp cụ thể cho doc-builder của chúng tôi (tương tự MDX) và có thể không hiển thị đúng trong trình xem Markdown của bạn.
—> Mô hình này đã được đóng góp cho Hugging Face Transformers vào ngày 2025-10-09.
Code World Model (CWM)
Tổng quan
Mô hình Code World Model (CWM) được đề xuất trong CWM: An Open-Weights LLM for Research on Code Generation with World Models bởi Meta FAIR CodeGen Team. CWM là một LLM cho việc tạo mã và suy luận về mã, đặc biệt được huấn luyện để biểu diễn và suy luận tốt hơn về cách mã và các lệnh ảnh hưởng đến trạng thái của một chương trình hoặc hệ thống. Cụ thể, chúng tôi đã huấn luyện giữa (mid-train) CWM trên một số lượng lớn các quỹ đạo quan sát-hành động từ các vết thực thi Python và các tương tác của tác tử (agentic) trong các môi trường được đóng gói (containerized). Chúng tôi đã huấn luyện sau (post-train) bằng RL đa nhiệm rộng rãi trong các môi trường lập trình có thể kiểm chứng, toán học và kỹ thuật phần mềm đa lượt.
Tóm tắt từ bài báo như sau:
Chúng tôi phát hành Code World Model (CWM), một LLM mã nguồn mở với 32 tỷ tham số, nhằm thúc đẩy nghiên cứu về tạo mã bằng mô hình thế giới. Để cải thiện khả năng hiểu mã vượt ra ngoài những gì có thể học được từ việc chỉ huấn luyện trên mã tĩnh, chúng tôi huấn luyện giữa (mid-train) CWM trên một lượng lớn các quỹ đạo quan sát-hành động từ trình thông dịch Python và các môi trường Docker dạng tác tử (agentic), đồng thời thực hiện RL suy luận đa nhiệm quy mô lớn trong các môi trường lập trình có thể kiểm chứng, toán học và kỹ thuật phần mềm đa lượt. Với CWM, chúng tôi cung cấp một môi trường thử nghiệm mạnh mẽ để các nhà nghiên cứu khám phá những cơ hội mà mô hình hóa thế giới mang lại cho việc cải thiện tạo mã bằng suy luận và lập kế hoạch trong các môi trường tính toán. Chúng tôi trình bày những bước đầu tiên về cách các mô hình thế giới có thể hỗ trợ lập trình dạng tác tử, cho phép mô phỏng từng bước quá trình thực thi mã Python, và đưa ra các kết quả ban đầu về cách suy luận có thể được hưởng lợi từ điều này. CWM là một LLM dense, chỉ có bộ giải mã (decoder-only), được huấn luyện với kích thước ngữ cảnh lên đến 131 k token. Độc lập với khả năng mô hình hóa thế giới, CWM mang lại hiệu suất mạnh mẽ trên các tác vụ lập trình và toán học tổng quát: đạt điểm pass@1 là 65,8 % trên SWE-bench Verified (với test-time scaling), 68,9 % trên LiveCodeBench, 96,6 % trên Math-500 và 76,0 % trên AIME 2024. Để hỗ trợ nghiên cứu sâu hơn về mô hình hóa thế giới cho mã, chúng tôi phát hành các checkpoint mô hình sau các giai đoạn huấn luyện giữa (mid-training), SFT và RL.
Mẹo:
CWM yêu cầu một system prompt chuyên dụng để hoạt động tối ưu trong quá trình suy luận. Nếu không cấu hình prompt phù hợp, chất lượng đầu ra của CWM có thể bị suy giảm đáng kể. Nội dung dưới đây đóng vai trò là system prompt mặc định cho các tác vụ suy luận. Đối với các luồng làm việc agentic, hãy thêm các thông số kỹ thuật công cụ liên quan sau prompt cơ sở này. Xem kho mã nguồn gốc để biết thêm chi tiết.
You are a helpful AI assistant. You always reason before responding, using the following format: <think> your internal reasoning </think> your external response
Mô hình này được đóng góp bởi Meta FAIR CodeGen Team. Mã nguồn gốc có thể được tìm thấy tại đây.
Ví dụ sử dụng
from transformers import AutoModelForCausalLM, AutoTokenizer
model_name = 'facebook/cwm'
tokenizer = AutoTokenizer.from_pretrained(model_name)
model = AutoModelForCausalLM.from_pretrained(
model_name,
device_map="auto"
)
system_prompt = """
You are a helpful AI assistant. You always reason before responding, using the following format:
<think>
your internal reasoning
</think>
your external response
""".strip()
messages = [
{"role": "system", "content": system_prompt},
{"role": "user", "content": "Write a haiku about recursion in programming."}
]
text = tokenizer.apply_chat_template(
messages,
tokenize=False,
add_generation_prompt=True,
enable_thinking=True, # Switches between thinking and non-thinking modes. Default is True.
preserve_previous_think=True, # Switches between keeping thinking blocks from previous messages or not. Default is True.
)
model_inputs = tokenizer([text], return_tensors="pt").to(model.device)
generated_ids = model.generate(
**model_inputs,
max_new_tokens=1024
)
output_ids = generated_ids[0][len(model_inputs.input_ids[0]):].tolist()
print(tokenizer.decode(output_ids))Produces the following output:
Được rồi, tôi cần viết một bài haiku về đệ quy trong lập trình. Hãy bắt đầu bằng cách nhớ lại đệ quy là gì. Đệ quy là một kỹ thuật lập trình trong đó một hàm gọi chính nó trong định nghĩa của nó, thường được sử dụng để giải quyết các bài toán có thể được chia nhỏ thành các bài toán con nhỏ hơn, tương tự nhau.
Haiku là bài thơ ba dòng với số âm tiết 5-7-5. Vì vậy, tôi cần nắm bắt bản chất của đệ quy một cách cô đọng và giàu chất thơ. Hãy cùng suy nghĩ về các yếu tố chính của đệ quy: hàm tự gọi chính nó, điều kiện dừng để kết thúc đệ quy, và ý tưởng phân rã bài toán thành các phần nhỏ hơn.
Có lẽ tôi có thể sử dụng hình ảnh liên quan đến gương hoặc phản chiếu, vì đệ quy thường liên quan đến việc một hàm phản chiếu hoặc lặp lại chính nó. Hoặc, tôi có thể sử dụng hình ảnh tự nhiên như một đường xoắn ốc hoặc một cái cây, gợi ý các mẫu tự tương tự.
Hãy để tôi thử nghĩ ra một vài ý tưởng. Ví dụ, “Hàm gọi chính nó” có thể là một điểm khởi đầu. Nhưng làm thế nào để biến điều đó thành một bài haiku? Có lẽ điều gì đó giống như:
Gọi hàm chính nó Trường hợp cơ bản dừng vòng lặp vô tận Vòng xoáy của mã
Hmm, đó là một khởi đầu. Nhưng có lẽ tôi có thể làm cho nó mang tính thơ hơn. Hãy nghĩ về ý tưởng một hàm gọi chính nó như một dạng vòng lặp vô hạn, nhưng có một trường hợp cơ sở để dừng lại. Điều đó giống như một đường xoắn ốc được tháo ra ở tâm.
Một góc nhìn khác: đệ quy thường được dùng cho các bài toán có cấu trúc đệ quy, chẳng hạn như duyệt cây hoặc tính giai thừa. Có lẽ tôi có thể dùng một hình ảnh tự nhiên để diễn đạt điều đó.
…
Các nhánh tách ra lần nữa Các lá xòe ra trong điệu múa vô tận Các rễ giữ trường hợp cơ sở
Điều này mang tính hình ảnh hơn một chút. Các nhánh phân chia đại diện cho các lời gọi đệ quy, các lá bung ra có thể đại diện cho việc xử lý từng bài toán con, và rễ giữ trường hợp cơ sở chính là thứ ngăn chặn sự đệ quy.
Hoặc, có thể có một cách đơn giản hơn:
Gương trong gương Phản chiếu sâu vô tận Trường hợp cơ bản phá vỡ lớp kính
Câu này sử dụng phép ẩn dụ về tấm gương để thể hiện việc hàm gọi chính nó, trong đó trường hợp cơ sở là điểm mà quá trình đệ quy dừng lại, phá vỡ sự phản chiếu vô hạn.
Tôi nghĩ tôi thích ý tưởng gương hơn. Để tôi tinh chỉnh lại:
Gương trong gương Phản chiếu vô tận nhảy múa Trường hợp cơ bản làm vỡ kính
Đúng vậy, điều đó dường như nắm bắt tốt ý tưởng về đệ quy. Gương đại diện cho hàm gọi chính nó, các phản chiếu vô hạn là các lời gọi đệ quy, và trường hợp cơ bản làm vỡ kính chính là thứ ngăn chặn đệ quy.
Hãy để tôi kiểm tra số âm tiết:
Gương trong gương (5 âm tiết: Gương-trong-gương) Phản chiếu vô tận nhảy múa (7 âm tiết: Phản-chiếu-vô-tận-nhảy-múa) Trường hợp cơ bản làm vỡ kính (5 âm tiết: Cơ-bản-làm-vỡ-kính)
Đúng vậy, nó phù hợp với cấu trúc 5-7-5. Tôi nghĩ đó là một bài haiku hay về đệ quy.
</think> Mirror within mirror Infinite reflections dance Base case shatters glass<|eot_id|>CwmConfig
lớp transformers.CwmConfig
< 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 = 128256hidden_size: int = 6144intermediate_size: int = 21504num_hidden_layers: int = 64num_attention_heads: int = 48num_key_value_heads: int = 8hidden_act: str = 'silu'max_position_embeddings: int = 131072initializer_range: float = 0.02rms_norm_eps: float = 1e-05use_cache: bool = Truepad_token_id: int | None = Nonebos_token_id: int = 128000eos_token_id: int | list[int] | None = Nonepretraining_tp: int = 1tie_word_embeddings: bool = Falserope_parameters: dict | None = Noneattention_dropout: float | int = 0.0mlp_bias: bool = Falsehead_dim: int = 128sliding_window: int = 8192layer_types: list[str] | None = None )
Tham số
- vocab_size (
int, tuỳ chọn, mặc định là128256) — 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à6144) — Kích thước của các biểu diễn ẩn. - intermediate_size (
int, tùy chọn, mặc định là21504) — Kích thước của các biểu diễn MLP. - num_hidden_layers (
int, tùy chọn, mặc định là64) — Số lượng lớp ẩn trong bộ giải mã Transformer. - num_attention_heads (
int, tùy chọn, mặc định là48) — Số lượng đầu chú ý cho mỗi lớp chú ý trong bộ giải mã Transformer. - num_key_value_heads (
int, tùy chọn, mặc định là8) — Đây là số lượng key_value heads cần được sử dụng để triển khai Grouped Query Attention. Nếunum_key_value_heads=num_attention_heads, mô hình sẽ sử dụng Multi Head Attention (MHA), nếunum_key_value_heads=1mô hình sẽ sử dụng Multi Query Attention (MQA), ngược lại sẽ sử dụng GQA. Khi chuyển đổi 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. Nếu không được chỉ định, giá trị mặc định sẽ lànum_attention_heads. - hidden_act (
str, tùy chọn, mặc định làsilu) — Hàm kích hoạt phi tuyến (hàm hoặc chuỗi) trong bộ giải mã. Ví dụ,"gelu","relu","silu", v.v. - max_position_embeddings (
int, tùy chọn, mặc định là131072) — Chiều dài chuỗi tối đa mà mô hình này có thể được sử dụng. - initializer_range (
float, tùy chọn, mặc định là0.02) — Độ lệch chuẩn của truncated_normal_initializer để khởi tạo tất cả các ma trận trọng số. - rms_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 rms. - use_cache (
bool, tùy chọn, mặc định làTrue) — Xác định xem mô hình có nên trả về các chú ý key/values cuối cùng hay không (không được sử dụng bởi tất cả các mô hình). Chỉ liên quan nếuconfig.is_decoder=Truehoặc khi mô hình là mô hình sinh chỉ có decoder. - pad_token_id (
int, tùy chọn) — Token id được sử dụng để đệm trong từ vựng. - bos_token_id (
int, tùy chọn, mặc định là128000) — Token id được dùng cho beginning-of-stream trong bảng từ vựng. - eos_token_id (
Union[int, list[int]], tùy chọn) — Token id được sử dụng cho end-of-stream trong bảng từ vựng. - pretraining_tp (
int, tùy chọn, mặc định là1) — Tính năng thử nghiệm. Bậc song song tensor (tensor parallelism rank) được sử dụng trong quá trình tiền huấn luyện. Vui lòng tham khảo tài liệu này để hiểu thêm về nó. Giá trị này là cần thiết để đảm bảo khả năng tái lập chính xác các kết quả tiền huấn luyện. Vui lòng tham khảo vấn đề này. - tie_word_embeddings (
bool, tùy chọn, mặc định làFalse) — Có nên gắn kết các trọng số nhúng theo ánh xạtied_weights_keyscủa mô hình hay không. - rope_parameters (
dict, tùy chọn) — 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ị chorope_thetavà 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ớimax_position_embeddingsdài hơn. - 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ú ý. - mlp_bias (
bool, tùy chọn, 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, tùy chọn, mặc định là128) — Kích thước chiều của đầu chú ý. Nếu là None, giá trị mặc định sẽ là hidden_size // num_attention_heads - sliding_window (
int, tùy chọn, mặc định là8192) — Kích thước cửa sổ của cơ chế chú ý cửa sổ trượt. Nếu làNone, sẽ không áp dụng cửa sổ trượt. - layer_types (
list[str], tùy chọn) — Một danh sách ánh xạ rõ ràng từng chỉ số lớp với kiểu lớp tương ứng. Nếu không được cung cấp, danh sách này sẽ được tạo tự động dựa trên các giá trị cấu hình.
Đây là lớp cấu hình để lưu trữ cấu hình của một CwmModel. Nó được sử dụng để khởi tạo một mô hình Cwm 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/cwm
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.
>>> from transformers import CwmModel, CwmConfig
>>> # Initializing a Cwm cwm-7b style configuration
>>> configuration = CwmConfig()
>>> # Initializing a model from the cwm-7b style configuration
>>> model = CwmModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configCwmPreTrainedModel
lớp transformers.CwmPreTrainedModel
< source >( config: PreTrainedConfig*inputs**kwargs )
Tham số
- config (PreTrainedConfig) — 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.
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.
Một giá trị giả lập cho một đường dẫn có dấu chấm (ví dụ: torch.float32): các chuỗi truy cập thuộc tính, các cuộc gọi hoạt động như các decorator pass-through, repr là đường dẫn có dấu chấm, và việc sử dụng nó như một lớp cơ sở sẽ thay thế bằng một lớp cơ sở type thông thường (PEP 560 __mro_entries__), do đó các lớp con thực sự vẫn giữ nguyên metaclass bình thường và inspect.signature sẽ đọc __init__ thực của chúng thay vì của một mock.
CwmModel
lớp transformers.CwmModel
< source >( config: CwmConfig )
Tham số
- config (CwmConfig) — 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.
Mô hình Cwm 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_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Noneuse_cache: bool | None = None**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CwmModelOutputWithPast or tuple(torch.Tensor)
Tham số
- input_ids (
torch.LongTensorcó 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ừ điển. Mặc định, padding sẽ bị bỏ qua.Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.
- 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.
- position_ids (
torch.LongTensorcó hình dạng(batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng[0, config.n_positions - 1]. - past_key_values (
~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value 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ự. Điều này thường bao gồmpast_key_valuesđược trả về bởi mô hình ở một giai đoạn giải mã trước đó, khiuse_cache=Truehoặcconfig.use_cache=True.Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền
past_key_values, 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
past_key_valuesđược sử dụng, người dùng được kỳ vọng chỉ nhậpinput_idschưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng(batch_size, unprocessed_length)thay vì toàn bộinput_idscó hình dạng(batch_size, sequence_length). - inputs_embeds (
torch.Tensorcó hình dạng(batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyềninput_ids, bạn có thể chọn 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_idsthà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. - use_cache (
bool, tùy chọn) — Nếu đặt thànhTrue, các trạng thái key value củapast_key_valuessẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xempast_key_values).
Trả về
CwmModelOutputWithPast hoặc tuple(torch.Tensor)
Một CwmModelOutputWithPast 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 (CwmConfig) và đầu vào.
Phương thức forward của CwmModel ghi đè 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.Nếu
past_key_valuesđược sử dụng, chỉ có hidden-state cuối cùng của các chuỗi có shape(batch_size, 1, hidden_size)được xuất ra.past_key_values (
Cache, tùy chọn, được trả về khiuse_cache=Trueđược truyền vào hoặc khiconfig.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention và tùy chọn nếu
config.is_encoder_decoder=Truetrong các khối cross-attention) có thể được sử dụng (xem đầu vàopast_key_values) để tăng tốc độ giải mã tuần tự.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.
CwmForCausalLM
lớp transformers.CwmForCausalLM
< source >( config: CwmConfig )
Tham số
- config (CwmConfig) — 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.
Mô hình Cwm cho mô hình hóa ngôn ngữ nhân quả.
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_ids: typing.Optional[torch.LongTensor] = Noneattention_mask: typing.Optional[torch.Tensor] = Noneposition_ids: typing.Optional[torch.LongTensor] = Nonepast_key_values: transformers.cache_utils.Cache | None = Noneinputs_embeds: typing.Optional[torch.Tensor] = Nonelabels: typing.Optional[torch.LongTensor] = Noneuse_cache: bool | None = Nonelogits_to_keep: typing.Union[int, torch.Tensor] = 0**kwargs: *<class 'transformers.utils.generic.TransformersKwargs'> ) → CausalLMOutputWithPast or tuple(torch.Tensor)
Tham số
- input_ids (
torch.LongTensorcó 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ừ điển. Mặc định, padding sẽ bị bỏ qua.Các chỉ số có thể được lấy bằng cách sử dụng AutoTokenizer. Xem PreTrainedTokenizer.encode() và PreTrainedTokenizer.call() để biết thêm chi tiết.
- 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.
- position_ids (
torch.LongTensorcó hình dạng(batch_size, sequence_length), tùy chọn) — Chỉ số vị trí của các token trong mỗi chuỗi đầu vào trong các position embeddings. Được chọn trong khoảng[0, config.n_positions - 1]. - past_key_values (
~cache_utils.Cache, tuỳ chọn) — Các hidden-state đã tính trước (key và value 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ự. Điều này thường bao gồmpast_key_valuesđược trả về bởi mô hình ở một giai đoạn giải mã trước đó, khiuse_cache=Truehoặcconfig.use_cache=True.Chỉ cho phép Cache instance làm đầu vào, xem hướng dẫn kv cache của chúng tôi. Nếu không truyền
past_key_values, 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
past_key_valuesđược sử dụng, người dùng được kỳ vọng chỉ nhậpinput_idschưa được xử lý (những phần chưa có trạng thái key value quá khứ được cung cấp cho mô hình này) có hình dạng(batch_size, unprocessed_length)thay vì toàn bộinput_idscó hình dạng(batch_size, sequence_length). - inputs_embeds (
torch.Tensorcó hình dạng(batch_size, sequence_length, hidden_size), tùy chọn) — Tùy chọn, thay vì truyềninput_ids, bạn có thể chọn 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_idsthà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.LongTensorcó shape(batch_size, sequence_length), tùy chọn) — Nhãn để tính toán tổn thất mô hình hóa ngôn ngữ có che (masked language modeling loss). Chỉ số phải nằm trong[0, ..., config.vocab_size]hoặc -100 (xem docstring củainput_ids). Các token có chỉ số được đặt thành-100sẽ bị bỏ qua (che), tổn thất chỉ được tính cho các token có nhãn nằm trong[0, ..., config.vocab_size]. - use_cache (
bool, tùy chọn) — Nếu đặt thànhTrue, các trạng thái key value củapast_key_valuessẽ được trả về và có thể được sử dụng để tăng tốc quá trình giải mã (xempast_key_values). - logits_to_keep (
Union[int, torch.Tensor], tùy chọn, mặc định là0) — Nếu làint, tính logits chologits_to_keeptoken cuối. Nếu là0, tính logits cho tất cảinput_ids(trường hợp đặc biệt). Chỉ cần logits của token cuối cho quá trình sinh, và việc chỉ tính cho token đó có thể tiết kiệm bộ nhớ, điều này trở nên khá đáng kể với các chuỗi dài hoặc kích thước từ vựng lớn. Nếu làtorch.Tensor, phải là 1 chiều tương ứng với các chỉ số cần giữ trong chiều độ dài chuỗi. Điều này hữu ích khi sử dụng định dạng tensor đóng gói (một chiều duy nhất cho batch và độ dài chuỗi).
Trả về
CausalLMOutputWithPast hoặc tuple(torch.Tensor)
Một CausalLMOutputWithPast 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 (CwmConfig) và đầu vào.
Phương thức forward của CwmForCausalLM 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).past_key_values (
Cache, tùy chọn, được trả về khiuse_cache=Trueđược truyền vào hoặc khiconfig.use_cache=True) — Đây là một instance của Cache. Để biết thêm chi tiết, hãy xem hướng dẫn về kv cache của chúng tôi.Chứa các hidden-states đã được tính trước (key và values trong các khối self-attention) có thể được sử dụng (xem đầu vào
past_key_values) để tăng tốc độ giải mã tuần tự.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 AutoTokenizer, CwmForCausalLM
>>> model = CwmForCausalLM.from_pretrained("meta-cwm/Cwm-2-7b-hf")
>>> tokenizer = AutoTokenizer.from_pretrained("meta-cwm/Cwm-2-7b-hf")
>>> prompt = "Hey, are you conscious? Can you talk to me?"
>>> inputs = tokenizer(prompt, return_tensors="pt")
>>> # Generate
>>> generate_ids = model.generate(inputs.input_ids, max_length=30)
>>> tokenizer.batch_decode(generate_ids, skip_special_tokens=True, clean_up_tokenization_spaces=False)[0]
"Hey, are you conscious? Can you talk to me?\nI'm not conscious, but I can talk to you."