Add function for checking modules for type piracy, ambiguities, etc in defined rules
还没有人认领这个 Issue。
评估
- 难度
- 5/5
- 预计耗时
- 一周以上
- 新手友好度
- 25/100
- Issue 类型
- 功能
- 描述清晰度
- 需要澄清
- 活跃度
- 停滞
- 技术栈
- julia
- 领域
- testing-qa
调研方向
首先查看提议的入口点 ChainRulesTestUtils.check_all_rules(MyModule) 以及此 issue 中的 Julia 规则示例。确定该实用工具应如何识别错误的目标、Type Piracy 和歧义,然后定义检查项和完成标准,以便报告模块中的这些问题。
由索引模型根据 Issue 内容生成。
描述
Given an example like
struct Foo end
(f::Foo)(x) = x^2
function ChainRulesCore.rrule(::typeof(Foo), x)
Foo_pullback(Δy) = (NO_FIELDS, x' * Δy + Δy * x')
return x^2, Foo_pullback
end
Because typeof(Foo) is DataType, this common mistake is highly piratical and will subtilely and completely break AD packages like Zygote for anyone who has this rule in their namespace (it should be ::Foo in the signature, not typeof(Foo)).
On Slack, @oxinabox suggested:
We should think about tools to make this more obvious.
Maybe something that lists the true things that have been targetted by all rules defined in a package?
I suggested:
Something like
ChainRulesTestUtils.check_all_rules(MyModule)which as much as possible checks for things like type piracy, ambiguities, etc?
- 主要语言
- Julia
- 星标
- 50
- 派生
- 18
- PR 合并指标
- 30 天内没有已合并 PR
环境准备
这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。
从这里开始
- 先读完整个 Issue,再读项目的贡献指南。
- 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
- Fork 仓库,在一个分支上完成修改。
- 提交 Pull Request,并在描述里引用这个 Issue 编号。
JuliaDiff/ChainRulesTestUtils.jl 的其他 Issue
-
难度 2/5 1-3 小时 新手友好度 65/100
JuliaDiff/ChainRulesTestUtils.jl#148 · 1 个 reaction ·
-
documentation good first issue
难度 2/5 1-3 小时 新手友好度 62/100
-
难度 3/5 1-2 天 新手友好度 45/100
-
难度 2/5 1-3 小时 新手友好度 45/100
-
mutation
难度 3/5 1-2 天 新手友好度 45/100
查看 JuliaDiff/ChainRulesTestUtils.jl 的全部 Issue
相似的 Issue
-
难度 2/5 1-3 小时 新手友好度 72/100
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
JuliaGPU/KernelAbstractions.jl#897 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 72/100
oscar-system/GAP.jl#1455 ·
维护者通常 1 天内回复
-
难度 2/5 1-3 小时 新手友好度 65/100
JuliaAI/MLJTransforms.jl#85 ·
-
难度 2/5 1-3 小时 新手友好度 70/100
SciML/OrdinaryDiffEq.jl#4875 ·
维护者通常 4 天内回复