JuliaDiff / JuliaDiff/ChainRulesCore.jl

In Julia 1.5 use custom hints to replace debug mode?

Open
#144 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
Julia
Stars
267
Forks
66
PR merge metrics
No merged PRs in 30d

Description

Right now we use debug mode (#136) with the special error type for addition of composites to primals failing, to give instructions on how to overload things to fix this.
But in julia 1.5 there is special functionality for adding hints for how to resolve errors build in by some magic:
https://github.com/JuliaLang/julia/pull/35094

https://github.com/JuliaDiff/ChainRulesCore.jl/blob/1be9bc4b5985896b0549cd278681bc41d06869ec/src/differentials/composite.jl#L233-L254

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with src/differentials/composite.jl, especially lines 233-254, and compare the current debug-mode handling described in issue #136 with Julia 1.5's custom error-hint functionality from the linked Julia pull request. Done means replacing the special error-type guidance with the Julia 1.5 hint mechanism while preserving instructions for overloading additions of composites to primals.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
machine-learning
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.