TransformersPHP

面向 PHP 的最先进机器学习框架

TransformersPHP 的设计目标是与 Python 库功能完全一致，同时保持相同的性能和易用性。该库基于 Hugging Face 的 Transformers 库构建，后者提供了 100 多种语言的数千个预训练模型。它专为 PHP 开发者打造，采用与 Python 库相似的 API，简单易用。这些模型可用于多种任务，包括文本生成、摘要提取、翻译等。

TransformersPHP 使用 ONNX Runtime 来运行模型，这是一种用于 Open Neural Network Exchange (ONNX) 模型的高性能推理引擎。您可以轻松将任何 PyTorch 或 TensorFlow 模型转换为 ONNX 格式，并借助 🤗 Optimum 在 TransformersPHP 中使用。

如需了解更多关于该库及其工作原理的信息，请访问我们的详细文档。

快速入门

由于 TransformersPHP 的设计目标是与 Python 库功能完全一致，因此您可以轻松地从现有的 Python 或 JavaScript 代码中学习。我们提供了 pipeline API，这是一个高级、易于使用的接口，可将模型与其必要的预处理和后处理步骤组合在一起。

from transformers import pipeline

# 分配一个情感分析管道
pipe = pipeline('sentiment-analysis')

out = pipe('I love transformers!')
# [{'label': 'POSITIVE', 'score': 0.999806941}]

use function Codewithkyrian\Transformers\Pipelines\pipeline;

// 分配一个情感分析管道
$pipe = pipeline('sentiment-analysis');

$out = $pipe('I love transformers!');
// [{'label': 'POSITIVE', 'score': 0.999808732}]

import {pipeline} from '@xenova/transformers';

// 分配一个情感分析管道
let pipe = await pipeline('sentiment-analysis');

let out = await pipe('I love transformers!');
// [{'label': 'POSITIVE', 'score': 0.999817686}]

您还可以通过在 pipeline 函数中指定模型 ID 或路径来使用不同的模型。例如：

use function Codewithkyrian\Transformers\Pipelines\pipeline;

// 分配一个翻译管道
$pipe = pipeline('translation', 'Xenova/distilbert-base-uncased-finetuned-sst-2-english');

安装

您可以通过 Composer 安装该库。这是推荐的安装方式。

composer require codewithkyrian/transformers

[!CAUTION] ONNX 库具有平台特定性，因此务必在代码将要执行的目标平台上运行 composer require 命令。大多数情况下，这将是您的开发机器或部署应用程序的服务器；但如果您使用的是 Docker 容器，请在该容器内运行 composer require 命令。

PHP FFI 扩展

TransformersPHP 使用 PHP FFI 扩展与 ONNX 运行时进行交互。FFI 扩展默认包含在 PHP 7.4 及更高版本中，但可能未默认启用。如果 FFI 扩展未启用，您可以通过取消注释（移除行首的 ;）以下行来启用它：

extension = ffi

此外，您还需要在 php.ini 文件中将 ffi.enable 指令设置为 true：

ffi.enable = true

完成这些更改后，请重启您的 Web 服务器或 PHP-FPM 服务，即可正常使用。

文档

有关如何使用该库的更多详细信息，请参阅文档：https://codewithkyrian.github.io/transformers-php

使用方法

默认情况下，TransformersPHP 使用托管的预训练 ONNX 模型。对于支持的任务，那些已转换为可在 Hugging Face 上与 Xenova's Transformers.js 配合使用的模型，可以直接在 TransformersPHP 中使用。

配置

您可以按如下方式配置 TransformersPHP 库的行为：

use Codewithkyrian\Transformers\Transformers;

Transformers::setup()
    ->setCacheDir('...') // 设置变压器模型的默认缓存目录，默认为 `.transformers-cache/models`
    ->setRemoteHost('...') // 设置下载模型的远程主机，默认为 `https://huggingface.co`
    ->setRemotePathTemplate('...') // 设置下载模型的远程路径模板，默认为 `{model}/resolve/{revision}/{file}`
    ->setAuthToken('...') // 设置下载模型的认证令牌，默认为 `null`
    ->setUserAgent('...') // 设置下载模型的用户代理，默认为 `transformers-php/{version}`
    ->setImageDriver('...') // 设置图像处理驱动程序，默认为 `VIPS`
    ->setLogger($logger) // 设置兼容 PSR-3 的日志记录器，默认为 `NullLogger`，若未设置则使用此值
    ->apply(); // 应用配置

您可以按任意顺序调用 set 方法，也可以完全省略某些方法，此时将使用默认值。有关配置选项及其含义的更多信息，请参阅文档。

将您的模型转换为 ONNX

TransformersPHP 仅支持 ONNX 模型，因此您必须将 PyTorch、TensorFlow 或 JAX 模型转换为 ONNX 格式。我们建议使用 Transformers.js 提供的 转换脚本，该脚本在后台利用 🤗 Optimum 来完成模型的转换和量化。

python -m convert --quantize --model_id <model_name_or_path>

预先下载模型

默认情况下，当您首次使用流水线或预训练模型时，TransformersPHP 会自动从 Hugging Face 模型库中获取 ONNX 格式的模型权重。这可能会导致首次使用时出现轻微延迟。为了提升用户体验，建议在 PHP 应用程序中运行模型之前，预先下载您计划使用的模型，尤其是大型模型。一种方法是手动执行一次请求，但 TransformersPHP 也提供了一个命令行工具来帮助您完成这一操作：

./vendor/bin/transformers download <model_identifier> [<task>] [options]

参数说明：

• ：指定您要下载的模型。您可以通过浏览 Hugging Face 模型库（https://huggingface.co/models?library=transformers.js）找到模型标识符。
• [<task>]：（可选）此参数允许下载特定任务的配置和权重。如果您知道将使用该模型的具体任务（例如“text2text-generation”），则此选项会很有帮助。
• [options]：（可选）您可以使用额外的选项进一步自定义下载过程：
  • --cache_dir=<directory>：指定存储已下载模型的目录（默认为配置的缓存目录）。您可以在命令中使用 -c 作为快捷方式。
  • --quantized=<true|false>：如果可用，则下载量化的模型版本（默认为 true）。量化后的模型体积更小、速度更快，但准确性可能略低。您可以在命令中使用 -q 作为快捷方式。

[!CAUTION] 请务必将您的缓存目录添加到 .gitignore 文件中，以避免将已下载的模型提交到您的 Git 仓库。

支持的任务/模型

本包目前仍在开发中，但以下是 TransformersPHP 当前测试并支持的任务和架构列表。

任务

自然语言处理

视觉

音频

表格数据

多模态

强化学习

模型

1. ALBERT（由谷歌研究院和芝加哥丰田技术研究所共同开发）随论文《ALBERT：用于自监督语言表示学习的轻量级BERT》一同发布，作者为Zhenzhong Lan、Mingda Chen、Sebastian Goodman、Kevin Gimpel、Piyush Sharma和Radu Soricut。
2. BART（由Facebook开发）随论文《BART：面向自然语言生成、翻译和理解的去噪序列到序列预训练》一同发布，作者为Mike Lewis、Yinhan Liu、Naman Goyal、Marjan Ghazvininejad、Abdelrahman Mohamed、Omer Levy、Ves Stoyanov和Luke Zettlemoyer。
3. BERT（由谷歌开发）随论文《BERT：用于语言理解的深度双向Transformer预训练》一同发布，作者为Jacob Devlin、Ming-Wei Chang、Kenton Lee和Kristina Toutanova。
4. BERT For Sequence Generation（由谷歌开发）随论文《利用预训练检查点进行序列生成任务》一同发布，作者为Sascha Rothe、Shashi Narayan和Aliaksei Severyn。
5. BERTweet（由VinAI Research开发）随论文《BERTweet：面向英文推文的预训练语言模型》一同发布，作者为Dat Quoc Nguyen、Thanh Vu和Anh Tuan Nguyen。
6. BigBird-Pegasus（由谷歌研究院开发）随论文《Big Bird：适用于更长序列的Transformer》一同发布，作者为Manzil Zaheer、Guru Guruganesh、Avinava Dubey、Joshua Ainslie、Chris Alberti、Santiago Ontanon、Philip Pham、Anirudh Ravula、Qifan Wang、Li Yang和Amr Ahmed。
7. BigBird-RoBERTa（由谷歌研究院开发）随论文《Big Bird：适用于更长序列的Transformer》一同发布，作者同上。
8. CLIP（由OpenAI开发）随论文《从自然语言监督中学习可迁移视觉模型》一同发布，作者为Alec Radford、Jong Wook Kim、Chris Hallacy、Aditya Ramesh、Gabriel Goh、Sandhini Agarwal、Girish Sastry、Amanda Askell、Pamela Mishkin、Jack Clark、Gretchen Krueger和Ilya Sutskever。
9. CodeGen（由Salesforce开发）随论文《面向程序合成的对话式范式》一同发布，作者为Erik Nijkamp、Bo Pang、Hiroaki Hayashi、Lifu Tu、Huan Wang、Yingbo Zhou、Silvio Savarese和Caiming Xiong。
10. ConvBERT（由YituTech开发）随论文《ConvBERT：基于跨度的动态卷积改进BERT》一同发布，作者为Zihang Jiang、Weihao Yu、Daquan Zhou、Yunpeng Chen、Jiashi Feng和Shuicheng Yan。
11. DeBERTa（由微软开发）随论文《DeBERTa：解耦注意力机制的解码增强型BERT》一同发布，作者为Pengcheng He、Xiaodong Liu、Jianfeng Gao和Weizhu Chen。
12. DeBERTa-v2（由微软开发）随论文《DeBERTa：解耦注意力机制的解码增强型BERT》一同发布，作者同上。
13. DETR（由Facebook开发）随论文《基于Transformer的端到端目标检测》一同发布，作者为Nicolas Carion、Francisco Massa、Gabriel Synnaeve、Nicolas Usunier、Alexander Kirillov和Sergey Zagoruyko。
14. DistilBERT（由HuggingFace开发），随论文《DistilBERT：BERT的蒸馏版本——更小、更快、更便宜、更轻》一同发布，作者为Victor Sanh、Lysandre Debut和Thomas Wolf。同样的方法也被应用于将GPT2压缩为DistilGPT2，将RoBERTa压缩为DistilRoBERTa，将多语言BERT压缩为DistilmBERT，以及德语版的DistilBERT。
15. Donut（由NAVER开发），随论文《无OCR文档理解Transformer》一同发布，作者为Geewook Kim、Teakgyu Hong、Moonbin Yim、Jeongyeon Nam、Jinyoung Park、Jinyeong Yim、Wonseok Hwang、Sangdoo Yun、Dongyoon Han和Seunghyun Park。
16. ELECTRA（由谷歌研究院/斯坦福大学联合开发）随论文《ELECTRA：将文本编码器作为判别器而非生成器进行预训练》一同发布，作者为Kevin Clark、Minh-Thang Luong、Quoc V. Le和Christopher D. Manning。
17. FLAN-T5（由Google AI开发）在google-research/t5x仓库中发布，作者为Hyung Won Chung、Le Hou、Shayne Longpre、Barret Zoph、Yi Tay、William Fedus、Eric Li、Xuezhi Wang、Mostafa Dehghani、Siddhartha Brahma、Albert Webson、Shixiang Shane Gu、Zhuyun Dai、Mirac Suzgun、Xinyun Chen、Aakanksha Chowdhery、Sharan Narang、Gaurav Mishra、Adams Yu、Vincent Zhao、Yanping Huang、Andrew Dai、Hongkun Yu、Slav Petrov、Ed H. Chi、Jeff Dean、Jacob Devlin、Adam Roberts、Denny Zhou、Quoc V. Le和Jason Wei。
18. GPT-2（由OpenAI开发）随论文《语言模型是无监督的多任务学习者》一同发布，作者为Alec Radford*、Jeffrey Wu*、Rewon Child、David Luan、Dario Amodei和Ilya Sutskever。
19. GPT-J（由EleutherAI开发）在kingoflolz/mesh-transformer-jax仓库中发布，作者为Ben Wang和Aran Komatsuzaki。
20. GPTBigCode（由BigCode开发）随论文《SantaCoder：不要好高骛远！》一同发布，作者为Loubna Ben Allal、Raymond Li、Denis Kocetkov、Chenghao Mou、Christopher Akiki、Carlos Munoz Ferrandis、Niklas Muennighoff、Mayank Mishra、Alex Gu、Manan Dey、Logesh Kumar Umapathi、Carolyn Jane Anderson、Yangtian Zi、Joel Lamy Poirier、Hailey Schoelkopf、Sergey Troshin、Dmitry Abulkhanov、Manuel Romero、Michael Lappert、Francesco De Toni、Bernardo García del Río、Qian Liu、Shamik Bose、Urvashi Bhattacharyya、Terry Yue Zhuo、Ian Yu、Paulo Villegas、Marco Zocca、Sourab Mangrulkar、David Lansky、Huu Nguyen、Danish Contractor、Luis Villa、Jia Li、Dzmitry Bahdanau、Yacine Jernite、Sean Hughes、Daniel Fried、Arjun Guha、Harm de Vries和Leandro von Werra。
21. M2M100（由Facebook开发）随论文《超越以英语为中心的多语言机器翻译》一同发布，作者为Angela Fan、Shruti Bhosale、Holger Schwenk、Zhiyi Ma、Ahmed El-Kishky、Siddharth Goyal、Mandeep Baines、Onur Celebi、Guillaume Wenzek、Vishrav Chaudhary、Naman Goyal、Tom Birch、Vitaliy Liptchinsky、Sergey Edunov、Edouard Grave、Michael Auli和Armand Joulin。
22. MobileBERT（由CMU/Google Brain联合开发）随论文《MobileBERT：一种适用于资源受限设备的紧凑型任务无关BERT》一同发布，作者为Zhiqing Sun、Hongkun Yu、Xiaodan Song、Renjie Liu、Yiming Yang和Denny Zhou。
23. OWL-ViT（由Google AI开发）随论文《使用Vision Transformer实现简单的开放词汇目标检测》一同发布，作者为Matthias Minderer、Alexey Gritsenko、Austin Stone、Maxim Neumann、Dirk Weissenborn、Alexey Dosovitskiy、Aravindh Mahendran、Anurag Arnab、Mostafa Dehghani、Zhuoran Shen、Xiao Wang、Xiaohua Zhai、Thomas Kipf和Neil Houlsby。
24. OWLv2（由Google AI开发）随论文《扩展开放词汇目标检测》一同发布，作者为Matthias Minderer、Alexey Gritsenko和Neil Houlsby。
25. RoBERTa（由Facebook开发），随论文《RoBERTa：一种鲁棒优化的BERT预训练方法》一同发布，作者为Yinhan Liu、Myle Ott、Naman Goyal、Jingfei Du、Mandar Joshi、Danqi Chen、Omer Levy、Mike Lewis、Luke Zettlemoyer和Veselin Stoyanov。
26. RoBERTa-PreLayerNorm（由Facebook开发）随论文《fairseq：一个快速、可扩展的序列建模工具包》一同发布，作者为Myle Ott、Sergey Edunov、Alexei Baevski、Angela Fan、Sam Gross、Nathan Ng、David Grangier和Michael Auli。
27. RoFormer（由ZhuiyiTechnology开发），随论文《RoFormer：带有旋转位置嵌入的增强型Transformer》一同发布，作者为Jianlin Su、Yu Lu、Shengfeng Pan、Bo Wen和Yunfeng Liu。
28. SigLIP（由Google AI开发）随论文《用于语言图像预训练的Sigmoid损失》一同发布，作者为Xiaohua Zhai、Basil Mustafa、Alexander Kolesnikov和Lucas Beyer。
29. Swin2SR（由维尔茨堡大学开发）随论文《Swin2SR：用于压缩图像超分辨率和修复的SwinV2 Transformer》一同发布，作者为Marcos V. Conde、Ui-Jin Choi、Maxime Burchi和Radu Timofte。
30. T5（由Google AI开发）随论文《通过统一的文本到文本Transformer探索迁移学习的极限》一同发布，作者为Colin Raffel、Noam Shazeer、Adam Roberts、Katherine Lee、Sharan Narang、Michael Matena、Yanqi Zhou、Wei Li和Peter J. Liu。
31. T5v1.1（由Google AI开发）在google-research/text-to-text-transfer-transformer仓库中发布，作者同上。
32. TrOCR（由微软开发），随论文《TrOCR：基于Transformer的预训练模型光学字符识别》一同发布，作者为Minghao Li、Tengchao Lv、Lei Cui、Yijuan Lu、Dinei Florencio、Cha Zhang、Zhoujun Li和Furu Wei。
33. Vision Transformer (ViT)（由Google AI开发）随论文《一张图胜过16×16个词：大规模图像识别中的Transformer》一同发布，作者为Alexey Dosovitskiy、Lucas Beyer、Alexander Kolesnikov、Dirk Weissenborn、Xiaohua Zhai、Thomas Unterthiner、Mostafa Dehghani、Matthias Minderer、Georg Heigold、Sylvain Gelly、Jakob Uszkoreit和Neil Houlsby。
34. YOLOS（由华中科技大学开发）随论文《你只看一个序列：通过目标检测重新思考视觉中的Transformer》一同发布，作者为Yuxin Fang、Bencheng Liao、Xinggang Wang、Jiemin Fang、Jiyang Qi、Rui Wu、Jianwei Niu和Wenyu Liu。

TransformersPHP 快速上手指南

TransformersPHP 是一个为 PHP 开发者设计的机器学习库，功能上等同于 Python 的 Hugging Face Transformers 库。它基于 ONNX Runtime 运行，支持文本生成、摘要、翻译、情感分析等多种任务，旨在提供高性能且易于使用的 API。

1. 环境准备

在开始之前，请确保你的开发环境满足以下要求：

• PHP 版本：PHP 7.4 或更高版本。
• FFI 扩展：TransformersPHP 依赖 PHP FFI 扩展与 ONNX Runtime 交互。
  • FFI 扩展通常包含在 PHP 7.4+ 中，但默认可能未启用。
  • 请在 php.ini 文件中检查并修改以下配置：

    extension = ffi
    ffi.enable = true
    

  • 修改后，请重启 Web 服务器或 PHP-FPM 服务。
• Composer：用于管理 PHP 依赖包。
• 平台一致性：ONNX 库具有平台特异性。务必在代码最终运行的目标平台（如生产服务器或 Docker 容器内部）执行安装命令，以确保二进制文件兼容。

2. 安装步骤

推荐使用 Composer 进行安装。在你的项目根目录下运行以下命令：

composer require codewithkyrian/transformers

注意：如果你使用 Docker，请确保在容器内运行上述命令，而不是在宿主机上运行。

3. 基本使用

TransformersPHP 提供了与 Python 库高度相似的 pipeline API，只需几行代码即可实现复杂的 NLP 任务。

示例：情感分析

以下代码演示如何使用预训练模型进行情感分析：

<?php

require 'vendor/autoload.php';

use function Codewithkyrian\Transformers\Pipelines\pipeline;

// 初始化情感分析管道
$pipe = pipeline('sentiment-analysis');

// 执行预测
$out = $pipe('I love transformers!');

// 输出结果: [{'label': 'POSITIVE', 'score': 0.999808732}]
print_r($out);

指定特定模型

你可以通过传递模型 ID 作为第二个参数来使用特定的模型（例如用于翻译或其他任务）：

<?php

require 'vendor/autoload.php';

use function Codewithkyrian\Transformers\Pipelines\pipeline;

// 指定模型 ID 初始化管道
$pipe = pipeline('translation', 'Xenova/distilbert-base-uncased-finetuned-sst-2-english');

// 执行任务
$out = $pipe('Your text here');

预下载模型（可选优化）

默认情况下，模型会在首次运行时从 Hugging Face 自动下载，这可能导致初次请求延迟。建议在生产环境中预先下载模型：

./vendor/bin/transformers download <model_identifier> [<task>]

例如：

./vendor/bin/transformers download Xenova/distilbert-base-uncased-finetuned-sst-2-english

更多高级配置（如缓存目录、代理设置等）请参考官方文档。