GPT-NeoX-日语
概述
我们介绍了 GPT-NeoX-日语，这是一种用于日语的自回归语言模型，基于 https://github.com/EleutherAI/gpt-neox 训练。日语是一种独特的语言，拥有庞大的词汇量，并结合了平假名、片假名和汉字三种书写系统。为了解决日语这种独特的结构，我们使用了 特殊的子词分词器。我们非常感谢 tanreinama 开源了这个非常有帮助的分词器。遵循 Google 关于 PaLM 的研究建议，我们从 Transformer 块中去除了偏差参数，从而实现了更好的模型性能。请参阅 这篇文章 以了解更多详细信息。
模型的开发由来自 ABEJA, Inc. 的 Shinya Otani、Takayoshi Makabe、Anuj Arora 和 Kyo Hattori 领导。有关此模型构建活动的更多信息，请参阅 此处 (ja)。
使用示例
generate() 方法可用于使用 GPT NeoX 日语模型生成文本。
>>> from transformers import GPTNeoXJapaneseForCausalLM, GPTNeoXJapaneseTokenizer
>>> model = GPTNeoXJapaneseForCausalLM.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> tokenizer = GPTNeoXJapaneseTokenizer.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> prompt = "人とAIが協調するためには、"
>>> input_ids = tokenizer(prompt, return_tensors="pt").input_ids
>>> gen_tokens = model.generate(
... input_ids,
... do_sample=True,
... temperature=0.9,
... max_length=100,
... )
>>> gen_text = tokenizer.batch_decode(gen_tokens, skip_special_tokens=True)[0]
>>> print(gen_text)
人とAIが協調するためには、AIと人が共存し、AIを正しく理解する必要があります。资源
GPTNeoXJapaneseConfig
类 transformers.GPTNeoXJapaneseConfig
< 源代码 >( vocab_size = 32000 hidden_size = 2560 num_hidden_layers = 32 num_attention_heads = 32 intermediate_multiple_size = 4 hidden_act = 'gelu' rotary_pct = 1.0 rotary_emb_base = 10000 max_position_embeddings = 2048 initializer_range = 0.02 layer_norm_eps = 1e-05 use_cache = True bos_token_id = 31996 eos_token_id = 31999 rope_scaling = None attention_dropout = 0.1 hidden_dropout = 0.0 **kwargs )
参数
- vocab_size (
int, 可选, 默认为 32000) — GPTNeoXJapanese 模型的词汇量大小。定义了调用GPTNeoXJapanese时传递的inputs_ids可以表示的不同标记的数量。 - hidden_size (
int, 可选, 默认为 2560) — 编码器层和池化层的维度。 - num_hidden_layers (
int, 可选, 默认为 32) — Transformer 编码器中的隐藏层数。 - num_attention_heads (
int, 可选, 默认为 32) — Transformer 编码器中每个注意力层的注意力头数。 - intermediate_multiple_size (
int, 可选, 默认为 4) — Transformer 编码器中“中间”层的维度由 hidden_size * intermediate_multiple_size 计算得出。 - rotary_pct (
float，可选，默认为 1.00) — 分配给旋转嵌入的隐藏维度的百分比 - rotary_emb_base (
int，可选，默认为 10000) — 计算旋转嵌入频率的基数 - max_position_embeddings (
int，可选，默认为 2048) — 此模型可能使用的最大序列长度。 - initializer_range (
float，可选，默认为 0.02) — 初始化所有权重矩阵的截断正态初始化器的标准差。 - layer_norm_eps (
float，可选，默认为 1e-5) — 层归一化层使用的 epsilon。 - use_cache (
bool，可选，默认为True) — 模型是否应该返回最后的键/值注意力（并非所有模型都使用）。仅当config.is_decoder=True时相关。 - rope_scaling (
Dict，可选) — 包含 RoPE 嵌入缩放配置的字典。注意：如果您应用新的 rope 类型并且您希望模型在更长的max_position_embeddings上工作，我们建议您相应地更新此值。预期内容：rope_type(str)：要使用的 RoPE 的子变体。可以是 [‘default’, ‘linear’, ‘dynamic’, ‘yarn’, ‘longrope’, ‘llama3’] 中的一个，其中 ‘default’ 是原始 RoPE 实现。factor(float，可选)：用于除 ‘default’ 之外的所有 rope 类型。要应用于 RoPE 嵌入的缩放因子。在大多数缩放类型中，factor为 x 将使模型能够处理长度为 x * 原始最大预训练长度的序列。original_max_position_embeddings(int，可选)：用于 ‘dynamic’, ‘longrope’ 和 ‘llama3’。预训练期间使用的原始最大位置嵌入。attention_factor(float，可选)：用于 ‘yarn’ 和 ‘longrope’。要应用于注意力计算的缩放因子。如果未指定，则默认为实现推荐的值，使用factor字段推断建议值。beta_fast(float，可选)：仅用于 ‘yarn’。设置线性斜坡函数中外推（仅）边界的参数。如果未指定，则默认为 32。beta_slow(float，可选)：仅用于 ‘yarn’。设置线性斜坡函数中插值（仅）边界的参数。如果未指定，则默认为 1。short_factor(List[float]，可选)：仅用于 ‘longrope’。要应用于短上下文（<original_max_position_embeddings）的缩放因子。必须是与隐藏大小相同长度的数字列表，除以注意力头的数量除以 2long_factor(List[float]，可选)：仅用于 ‘longrope’。要应用于长上下文（<original_max_position_embeddings）的缩放因子。必须是与隐藏大小相同长度的数字列表，除以注意力头的数量除以 2low_freq_factor(float，可选)：仅用于 ‘llama3’。应用于 RoPE 低频分量的缩放因子high_freq_factor(float，可选)：仅用于 ‘llama3’。应用于 RoPE 高频分量的缩放因子 - attention_dropout (
float，可选，默认为 0.1) — 注意力的 dropout 比率。 - hidden_dropout (
float，可选，默认为 0.0) — 隐藏层的 dropout 比率。示例 —
这是用于存储 GPTNeoXModelJapanese 配置的配置类。它用于根据指定的参数实例化 GPTNeoX 模型，定义模型架构。使用默认值实例化配置将产生与 GPTNeoXJapanese abeja/gpt-neox-japanese-2.7b 架构类似的配置。
配置对象继承自 PretrainedConfig 并可用于控制模型输出。阅读 PretrainedConfig 中的文档以获取更多信息。默认配置设置为 2.7B 模型
>>> from transformers import GPTNeoXJapaneseConfig, GPTNeoXJapaneseModel
>>> # Initializing a GPTNeoXJapanese gpt-neox-japanese-2.7b style configuration
>>> configuration = GPTNeoXJapaneseConfig()
>>> # Initializing a model (with random weights) from the gpt-neox-japanese-2.7b style configuration
>>> model = GPTNeoXJapaneseModel(configuration)
>>> # Accessing the model configuration
>>> configuration = model.configGPTNeoXJapaneseTokenizer
类 transformers.GPTNeoXJapaneseTokenizer
< 源代码 >( vocab_file emoji_file unk_token = '<|endoftext|>' pad_token = '<|endoftext|>' bos_token = '<|startoftext|>' eos_token = '<|endoftext|>' do_clean_text = False **kwargs )
参数
- vocab_file (
str) — 包含词汇表的的文件。 - emoji_file (
str) — 包含表情符号的文件。 - unk_token (
str, 可选, 默认为"<|endoftext|>") — 未知标记。词汇表中不存在的标记无法转换为 ID，而是设置为此标记。 - pad_token (
str, 可选, 默认为"<|endoftext|>") — 用于填充的标记 - bos_token (
str, 可选, 默认为"<|startoftext|>") — 序列开始标记。 - eos_token (
str, 可选, 默认为"<|endoftext|>") — 序列结束标记。 - do_clean_text (
bool, 可选, 默认为False) — 是否清理 URL、EMAIL、TEL、日语日期和日语价格的文本。
此分词器继承自 PreTrainedTokenizer，并且基于此存储库中使用的日语特殊子词编码 (https://github.com/tanreinama/Japanese-BPEEncoder_V2)。查看存储库以获取详细信息。日语词汇量相对较大，单词之间没有分隔符。此外，该语言是平假名、片假名和汉字的组合，并且经常使用“1”和“①”等变体。为了应对这些问题，此分词器具有以下功能
- 介于字节字符串和形态分析之间的子词分割。
- 为每个汉字、平假名和片假名字符创建 BPE，并且没有跨字符类型的 BPE，例如汉字 + 平假名或平假名 + 片假名。
- 不需要<unk>的全字节编码。
- 独立于 2 字节和 3 字节字符等 UTF 编码
- 将异形词转换为相同的 token_id。
- 表情符号和表情被分组为 12 种类型的特殊标签。
示例
>>> from transformers import GPTNeoXJapaneseTokenizer
>>> tokenizer = GPTNeoXJapaneseTokenizer.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> # You can confirm both 慶応 and 慶應 are encoded to 17749
>>> tokenizer("吾輩は猫である🐯。実は慶応(慶應)大学出身")["input_ids"]
[30014, 26883, 26638, 27228, 25, 26650, 31732, 31679, 27809, 26638, 17749, 31592, 17749, 31593, 321, 1281]
>>> # Both 慶応 and 慶應 are decoded to 慶応
>>> tokenizer.decode(tokenizer("吾輩は猫である🐯。実は慶応(慶應)大学出身")["input_ids"])
'吾輩は猫である🐯。実は慶応(慶応)大学出身'将一系列标记（字符串）转换为单个字符串。
GPTNeoXJapaneseModel
类 transformers.GPTNeoXJapaneseModel
< 源代码 >( config )
参数
- config (~GPTNeoXJapaneseConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，仅加载配置。查看 from_pretrained() 方法以加载模型权重。
基本的 GPTNeoXJapanese 模型转换器，输出原始隐藏状态，没有任何特定的头部。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规的 PyTorch 模块，并参考 PyTorch 文档了解与一般用法和行为相关的所有事项。
正向传播
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None head_mask: Optional = None inputs_embeds: Optional = None past_key_values: Union = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) → transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (
torch.LongTensor形状为(batch_size, sequence_length)) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。
- attention_mask (
torch.FloatTensor形状为(batch_size, sequence_length)，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 分段标记索引，用于指示输入的第一部分和第二部分。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定头的输出无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头**未被掩码**，
- 0 表示头**被掩码**。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型内部嵌入查找矩阵更好地控制如何将 input_ids 索引转换为关联向量，这将非常有用。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包含模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例；
- 长度为
config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为旧的缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，则将返回旧的缓存格式。如果使用
past_key_values，则用户可以选择仅输入形状为(batch_size, 1)的最后一个input_ids（其过去键值状态未提供给此模型）而不是形状为(batch_size, sequence_length)的所有input_ids。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量下的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量下的hidden_states。 - return_dict (
bool，可选) — 是否返回 ModelOutput 而不是普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length)，可选) — 描述输入序列中 token 位置的索引。与position_ids相反，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。
返回
transformers.modeling_outputs.BaseModelOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.BaseModelOutputWithPast 或 torch.FloatTensor 的元组（如果传递了 return_dict=False 或 config.return_dict=False 时），包含取决于配置（GPTNeoXJapaneseConfig）和输入的各种元素。
-
last_hidden_state (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)) — 模型最后一层的输出处的隐藏状态序列。如果使用
past_key_values，则仅输出形状为(batch_size, 1, hidden_size)的序列的最后一个隐藏状态。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量，并且如果config.is_encoder_decoder=True，则可选地包含 2 个形状为(batch_size, num_heads, encoder_sequence_length, embed_size_per_head)的附加张量。包含预计算的隐藏状态（自注意力块中的键和值，以及如果
config.is_encoder_decoder=True则可选地包含交叉注意力块中的键和值），可用于（参见past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型具有嵌入层，则包含嵌入输出，以及每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
GPTNeoXJapaneseModel 的前向方法覆盖了 __call__ 特殊方法。
虽然前向传递的步骤需要在这个函数中定义，但是之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GPTNeoXJapaneseModel
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> model = GPTNeoXJapaneseModel.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> inputs = tokenizer("日本語のGPT-neoxがHugging Faceで使えます😀", return_tensors="pt")
>>> outputs = model(**inputs)
>>> last_hidden_states = outputs.last_hidden_stateGPTNeoXJapaneseForCausalLM
类 transformers.GPTNeoXJapaneseForCausalLM
< 源代码 >( config )
参数
- config (~GPTNeoXJapaneseConfig) — 模型配置类，包含模型的所有参数。使用配置文件初始化不会加载与模型关联的权重，只会加载配置。查看 from_pretrained() 方法以加载模型权重。
带有用于分类器模型微调的 语言建模 头的 GPTNeoXJapanese 模型。此模型是 PyTorch torch.nn.Module 的子类。将其用作常规 PyTorch 模块，并参考 PyTorch 文档以了解与一般用法和行为相关的所有事项。
正向传播
< 源代码 >( input_ids: Optional = None attention_mask: Optional = None position_ids: Optional = None inputs_embeds: Optional = None head_mask: Optional = None past_key_values: Union = None labels: Optional = None use_cache: Optional = None output_attentions: Optional = None output_hidden_states: Optional = None return_dict: Optional = None cache_position: Optional = None ) → transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
参数
- input_ids (形状为
(batch_size, sequence_length)的torch.LongTensor) — 词汇表中输入序列标记的索引。可以使用 AutoTokenizer 获取索引。
- attention_mask (形状为
(batch_size, sequence_length)的torch.FloatTensor，可选) — 用于避免对填充标记索引执行注意力的掩码。掩码值选择在[0, 1]中：- 1 表示未掩码的标记，
- 0 表示掩码的标记。
- token_type_ids (形状为
(batch_size, sequence_length)的torch.LongTensor，可选) — 用于指示输入的第一部分和第二部分的段标记索引。索引选择在[0, 1]中：- 0 对应于句子 A 标记，
- 1 对应于句子 B 标记。
- position_ids (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 输入序列中每个 token 在位置嵌入中的位置索引。选择范围为[0, config.max_position_embeddings - 1]。 - head_mask (
torch.FloatTensor形状为(num_heads,)或(num_layers, num_heads)，可选) — 用于使自注意力模块中选定头的输出无效的掩码。掩码值选择范围为[0, 1]：- 1 表示头部 **未被掩码**，
- 0 表示头部 **被掩码**。
- inputs_embeds (
torch.FloatTensor形状为(batch_size, sequence_length, hidden_size)，可选) — 可选地，您可以选择直接传递嵌入表示，而不是传递input_ids。如果您希望比模型的内部嵌入查找矩阵更细致地控制如何将 input_ids 索引转换为关联向量，这将非常有用。 - past_key_values (
Cache或tuple(tuple(torch.FloatTensor))，可选) — 预先计算的隐藏状态（自注意力块和交叉注意力块中的键和值），可用于加速顺序解码。这通常包括模型在解码的先前阶段返回的past_key_values，当use_cache=True或config.use_cache=True时。允许两种格式：
- 一个 Cache 实例；
- 长度为
config.n_layers的tuple(tuple(torch.FloatTensor))，每个元组包含 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。这也被称为传统缓存格式。
模型将输出与输入相同的缓存格式。如果未传递
past_key_values，则将返回传统缓存格式。如果使用
past_key_values，则用户可以选择仅输入最后的input_ids（这些input_ids未向此模型提供其过去的键值状态），形状为(batch_size, 1)，而不是所有input_ids，形状为(batch_size, sequence_length)。 - use_cache (
bool，可选) — 如果设置为True，则返回past_key_values键值状态，并可用于加速解码（参见past_key_values）。 - output_attentions (
bool，可选) — 是否返回所有注意力层的注意力张量。有关更多详细信息，请参阅返回张量中的attentions。 - output_hidden_states (
bool，可选) — 是否返回所有层的隐藏状态。有关更多详细信息，请参阅返回张量中的hidden_states。 - return_dict (
bool，可选) — 是否返回一个 ModelOutput 而不是一个普通元组。 - cache_position (
torch.LongTensor形状为(sequence_length)，可选) — 描述输入序列中 token 在序列中的位置的索引。与position_ids不同，此张量不受填充的影响。它用于在正确的位置更新缓存并推断完整的序列长度。 - labels (
torch.LongTensor形状为(batch_size, sequence_length)，可选) — 用于计算从左到右语言建模损失（下一个词预测）的标签。索引应在[-100, 0, ..., config.vocab_size]中（参见input_ids文档字符串）索引设置为-100的标记将被忽略（屏蔽），损失仅针对标签在[0, ..., config.vocab_size]中的标记计算。
返回
transformers.modeling_outputs.CausalLMOutputWithPast 或 tuple(torch.FloatTensor)
一个 transformers.modeling_outputs.CausalLMOutputWithPast 或一个 torch.FloatTensor 的元组（如果传递了 return_dict=False 或当 config.return_dict=False 时），包含根据配置 (GPTNeoXJapaneseConfig) 和输入而变化的各种元素。
-
loss (
torch.FloatTensor形状为(1,)，可选，在提供labels时返回) — 语言建模损失（用于下一个标记预测）。 -
logits (
torch.FloatTensor形状为(batch_size, sequence_length, config.vocab_size)) — 语言建模头的预测分数（SoftMax 之前的每个词汇标记的分数）。 -
past_key_values (
tuple(tuple(torch.FloatTensor))，可选，当传递use_cache=True或当config.use_cache=True时返回) — 长度为config.n_layers的tuple(torch.FloatTensor)元组，每个元组具有 2 个形状为(batch_size, num_heads, sequence_length, embed_size_per_head)的张量。包含预计算的隐藏状态（自注意力块中的键和值），可用于（参见
past_key_values输入）加速顺序解码。 -
hidden_states (
tuple(torch.FloatTensor)，可选，当传递output_hidden_states=True或config.output_hidden_states=True时返回) — 形状为(batch_size, sequence_length, hidden_size)的torch.FloatTensor元组（如果模型具有嵌入层，则包含嵌入输出，以及每一层的输出）。模型在每一层输出处的隐藏状态，以及可选的初始嵌入输出。
-
attentions (
tuple(torch.FloatTensor)，可选，当传递output_attentions=True或config.output_attentions=True时返回) — 形状为(batch_size, num_heads, sequence_length, sequence_length)的torch.FloatTensor元组（每一层一个）。注意力 softmax 之后的注意力权重，用于计算自注意力头中的加权平均值。
GPTNeoXJapaneseForCausalLM 的前向方法，覆盖了 __call__ 特殊方法。
虽然前向传递的步骤需要在这个函数中定义，但是之后应该调用 Module 实例而不是这个函数，因为前者会处理预处理和后处理步骤，而后者会默默地忽略它们。
示例
>>> from transformers import AutoTokenizer, GPTNeoXJapaneseForCausalLM, GPTNeoXJapaneseConfig
>>> import torch
>>> tokenizer = AutoTokenizer.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> config = GPTNeoXJapaneseConfig.from_pretrained("abeja/gpt-neox-japanese-2.7b")
>>> config.is_decoder = True
>>> model = GPTNeoXJapaneseForCausalLM.from_pretrained("abeja/gpt-neox-japanese-2.7b", config=config)
>>> inputs = tokenizer("日本語のGPT-neoxがHugging Faceで使えます😀", return_tensors="pt")
>>> outputs = model(**inputs)
>>> prediction_logits = outputs.logits