Web 神经网络 API

本仓库托管着正在 Web 机器学习工作组 中开发的 Web 神经网络 API。

如需加入该工作组，请参阅这些 说明。

开发

本节描述了如何在本地计算机上构建此规范，以供开发和测试使用。您可能希望在提交 Pull Request 之前执行此操作，以便及早发现潜在的构建问题。

第一步是克隆仓库：

prompt> git clone https://github.com/webmachinelearning/webnn

接下来，安装 Makefile 的依赖项：

prompt> cd tools
prompt> npm install
prompt> cd ..

现在您可以选择以下两种方式之一：

• 在本地安装 Bikeshed（可离线使用，构建速度更快），然后运行：

prompt> make

• 或者使用 Bikeshed HTTP API（需要互联网连接，构建速度较慢）：

prompt> make online=1

无论采用哪种方式，Makefile 都会运行 tools 来检查源代码格式并捕获常见错误，然后使用 Bikeshed 将 index.bs 源文件转换为 index.html 输出文件。

如果构建成功，您可以在浏览器中打开 index.html 文件，尽情欣赏其内容！如果您对结果满意，恭喜您！可以继续提交 Pull Request。

Pull Requests

首先，请阅读 贡献指南。

本规范使用 Bikeshed 规范生成工具编写。请参考 Bikeshed 文档 了解 Bikeshed 语法，以及本规范特有的 编码规范。

要提出对规范的更改，您只需更新用 Bikeshed 语法编写的 index.bs 源文件即可。

在提交 PR 之前，建议您在本地测试更改（参见 开发）。如果本地构建没有问题，您可以继续提交 PR。如果您想提交一个仍包含错误或不完整的 WIP PR，请将其 转换为草稿。作为惯例，对于 非编辑性更改，请将 PR 链接到现有议题。

提交 PR 后，它会首先通过 GitHub Actions CI/CD 自动检查常见问题，随后由工作组成员进行评审。经过充分的评审和批准后，PR 将被合并，规范的新版本将在 https://www.w3.org/TR/webnn/ 上部署（历史记录）。

WebNN 快速上手指南

本指南帮助开发者在本地构建和测试 Web Neural Network API (WebNN) 规范文档。

环境准备

• 操作系统：支持 Git 和 Node.js 的主流系统 (Windows, macOS, Linux)。
• 前置依赖：
  • Git
  • Node.js (用于安装构建工具依赖)
  • 可选但推荐：Python 及 pip (用于本地安装 Bikeshed 工具，可实现离线快速构建)。
    • 国内加速建议：使用清华或阿里镜像源安装 Python 包。
    • pip install bikeshed --index-url https://pypi.tuna.tsinghua.edu.cn/simple

安装步骤

1. 克隆仓库

   git clone https://github.com/webmachinelearning/webnn
   

2. 安装构建依赖 进入项目目录并安装必要的 npm 包：

   cd webnn
   cd tools
   npm install
   cd ..
   

3. 配置构建工具 (二选一)

   • 方案 A：本地安装 Bikeshed (推荐，速度快，支持离线) 确保已按“环境准备”中所述安装好 Bikeshed，然后运行：

     make
     

   • 方案 B：使用在线 API (无需本地安装，需联网，速度较慢) 如果未安装本地 Bikeshed，可直接调用远程服务：

     make online=1
     

基本使用

构建成功后，当前目录下将生成 index.html 文件。

1. 预览规范文档 直接在浏览器中打开生成的文件即可查看最新版的 WebNN 规范：

   # macOS
   open index.html
   
   # Windows (PowerShell)
   Start-Process index.html
   
   # Linux
   xdg-open index.html
   

2. 修改与贡献

   • 规范源码位于 index.bs 文件，采用 Bikeshed 语法编写。
   • 修改该文件后，重新运行上述 make 命令即可更新 HTML 输出。
   • 确认构建无误且内容符合预期后，即可提交 Pull Request。