haystack适配昇腾开源开发任务
1. 背景介绍
开源for Huawei(参考:https://developer.huaweicloud.cn/programs/opensource/contributing/)通过和公司、高校、社区的开发者合作,完成鲲鹏、昇腾、欧拉、鸿蒙、高斯、云服务等与开源软件的适配开发,帮助繁荣Huawei的基础生态,同时让开源软件能够更加简单、高效的运行于华为云上。
开始之前,开发者可以下载 开源for Huawei Wiki(参考:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview)了解详细的开发步骤,技术准备,以及开发过程需要的各种资源。
2.需求分析
2.1 开源软件情况
Haystack 是一个端到端的开源框架,用于构建基于大型语言模型 (LLMs) 的问答系统和语义搜索应用。它由 deepset 公司开发和维护,源代码托管在 GitHub 上 (https://github.com/deepset-ai/haystack)。
截至 2024 年 8 月 29 日,Haystack 项目在 GitHub 上拥有超过 15.6k 的star和 1.8k 的 fork。项目有超过 200 名贡献者。最近一次代码提交时间为 2024 年 8 月 28 日。
以下是haystack项目的star历史图:
2.2 任务目的和范围
本任务的主要目的是将 Haystack 框架适配到华为的特定环境中,以显著提高企业的信息检索和问答系统的效率。这一适配将帮助企业更好地利用其内部知识库,提升员工生产力和客户服务质量。
适配任务清单
生态 |
生态细类 |
是否涉及 |
验证逻辑说明 |
是否需要适配 |
适配场景说明 |
昇腾生态 |
指令 |
是 |
使用昇腾处理器运行应用。 |
否 |
使用昇腾指令实现适配逻辑。 |
CANN |
是 |
应用功能依赖于CANN运行。 |
否 |
使用CANN实现适配逻辑。 |
|
MindSpore |
否 |
应用功能依赖于MindSpore运行。 |
否 |
使用MindSpore实现适配逻辑。 |
|
鲲鹏生态 |
指令 |
是 |
使用鲲鹏处理器运行应用。 |
否 |
使用鲲鹏指令实现适配逻辑。 |
Euler |
是 |
使用Euler系统运行应用。 |
否 |
使用Euler系统调用实现适配逻辑。 |
|
数据库生态 |
数据库驱动 |
否 |
使用GaussDB功能。 |
否 |
使用GaussDB数据库驱动实现适配逻辑。 |
|
GaussDB(DWS) |
否 |
使用GaussDB(DWS)功能。 |
否 |
基于GaussDB ORM框架实现适配逻辑。 |
存储生态 |
使用OBS对象存储 |
否 |
使用OBS功能。 |
否 |
基于OBS API访问实现适配逻辑。 |
鸿蒙生态 |
HarmonyOS |
否 |
使用HarmonyOS系统运行应用。 |
否 |
使用HarmonyOS系统调用实现适配逻辑。 |
3.工作量评估和任务分解
3.1工作量评估
任务 |
估计人天 |
需求分析与调研 |
10 |
环境适配 |
15 |
接口开发 |
15 |
性能测试与验证 |
15 |
Demo 设计、开发与部署 |
13 |
撰写和发布适配心得 |
3 |
代码推送上游社区和更新社区资料 |
2 |
总计估计工作量 |
73 人天 |
3.2 完成haystack演示DEMO设计
DEMO流程图参考如下:
基于DEMO设计完成开发和部署:
根据DEMO设计,完成演示功能开发和部署,要求使用CCE容器(Euler镜像)进行部署。
3.3 在华为云开发者论坛输出博客
访问华为云开发者论坛(参考:https://bbs.huaweicloud.cn/blogs)发表博客,介绍完成这些任务的过程和心得。
内容包括不限于如下内容:
l 开源for Huawei的背景
l 开源软件的功能介绍
l 开发适配过程及碰到和解决的问题
l DEMO设计、开发、部署过程
博客打上如下标签:
l 开源(必选)
l 开发者(必选)
l 鲲鹏(可选)
l 昇腾(可选)
l Euler(可选)
4. 验收材料
验收细则 |
评分说明 |
是否为验收必选项 |
结果(通过/不通过) |
开发者举证 |
功能开发:完成与华为三大根技术生态(鲲鹏云、昇腾云、鸿蒙)适配的功能开发 |
基于Ascend NPU完成验证。 |
是 |
|
|
代码质量:适配华为三大根技术生态的代码质量经过工具检测达标 |
推送给开源社区的代码符合开源社区关于代码风格、功能、自动化测试等要求。 |
否 |
|
|
提供相关文档,比如部署文档、使用文档、配置文档等 |
根据社区要求,完善相关的开发指南和部署指导。 |
否 |
|
|
合入到开源项目主仓:代码推送上游社区 |
代码合并到当前主干分支。举证提供代码仓库链接。 |
否 |
|
|
Deomo设计&开发:完成功能演示Demo的开发 |
举证提供DEMO前端地址。 |
是 |
|
|
Demo部署&验证:完成功能演示DEMO基于华为昇腾、鲲鹏和Euler系统环境的部署和功能验证 |
提供DEMO部署验证结果的关键截图进行举证。提供DEMO运行环境和资源的规格清单。 |
是 |
|
|
发布博客:发布博客介绍适配心得。 |
提供博客的地址。 |
是 |
|
|
制作单机版无高危开源镜像。 |
上架云商店。 |
否 |
|
|
单机版镜像上架时支持模板部署。 |
|
否 |
|
|
制作集群版无高危开源镜像 |
上架云商店。 |
否 |
|
|
集群版镜像上架时支持模板部署 |
|
否 |
|
参考资料
- 开源for Huawei介绍、环境搭建、示例项目、开发和部署指南:https://gitcode.com/HuaweiCloudDeveloper/OpenSourceForHuaweiWiki/overview
- 华为昇腾社区首页:https://www.hiascend.com/developer
- 华为鲲鹏社区首页:https://www.hikunpeng.com/developer
- 华为欧拉社区首页:https://www.openeuler.org/
- 点赞
- 收藏
- 关注作者
评论(0)