From e99d1c4f5895a6fdafcc93975202cbd19caf8e10 Mon Sep 17 00:00:00 2001 From: gehaoxuan <2310314646@qq.com> Date: Fri, 17 Oct 2025 22:31:22 +0800 Subject: [PATCH] add example/README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Co-authored-by: gehaoxuan<2310314646@qq.com> # message auto-generated for no-merge-commit merge: !49 merge readme into master add example/README.md Created-by: gehaoxuan Commit-by: gehaoxuan Merged-by: ascend-robot Description: ## 类型 - [ ] Bug修复 - [ ] 新功能 - [ ] 代码风格更新 - [ ] 代码重构 - [ ] 构建过程或辅助工具的变动 - [x] 文档内容更新 ## 描述 请提供此 Pull Request 的详细说明。 ## 如何测试 描述测试这个变更的步骤，包括哪些文件需要被修改。 ## Checklist: - [ ] 我的代码遵循这个项目的代码风格 - [ ] 我已经自己测试过我的代码 - [ ] 我已经更新了相应的文档 - [ ] 我已经根据需要更新了对应的变更日志 - [ ] 我已经在标题中正确使用了类型标签（例如：`feature:`, `fix:`） ## 其他信息 在这里可以添加任何与这个 Pull Request 相关的其他说明。 See merge request: cann/asnumpy!49 --- examples/README.md | 30 ++++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 examples/README.md diff --git a/examples/README.md b/examples/README.md new file mode 100644 index 0000000..36d60ac --- /dev/null +++ b/examples/README.md @@ -0,0 +1,30 @@ +# AsNumpy项目函数样例说明 +样例调用本项目的函数，和Numpy的同功能函数用numpy.allclose进行结果对比，并输出运行时间，以此来展现AsNumpy的准确性和性能 + +## 已实现样例 +| 文件名 | 功能描述 | +| :--- | :-- | +| [01_add](01_add.py) | 用asnumpy.add和numpy.add分别对输入数组 x1 和 x2 执行逐元素加法运算并对比结果，并计算它们的运行时间 | +| [02_exp2](02_exp2.py) | 用asnumpy.exp2和numpy.exp2分别对输入数组 x 的每个元素计算 2 的幂并对比结果，并计算它们的运行时间 | +| [03_multiply](03_multiply.py) | 用asnumpy.multiply和numpy.multiply分别对输入数组 x1 和 x2 执行逐元素乘法运算并对比结果，并计算它们的运行时间 | +| [04_all](04_all.py) | 用asnumpy.all和numpy.all分别对输入数组 x 执行对输入数组执行逻辑与归约操作，判断所有元素是否均为 True并对比结果，并计算它们的运行时间 | +| [05_divide](05_divide.py) | 用asnumpy.divide和numpy.divide分别对输入数组 x1 和 x2 执行逐元素除法并对比结果，并计算它们的运行时间 | + +## 下一步预期实现样例 +| 函数名 | 预期功能描述 | +| :--- | :-- | +| sinh | 用asnumpy.sinh和numpy.sinh分别对输入数组 x1 和 x2 执行逐元素计算双曲正弦并对比结果，并计算它们的运行时间 | +| real | 用asnumpy.real和numpy.real分别逐元素输出 x 的实数部分并对比结果，并计算它们的运行时间 | +| square | 用asnumpy.square和numpy.square分别逐元素计算 x 的平方并对比结果，并计算它们的运行时间 | +| sinc | 用asnumpy.sinc和numpy.sinc分别对输入数组 x 逐元素计算 sinc 函数并对比结果，并计算它们的运行时间 | +| gcd | 用asnumpy.gcd和numpy.gcd分别对输入数组 x1 和 x2 逐元素计算最大公约数并对比结果，并计算它们的运行时间 | +| around | 用asnumpy.around和numpy.around分别逐元素将 x 四舍五入到指定小数位数并对比结果，并计算它们的运行时间 | +| cumsum | 用asnumpy.cumsum和numpy.cumsum分别逐元素计算 x 沿给定轴的元素的累积和并对比结果，并计算它们的运行时间 | +| arcsin | 用asnumpy.arcsin和numpy.arcsin分别对 x 进行逐元素的反正弦计算并对比结果，并计算它们的运行时间 | +| reciprocal | 用asnumpy.reciprocal和numpy.reciprocal分别对 x 计算每个元素的倒数并对比结果，并计算它们的运行时间 | +| binomial | 用asnumpy.binomial从二项分布中抽取足够多随机样本并用卡方分布测试是否符合分布，并计算运行时间 | + +## 更新说明 +| 时间 | 更新事项 | +| :--- | :-- | +| 2025/10/14 | 新增AsNumpy项目函数样例说明 | \ No newline at end of file