nan
e7aeeb21d4
- Implement sync_models.py for preparing and uploading ONNX artifacts. - Create build_node.py for building and validating Blender scripts. - Add docs.py for building and previewing documentation with Mike or MkDocs. - Introduce model_exports.py for exporting PyTorch models to ONNX format. - Develop pack.py for packaging the project with dependencies for different platforms. - Add test_sync_models.py to validate sync_models functionality. - Add test_tool_commands.py to ensure repository tools have correct command scripts. - Initialize tools package with __init__.py.
93 lines
3.3 KiB
Markdown
93 lines
3.3 KiB
Markdown
# 开发与发布
|
||
|
||
AnyImage 的仓库环境用于测试 Blender 侧代码、Server 纯 Python 模块、Manifest 和打包逻辑。AI Runtime 使用独立的 Python 3.12 Environment。
|
||
|
||
## 对应文件
|
||
|
||
```text
|
||
.
|
||
├── pyproject.toml
|
||
├── uv.lock
|
||
├── .python-version
|
||
├── tools/
|
||
│ ├── pack.py
|
||
│ ├── model_exports.py
|
||
│ ├── sync_models.py
|
||
│ ├── build_node.py
|
||
│ └── node_assets/
|
||
├── src/anyimage/blender_manifest.toml
|
||
├── tests/
|
||
└── .github/workflows/
|
||
├── test.yml
|
||
├── build.yml
|
||
└── docs.yml
|
||
```
|
||
|
||
## 开发环境
|
||
|
||
仓库固定使用 CPython 3.11，因为开发依赖 `bpy==4.5.3` 对应这一解释器版本。项目根目录执行：
|
||
|
||
```bash
|
||
uv sync
|
||
uv run pytest
|
||
```
|
||
|
||
快速检查注册、Manifest 和打包时使用：
|
||
|
||
```bash
|
||
uv run pytest tests/test_addon.py tests/test_manifest.py tests/test_pack.py -v
|
||
```
|
||
|
||
测试按边界组织：`test_addon.py` 以 Blender Stub 验证注册和 Operator 流程；`test_mesh.py`、`test_image.py` 等验证可脱离 Blender 的算法；`test_server.py`、`test_models.py` 和各 ONNX 测试覆盖计算端；`test_pack.py` 与 `test_manifest.py` 固定发布包结构。
|
||
|
||
## 扩展打包
|
||
|
||
```bash
|
||
uv run pack
|
||
```
|
||
|
||
`tools/pack.py` 为 `windows-x64`、`macos-arm64` 和 `linux-x64` 分别解析依赖 wheel，生成平台专属 Manifest，再把 `src/anyimage/` 与 wheel 写入 `dist/`：
|
||
|
||
```text
|
||
dist/
|
||
├── AnyImage.v<version>.windows-x64.zip
|
||
├── AnyImage.v<version>.macos-arm64.zip
|
||
└── AnyImage.v<version>.linux-x64.zip
|
||
```
|
||
|
||
本地 `src/anyimage/wheels/` 是 wheel 解析的优先来源，用于携带尚未发布的 BlendJob 构建。依赖、wheel 或 Manifest 变化后，需要同时检查 `pyproject.toml`、`uv.lock`、`blender_manifest.toml` 和打包测试；本地 wheel 内容变化后运行 `uv lock --refresh`。
|
||
|
||
## 模型发布
|
||
|
||
```bash
|
||
uv run sync_models
|
||
```
|
||
|
||
`tools/sync_models.py` 从公开原址下载已有 ONNX；Real-ESRGAN General WDN x4v3 与 SAFMN Real x4 则从官方 PyTorch 权重调用 `tools/model_exports.py` 构建。所有制品通过固定大小、SHA-256、ONNX Checker 和 PyTorch/ONNX Runtime 数值对比后，逐文件上传到 R2。添加 `--prepare-only` 可仅准备和验证制品。
|
||
|
||
## 文档
|
||
|
||
```bash
|
||
uv run mkdocs serve
|
||
uv run mkdocs build --strict
|
||
```
|
||
|
||
站点导航由 `mkdocs.yml` 显式维护，因此移动页面时必须同时更新导航和相对链接。本地版本化发布使用 Mike；CI 构建严格模式站点并部署到 Cloudflare Worker。
|
||
|
||
## CI
|
||
|
||
```mermaid
|
||
flowchart TD
|
||
Main["push main / Pull Request"] --> Test["uv run --frozen pytest"]
|
||
Tag["push v* tag"] --> Release["测试 → tools/pack.py → Release ZIP"]
|
||
Docs["main 上文档变更"] --> Site["mkdocs --strict → Cloudflare"]
|
||
```
|
||
|
||
`test.yml` 在 main push、Pull Request 与手动触发时运行完整测试。`build.yml` 只响应 `v*` tag，测试通过后构建并上传三个平台包。`docs.yml` 只在文档相关路径变化或手动触发时部署站点。
|
||
|
||
## 许可证
|
||
|
||
AnyImage Extension 代码采用 GPL-3.0-or-later，完整文本见仓库 `LICENSE`。模型权重保持各自上游许可证；模型目录声明下载来源、文件校验和许可信息。
|
||
|
||
Geometry Nodes 资产必须由 Blender 构建和验证，见[节点资产](node-assets.md)。
|