package

PACKAGE

设计理念

交付包面向零基础小白用户。假设用户只会：

1. 打开终端
2. 复制粘贴命令
3. 按回车

因此 README 必须极简、脚本必须一键跑通、所有命令必须完整可复制。

执行

pkg = magnetar.stages.package.assemble(task_dir, metrics, pulsar_image, model_name, labels)

交付包结构

package/
├── README.md           # 面向小白：两步跑起来（setup.sh → run.sh）
├── setup.sh            # 一键环境安装
├── run.sh              # 一键推理运行
├── models/
│   ├── model.axmodel
│   └── model_meta.json
├── python/             # Python SDK（基于 pyaxengine）
│   ├── demo.py         # 最简单的推理示例（复制即用）
│   └── requirements.txt
├── cpp/                # C++ SDK（CMake + 直接链接 AX runtime）
├── model_convert/      # export_onnx.py + pulsar2_config.json + compile_pulsar2.sh + README
│   └── README.md       # 覆盖环境准备、导出、编译、产物检查，命令可直接复制执行
└── reports/            # export/compile/simulate/runonboard 报告

LLM 分支（model_route=llm）

交付内容适配 axllm：

• models/ 放 axllm 模型目录（config.json + tokenizer + 逐层/post *.axmodel
  • embedding bin + model_meta.json），不再要求单个 model.axmodel；
• model_convert/ 放可复现 llm_build.sh（完整 pulsar2 llm_build2 命令 + embed_process.sh + axllm config 生成说明）+ README 覆盖 权重获取 → llm_build2 → embedding/tokenizer 处理 → 板端 axllm serve；
• setup.sh：安装 axllm（curl -fsSL https://gh-proxy.com/https://raw.githubusercontent.com/AXERA-TECH/ax-llm/axllm/install.sh | bash， GH_PROXY 可覆盖） 或检查已装；run.sh：axllm serve models/ --port 8000 & 后运行 python/demo.py（OpenAI 兼容客户端）并打印回复；
• python/requirements.txt 依赖仅 requests；reports/performance_report.md 记录 TTFT / token 速率 / 逐层 cosine（替代张量对分指标）。

一键脚本默认走国内镜像：setup.sh 中 pip 安装使用 PIP_INDEX_URL（默认 https://mirrors.aliyun.com/pypi/simple/）。

README 编写规范

• 开头一句话说清这是什么模型（精度 + 速度 + 大小）
• 快速开始不超过 2 步：bash setup.sh → bash run.sh
• 不要出现占位符（如 ...、<path>、<fill me>）
• 不要出现术语堆砌，必要时用 FAQ 解释
• 所有代码块必须可直接复制粘贴执行

一键脚本规范

setup.sh

• 安装 Python 依赖（pip install -r requirements.txt）
• 检查必要组件（pyaxengine 等）
• 打印明确成功/失败提示

run.sh

• 调用 python/demo.py 或等价入口
• 无需额外参数（若需图片则内置默认或从 models/ 取）
• 输出清晰可读