google-deepmind / optax

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

chore(ci): add markdown-link-check action #939

Closed jeertmans closed 5 months ago

jeertmans commented 5 months ago

Add a check to prevent dead links in the future (e.g., #937).

Output of markdown-link-check CONTRIBUTING.md README.md > output.txt 2>&1:


FILE: CONTRIBUTING.md
  [✓] https://cla.developers.google.com/
  [✓] https://help.github.com/articles/about-pull-requests/
  [✓] https://opensource.google.com/conduct/

  3 links checked.

FILE: README.md
  [✓] http://optax.readthedocs.io
  [✓] https://optax.readthedocs.io/
  [✓] https://optax.readthedocs.io/en/latest/api/optimizers.html
  [✓] https://optax.readthedocs.io/en/latest/api/losses.html
  [✖] https://github.com/google-deepmind/optax/blob/main/docs/optax-101.ipynb
  [✓] https://arxiv.org/pdf/2306.07179
  [✓] https://proceedings.mlr.press/v139/schmidt21a
  [✓] https://arxiv.org/abs/2206.13424
  [✓] https://github.com/google-research/tuning_playbook
  [✓] https://github.com/google-deepmind/optax/actions/workflows/tests.yml/badge.svg?branch=main
  [✓] https://readthedocs.org/projects/optax/badge/?version=latest
  [✓] https://img.shields.io/pypi/v/optax

  12 links checked.

  ERROR: 1 dead links found!
  [✖] https://github.com/google-deepmind/optax/blob/main/docs/optax-101.ipynb → Status: 404