KerasHub: 预训练模型 / API文档 / 模型架构 / PARSeq / PARSeqCausalLM 模型

PARSeqCausalLM 模型

[源代码]

PARSeqCausalLM

keras_hub.models.PARSeqCausalLM(
    preprocessor,
    backbone,
    num_perms=6,
    add_forward_perms=True,
    add_mirrored_perms=True,
    seed=None,
    end_token_id=0,
    **kwargs
)

使用PARSeq进行场景文本识别。使用 Scene Text Recognition with Permuted Autoregressive Sequence Models 中描述的PARSeq模型执行自然场景中的OCR。PARSeq是一个基于ViT的模型,它通过执行一个自回归解码阶段,然后进行一个细化阶段来实现迭代解码。参数

  • preprocessor: 一个 keras_hub.models.Preprocessor 实例或一个 keras.Layer 实例。模型使用的预处理器。
  • backbone: 一个 keras_hub.models.PARSeqBackbone 实例或一个 keras.Model。模型使用的骨干模型。
  • num_perms: int。用于训练生成排列的数量。默认为 6。
  • add_forward_perms: bool。是否将正向排列添加到生成的排列中。默认为 True
  • add_mirrored_perms: bool。是否将镜像排列添加到生成的排列中。默认为 True
  • seed: int。用于生成排列的随机种子。默认为 None,表示不设置种子。
  • **kwargs: 传递给基类 keras_hub.models.CausalLM 构造函数的额外关键字参数。

示例

调用 predict() 运行推理。

# Load preset and run inference
images = np.random.randint(0, 256, size=(2, 32, 128, 3))
parseq = keras_hub.models.PARSeqCausalLM.from_preset(
    "parseq_vit"
)
parseq.generate(images)

# Call `fit()` on a single batch.
images = np.random.randint(0, 256, size=(2, 32, 128, 3))
token_ids = np.array([[1, 2, 3, 4], [1, 2, 3, 0]])
padding_mask = np.array([[1, 1, 1, 1], [1, 1, 1, 0]])
parseq = keras_hub.models.PARSeqCausalLM.from_preset(
    "parseq_vit"
)
parseq.fit(
    x={
        "images": images,
        "token_ids": token_ids,
        "padding_mask": padding_mask
    },
    batch_size=2,
)

使用自定义损失、优化器和图像编码器调用 fit()

.

# Initialize the image encoder, preprocessor and tokenizer
mean, std = 0.5, 0.5
image_converter = PARSeqImageConverter(
    image_size=(32, 128),
    offset=-mean / std,
    scale=1.0 / 255.0 / std,
    interpolation="bicubic",
)
tokenizer = PARSeqTokenizer(max_label_length=25)
preprocessor = keras_hub.models.PARSeqCausalLMPreprocessor(
    image_converter=image_converter,
    tokenizer=tokenizer,
)

# Create the backbone
image_encoder = ViTBackbone(
    image_shape=(32, 128, 3),
    patch_size=(4, 8),
    num_layers=12,
    num_heads=6,
    hidden_dim=384,
    mlp_dim=384 * 4,
    use_class_token=False,
    name="encoder",
)
backbone = PARSeqBackbone(
    vocabulary_size=97,
    max_label_length=25,
    image_encoder=image_encoder,
    num_decoder_heads=12,
    num_decoder_layers=1,
    decoder_hidden_dim=384,
    decoder_mlp_dim=4 * 384,
)
# Create the PARSeq model
parseq = keras_hub.models.PARSeqCausalLM(
    backbone=backbone,
    preprocessor=preprocessor,
)
parseq.compile(
    loss=keras.losses.SparseCategoricalCrossentropy(from_logits=True),
    optimizer=keras.optimizers.Adam(5e-5),
)
parseq.fit(
    x={
        "images": images,
        "token_ids": token_ids,
        "padding_mask": padding_mask
    },
    batch_size=2,
)

[源代码]

from_preset 方法

PARSeqCausalLM.from_preset(preset, load_weights=True, **kwargs)

从模型预设实例化一个 keras_hub.models.Task

预设是一个包含配置、权重和其他文件资产的目录,用于保存和加载预训练模型。preset 可以作为以下之一传递:

  1. 一个内置的预设标识符,如 'bert_base_en'
  2. 一个 Kaggle Models 句柄,如 'kaggle://user/bert/keras/bert_base_en'
  3. 一个 Hugging Face 句柄,如 'hf://user/bert_base_en'
  4. 一个本地预设目录的路径,如 './bert_base_en'

对于任何 Task 子类,您都可以运行 cls.presets.keys() 来列出该类上所有可用的内置预设。

此构造函数可以通过两种方式调用。一种方式是从特定任务的基类(如 keras_hub.models.CausalLM.from_preset())调用,另一种方式是从模型类(如 keras_hub.models.BertTextClassifier.from_preset())调用。如果从基类调用,返回对象的子类将从预设目录中的配置推断出来。

参数

  • preset:字符串。一个内置预设标识符、一个 Kaggle Models 句柄、一个 Hugging Face 句柄或一个本地目录的路径。
  • load_weights: 布尔值。如果为 True,已保存的权重将被加载到模型架构中。如果为 False,所有权重将被随机初始化。

示例

# Load a Gemma generative task.
causal_lm = keras_hub.models.CausalLM.from_preset(
    "gemma_2b_en",
)

# Load a Bert classification task.
model = keras_hub.models.TextClassifier.from_preset(
    "bert_base_en",
    num_classes=2,
)
预设 参数 描述
parseq 23.83M 用于场景文本识别的排列自回归序列 (PARSeq) 基础模型。

[源代码]

generate 方法

PARSeqCausalLM.generate(
    inputs, max_length=None, stop_token_ids="auto", strip_prompt=False
)

根据提示 inputs 生成文本。

此方法根据给定的 inputs 生成文本。用于生成的采样方法可以通过 compile() 方法设置。

如果 inputs 是一个 tf.data.Dataset,输出将“逐批”生成并连接起来。否则,所有输入将被视为单个批次处理。

如果模型附加了 preprocessorinputs 将在 generate() 函数内部进行预处理,并且应与 preprocessor 层期望的结构匹配(通常是原始字符串)。如果未附加 preprocessor,则 inputs 应与 backbone 期望的结构匹配。请参阅上面的示例用法以了解每个的演示。

参数

  • inputs: python 数据、张量数据或 tf.data.Dataset。如果模型附加了 preprocessorinputs 应与 preprocessor 层期望的结构匹配。如果未附加 preprocessorinputs 应与 backbone 模型期望的结构匹配。
  • max_length: 可选。int。生成序列的最大长度。将默认为 preprocessor 配置的 sequence_length 最大值。如果 preprocessorNone,则 inputs 应填充到所需的最大长度,并且此参数将被忽略。
  • stop_token_ids: 可选。None、"auto" 或 token ID 的元组。默认为 "auto",它使用 preprocessor.tokenizer.end_token_id。不指定处理器将产生错误。None 在生成 max_length 个 token 后停止生成。您也可以指定一个 token ID 列表,模型应在此停止。请注意,token 序列中的每个序列都将被解释为一个停止 token,不支持多 token 停止序列。
  • strip_prompt:可选。默认情况下,generate() 返回完整的提示及其后由模型生成的补全内容。如果此选项设置为 True,则只返回新生成的文本。

backbone 属性

keras_hub.models.PARSeqCausalLM.backbone

一个具有核心架构的 keras_hub.models.Backbone 模型。


preprocessor 属性

keras_hub.models.PARSeqCausalLM.preprocessor

用于预处理输入的 keras_hub.models.Preprocessor 层。