google-deepmind / optax

Optax is a gradient processing and optimization library for JAX.
https://optax.readthedocs.io
Apache License 2.0
1.56k stars 165 forks source link

README: deadlink to "Optax 101" notebook #937

Closed jeertmans closed 2 months ago

jeertmans commented 2 months ago

Hello, it seems like the link here:

https://github.com/google-deepmind/optax/blob/60bb59f97b75eb35f757b0d7e41a8d7fce2f407d/README.md?plain=1#L80

is broken.

I guess this should be updated to point to https://github.com/google-deepmind/optax/blob/main/docs/getting_started.ipynb?

Tip: you can avoid broken links with tools like markdown-link-check.

fabianp commented 2 months ago

thanks @jeertmans ! are you willing to provide a pull request to fix this?

and of course, +1 for adding markdown-link-check to the integration tests (but feel free to do so in a separate PR)

jeertmans commented 2 months ago

Sure @fabianp, there you go :-)