RFC: Example Rule "Gallery" to showcase CRC best practices?
メンテナーはふだん 1 日以内に返信
まだ誰も着手していません。
評価
- 難易度
- 5/5
- 見積もり時間
- 1週間以上
- 初心者へのやさしさ
- 25/100
- issue の種類
- ドキュメント
- 明瞭さ
- 説明が足りない
- 活発さ
- 停滞
- 技術スタック
- julia
調査の方向性
この issue では、ファイル、テスト、具体的なエントリーポイントが指定されていません。まず ChainRules の既存のドキュメント例と、リンクされているギャラリーのインスピレーションを確認し、その後、ギャラリーの範囲とコントリビューションモデルを明確にしてください。カスタム rrule と frule の例を紹介するための合意済みの構成と、外部パッケージの例をどのように選定するかについての決定があれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Following up on some Slack (#autodiff) discussion with @mzgubic, I want to float the idea of adding a CRC rule "gallery" to the ChainRules docs, inspired by analogous things in the plotting world (eg BeautifulMakie).
I think that best practices for rule authors have become a bit too complicated to sufficiently demonstrate with just one or two small examples per section in the docs, particularly with interplay between
- custom structs & their constructors
- higher order functions
- CRC Thunks, Tangent types & AD callbacks
There are many clever rule authors in the wild who post helpful examples on Github/Discourse/Slack/Zulip but this information is very disaggregated and un-searchable. If there were some way for users to submit nice but less ultra-minimal examples and/or to aggregate relevant examples of custom rrule and frule definitions in published packages (as @ToucheSir suggested) I think linking to such a "gallery" from the CR docs would speed up the learning process for rule authors.
I would be glad to help realize such a thing if it seemed feasible and people wanted it.
Less organized thoughts from Slack:
A few custom rule examples I can find in forums but which I wouldn't know how to write based on CR docs:
- Constructors of widely used
AbstractArraysubtypes likeStaticArrays,StructArrays, etc. LinearAlgebramethods of “implicit operator” types representing giant Matrices, eg from LinearMaps.jl- Iterative solver and partial decomposition methods involving the former, eg methods from IterativeSolvers.jl, KrylovKit.jl, Arpack.jl, etc, (“adjoint method” VJP rules)
- Higher order function methods defined outside Base, often versions of
maporreducewith parallelism. - Gradient accumulation into an
InplaceableThunkof a custom struct
- 主要言語
- Julia
- スター
- 267
- フォーク
- 66
- 平均マージ
- 1日 1時間
- マージ済み PR（30日）
- 9
環境構築
このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
JuliaDiff/ChainRulesCore.jl のほかの issue
-
難易度 4/5 3〜5日 初心者へのやさしさ 28/100
JuliaDiff/ChainRulesCore.jl#712 ·
メンテナーはふだん 1 日以内に返信
-
variable scope of `@thunk`対応中かも @chengchingwen が 621 日前に担当しました。 オープン
難易度 4/5 3〜5日 初心者へのやさしさ 32/100
JuliaDiff/ChainRulesCore.jl#684 ·
メンテナーはふだん 1 日以内に返信
-
good first issue Structural Tangent
難易度 2/5 1〜3時間 初心者へのやさしさ 55/100
JuliaDiff/ChainRulesCore.jl#669 ·
メンテナーはふだん 1 日以内に返信
-
難易度 5/5 1週間以上 初心者へのやさしさ 20/100
JuliaDiff/ChainRulesCore.jl#668 · コメント 6 件 ·
メンテナーはふだん 1 日以内に返信
-
breaking
難易度 3/5 1〜2日 初心者へのやさしさ 35/100
JuliaDiff/ChainRulesCore.jl#665 ·
メンテナーはふだん 1 日以内に返信
JuliaDiff/ChainRulesCore.jl の issue をすべて見る
似ている issue
-
release preparation spack
難易度 2/5 1〜3時間 初心者へのやさしさ 67/100
メンテナーはふだん 1 日以内に返信
-
30-minutes algorithm any-language codewars dart easy elixir hackerrank hacktoberfest haskell help wanted interview-prep julia leetcode lua open-source r scala students zig
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
Huerte/algo-solutions-python#163 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 76/100
QuantumSavory/QuantumClifford.jl#853 ·
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 66/100
JuliaPackaging/Yggdrasil#15441 · コメント 1 件 ·
メンテナーはふだん 1 日以内に返信
-
bug
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
JuliaSmoothOptimizers/Penelopt.jl#260 ·
メンテナーはふだん 1 日以内に返信