JuliaDiff / JuliaDiff/DifferentiationInterface.jl

Formalize backend interface

Open
#828 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

core documentation test
Dominant language
Julia
Stars
313
Forks
35
No merged PRs in 30d

Description

DI defines several backend objects and wrappers (in addition to those from ADTypes):

  • SecondOrder
  • MixedMode
  • AutoForwardFromPrimitive, AutoReverseFromPrimitive
  • AutoZeroForward, AutoZeroReverse
  • AutoSimpleFiniteDiff

For each of those, several functions need to be defined:

  • ADTypes.mode
  • DI.check_available
  • DI.inplace_support
  • DI.pick_batchsize (for integers and for arrays), and DI.threshold_batchsize for testing
  • DI.inner_preparation_behavior, and DI.overloaded_input if necessary

This should all be documented and properly tested.

Contributor guide

Open the contributing guide

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 by reviewing the listed DI backend objects and existing ADTypes behavior, then trace the entry points for ADTypes.mode and the DI functions named in the issue. Done means the interface is documented and each listed object has appropriate tests for availability, in-place support, batch sizing, preparation behavior, and overloaded inputs.

Written by the indexing model from the issue text.

Assessment

Tech stack
julia
Domain
backend-api-design
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.