JuliaDiff / JuliaDiff/ChainRulesCore.jl

Don't allow Tangent{T} where T is an Array or a primative type?

Open
#496 8 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Similar in spirit to #495 .
Tangent is for composite objects.
So maybe we shouldn't let people try and put objects that are not make up of fields inside it.

Potentially we could detect this with feildcount or isprimativetype + isa Array

julia> fieldcount(typeof([1]))
0

julia> fieldcount(typeof(1))
0

julia> isprimitivetype(typeof([1]))
false

julia> isprimitivetype(typeof(1))
true

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 by reading issue #495 and inspecting the current Tangent definition and its existing tests. Determine which non-composite types should be rejected, using the fieldcount, isprimitivetype, and isa Array cases shown here; done means the intended behavior is decided and covered by tests.

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
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.