patrick-kidger / equinox

Elegant easy-to-use neural networks + scientific computing in JAX. https://docs.kidger.site/equinox/
Apache License 2.0
2.13k stars 143 forks source link

chore(docs): notify about `tree_at` bypassing checks #874

Closed jeertmans closed 1 month ago

jeertmans commented 1 month ago

Hi @patrick-kidger!

Here is a first proposal. I am not entirely convinced by my wording, but let me know what you think of it.

Closes #872

patrick-kidger commented 1 month ago

I think this looks pretty good! I think the only thing I'd tweak is to express is (a) that there are good reasons for this and (b) what those good reasons are. (Otherwise it just sounds like we decided not to implement this for some reason! :D )

jeertmans commented 1 month ago

I think this looks pretty good! I think the only thing I'd tweak is to express is (a) that there are good reasons for this and (b) what those good reasons are. (Otherwise it just sounds like we decided not to implement this for some reason! :D )

Sure, I didn’t want to write those reasons myself as I didn’t want to be incorrect, and I also wanted to be concise and didn’t know the proper wording to this end :)

patrick-kidger commented 1 month ago

Fair enough! I've modified this in #877 :)

jeertmans commented 1 month ago

Nice, I guess I can close this now, I am leaving a few comments on the other PR :-)