Hacktoberfest 2026: die Issues, die Maintainer für den Oktober markiert haben – offen und einsteigerfreundlich. Hacktoberfest-Issues durchsuchen

checktag's permissive fallback silently disables tag checking (e.g. for derivative(f!, y, x, cfg))

Offen
  • Stimmt etwas nicht?
#833 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
50/100
Issue-Typ
Bug
Klarheit
Größtenteils klar
Aktivitätsstatus
Ruhig
Bereich
tooling

Rechercherichtung

Beginne mit den checktag-Methoden und den Aufrufstellen von derivative/derivative!, und vergleiche anschließend ihr Verhalten mit dem InvalidTagException-Pfad von gradient. Als abgeschlossen gilt, wenn eine DerivativeConfig für die falsche Funktion bei skalaren derivative-Aufrufen abgelehnt wird und das Verhalten bei dokumentiertem nothing sowie bei benutzerdefinierten Tags berücksichtigt ist.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

A DerivativeConfig built for one function is silently accepted by another, so derivative(f!, y, x, cfg) gets no perturbation confusion protection at all:

julia> a!(y, x) = (y .= sin(x)); b!(y, x) = (y .= cos(x));

julia> y = Vector{Float64}(undef, 2);

julia> cfg = ForwardDiff.DerivativeConfig(a!, y, 0.0);

julia> ForwardDiff.derivative(b!, y, 0.0, cfg)   # cfg belongs to a!, no complaint
2-element Vector{Float64}:
 -0.0
 -0.0

gradient does raise InvalidTagException in the analogous situation. This reproduces with a real y on master, so it is unrelated to complex support.

The immediate cause is that every non-fallback checktag method requires x::AbstractArray:

checktag(::Type{Tag{FT,VT}}, f::F, x::AbstractArray{V}) where {FT,VT,F,V} = throw(InvalidTagException{...}())
checktag(::Type{Tag{F,V}}, f::F, x::AbstractArray{V}) where {F,V} = true

while derivative/derivative! call checktag(T, f!, x) with a scalar x. Dispatch lands on the catch-all checktag(z, f, x) = true, so the check argument of derivative(f!, y, x, cfg, Val{true}()) has no effect.

Adding scalar counterparts of those two methods fixes this particular case, but the more interesting question is whether the permissive checktag(z, f, x) = true default should stay. As it stands, any signature that does not match a specific method silently opts out of checking, which is how this gap went unnoticed -- the failure mode is "no error", not "no method". Defaulting to rejection and explicitly accepting only validated tags would make such gaps loud instead of silent.

Two things to note for anyone attempting that:

  • The return value is currently discarded -- every call site is CHK && checktag(...), and checktag works purely by throwing. So flipping the default to false on its own changes nothing; the call sites would have to throw on a false result.
  • Nothing needs to be accepted explicitly, since a nothing tag is documented as usable with any target function. Custom tag types currently pass via the same fallback ("custom tag: you're on your own"), so rejecting by default would be breaking for them unless they opt in by defining checktag for their tag type -- arguably the point, but worth a deprecation path.
Vorherrschende Sprache
Julia
Sterne
1k
Forks
162
Keine gemergten PRs in 30 T.

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus JuliaDiff/ForwardDiff.jl

Alle Issues in JuliaDiff/ForwardDiff.jl

Ähnliche Issues

Weitere Issues zu Julia

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.