Skip to content

Commit

Permalink
Update notes.md
Browse files Browse the repository at this point in the history
  • Loading branch information
eguiraud committed Nov 3, 2023
1 parent 235b836 commit 8d0758b
Showing 1 changed file with 2 additions and 7 deletions.
9 changes: 2 additions & 7 deletions notes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,8 @@
# Notes about correctionlib-gradients

Notes about specific quirks, warts, design decisions that might need revisiting, etc.
See ARCHITECTURE.md for a broader, higher-level description of the package.
See [ARCHITECTURE.md](https://github.com/eguiraud/correctionlib-gradients/blob/main/ARCHITECTURE.md)
for a broader, higher-level description of the package and its design.

## Floating point precision

Expand All @@ -11,9 +12,3 @@ It can be configured with `from jax import config; config.update("jax_enable_x64
but it also seems wrong to set it at global scope behind the users' back.
With things as they are now, `test_scalar` would fail with `jit=True` because of loss of precision
if we didn't configure JAX as above at the start of the test.

## `jax.jit` and correctionlib compute graph

We offer a `jit` flag to control whether the correction evaluation (and the one of the gradient)
should be pass through `jax.jit`. Corrections that take strings as input cannot be jitted though
(integers are ok). We can probably at least give users a heads up in this case.

0 comments on commit 8d0758b

Please sign in to comment.