docs: Add missing alt text to gallery images for accessibility. #1523
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
docs/gallery.rst
Outdated
|
|
||
| .. image:: /images/examples/contrib/ademamix_rosenbrock.png | ||
| :alt: | ||
| :alt: AdEMAMix |
There was a problem hiding this comment.
Thanks! LGTM!
Minor adjustment for consistency:
:alt: AdEMAMix.
(Added a period to match the other entries)
rdyro
left a comment
rdyro
left a comment
There was a problem hiding this comment.
Hey, thanks for the PR!
In the spirit of accessibility I believe we'd need this alt-text to describe what's in the figure. The current alt-text isn't too helpful.
Would you be willing to add about 2 sentences for each figure describing what the figure is presenting? (e.g., "Loss landscape chart with the path taken by the L-BFGS optimizer overlaid on top." for lbfgs.png)
|
Hey @rdyro. I have added a detailed description for all the alt tags in the gallery, please look into it and let me know if you need anything else. Happy New Year! |
|
|
||
| .. image:: /images/examples/tiny_shakespeare.png | ||
| :alt: Character-level Transformer on Tiny Shakespeare | ||
| :alt: Screenshot of Shakespearean dialogue text generated by the character-level Transformer model. |
There was a problem hiding this comment.
it'd be good to add "trained on the Tiny Shakespear dataset."
|
|
||
| .. image:: /images/examples/perturbations.png | ||
| :alt: | ||
| :alt: Geometric diagram illustrating differentiable perturbations, showing a hexagonal constraint set C with vectors indicating the perturbed parameters and their projections. |
There was a problem hiding this comment.
I'm not sure this is right, I'd go with: "A perturbed maximizer illustration from https://arxiv.org/abs/2002.08676"
|
|
||
| .. image:: /images/examples/contrib/reduce_on_plateau.png | ||
| :alt: | ||
| :alt: Learning rate schedule chart showing the learning rate value stepping down in discrete intervals over 50 epochs as the training progresses. |
There was a problem hiding this comment.
It'd be good to emphasize the point about the learning rate being algorithmically adjusted; it should be more like "A chart showing an automatically decreasing learning rate via the Reduce on Plateau learning rate scheduler."
|
|
||
| .. image:: /images/examples/contrib/sam.png | ||
| :alt: | ||
| :alt: Optimization trajectory plot comparing the path of a standard optimizer versus SAM, showing how SAM navigates the loss landscape to find flatter minima. |
There was a problem hiding this comment.
nit: replace "standard" with "non-SAM" for a more accurate description.
3 participants
No description provided.