jeertmans/DiffeRT

[DOC] Document when `compute_paths` can be JIT-compiled

Open

#337 opened on Oct 23, 2025

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Python (10 forks)auto 404
documentationgood first issueneeds-triage

Repository metrics

Stars
 (64 stars)
PR merge metrics
 (PR metrics pending)

Description

Terms

Describe the issue

As discussed in https://github.com/jeertmans/DiffeRT/pull/326#issuecomment-3437022985, the compute_paths method exhibits some challenges when it comes to JIT-compilation, as some cases, e.g., when setting disconnect_inactive_triangles to True, will create output arrays whose shapes depend on the values of the input arrays. This is not compatible with JAX's tracing system, this should probably be documented somewhere.

Affected page(s)

Issue type

Documentation enhancement

Recommended fix or suggestions

No response

Contributor guide

Research direction
Identify which parameters of `compute paths` cause dynamic output shapes and document them in the affected pages.
Tech stack
python
Domain
backend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65