-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add alt text to Dask docs #1
Conversation
Here's a proposed checklist for alt text style (may be helpful for review): The alt text has
|
docs/source/shared.rst
Outdated
@@ -119,6 +119,7 @@ are good at workflows with non-trivial cross-task | |||
communication; they have been removed from the plot. | |||
|
|||
.. image:: images/scaling-edges.png | |||
:alt: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
:alt: | |
:alt: Two graph panels. Left: Cost of entire graph, Duration versus Number of edges per task. Dask.async and dask.threaded curves both increase linearly, with the latter consistently higher by at least a factor of 3. Right: Cost per edge, with the same axes. Both curves start from a high value for small number of edges, but reach an asymptote where dask.threaded is a factor of a few higher than dask.async . |
docs/source/array-design.rst
Outdated
@@ -7,7 +7,7 @@ Overview | |||
.. image:: images/array.png | |||
:width: 40 % | |||
:align: right | |||
:alt: A dask array | |||
:alt: A dask array. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm working on this!
Co-authored-by: Martin Durant <martindurant@users.noreply.github.com> Co-authored-by: Ian Rose <ian.r.rose@gmail.com> Co-authored-by: Pavithra Eswaramoorthy <pavithraes@outlook.com> Co-authored-by: Julia Signell <jsignell@gmail.com> Co-authored-by: Isabela Presedo-Floyd <50221806+isabela-pf@users.noreply.github.com>
Co-authored-by: Charles Blackmon-Luca <20627856+charlesbluca@users.noreply.github.com>
docs/source/10-minutes-to-dask.rst
Outdated
@@ -391,6 +392,7 @@ triggering computation, we can inspect the task graph to figure out what's going | |||
>>> b.visualize() | |||
|
|||
.. image:: images/10_minutes_array_graph.png | |||
:alt: Two neighboring blocks with thin strips near their shared border representing the shared data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is this alt text referring to a different image? It doesn't seem like it goes with this one.
I was expecting something like "Dask task graph of ... blah blah blah" for alt text belonging to images/10_minutes_array_graph.png
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, this very definitely does not go with this image. I've added an alt-text suggestion for the actual image here below.
@@ -7,7 +7,7 @@ Overview | |||
.. image:: images/array.png | |||
:width: 40 % | |||
:align: right | |||
:alt: A dask array | |||
:alt: 12 rectangular blocks arranged as a 4-row, 3-column layout. Each block includes 'x' and its location in the table starting with ('x',0,0) in the top-left, and a size of 5x8. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -34,20 +34,20 @@ Consider two neighboring blocks in a Dask array: | |||
|
|||
.. image:: images/unoverlapping-neighbors.png | |||
:width: 30% | |||
:alt: un-overlapping neighbors | |||
:alt: Two neighboring blocks which do not overlap. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
||
We extend each block by trading thin nearby slices between arrays: | ||
|
||
.. image:: images/overlapping-neighbors.png | ||
:width: 30% | ||
:alt: overlapping neighbors | ||
:alt: Two neighboring block with thin strips along their shared border representing data shared between them. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
|
||
We do this in all directions, including also diagonal interactions with the | ||
overlap function: | ||
|
||
.. image:: images/overlapping-blocks.png | ||
:width: 40% | ||
:alt: overlapping blocks | ||
:alt: A two-dimensional grid of blocks where each one has thin strips around their borders representing data shared from their neighbors. They include small corner bits for data shared from diagonal neighbors as well. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -23,7 +23,7 @@ directly with a light annotation of normal python code: | |||
>>> z.visualize() | |||
|
|||
.. image:: images/inc-add.svg | |||
:alt: simple task graph created with dask.delayed | |||
:alt: A task graph with two "inc" functions combined using an "add" function resulting in an output node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -112,7 +112,7 @@ example, because these functions are already very small and fast.) | |||
|
|||
.. image:: images/delayed-inc-double-add.svg | |||
:align: right | |||
:alt: simple task graph created with dask.delayed | |||
:alt: A task graph with many nodes for "inc" and "double" that combine with "add" nodes. The output of the "add" nodes finally aggregate with a "sum" node. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -102,6 +102,7 @@ to get a true representation of what order the tasks will be executed in. | |||
|
|||
|
|||
.. image:: images/order-failure.png | |||
:alt: Complex task graph of several vertical node chains at the output, and a few input sub-trees. In between these sections, there is a many-to-many area of crossing dependency arrows. The color coding of the output trees is interleaved without a clear progression. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
@@ -139,6 +140,7 @@ see the effect of ordering: | |||
|
|||
|
|||
.. image:: images/order-success.png | |||
:alt: Complex task graph of several vertical node chains at the output, and a similar number of input blocks. The outputs and inputs are linked by simple nodes of a few inputs each, laid out without significant crossover between sections of the tree. The color coding of the output chains shows clear progression in the order of execution with each output color having a corresponding input of the same color. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
thanks `@GenevieveBuckley` for all the suggestions! Co-authored-by: Genevieve Buckley <30920819+GenevieveBuckley@users.noreply.github.com>
Co-authored-by: Genevieve Buckley <30920819+GenevieveBuckley@users.noreply.github.com>
Welcome!
This is the working PR for the Dask Community alt text mini sprint! This is where we collaborate during the event before we send a clean contribution over to the main repo.
How to contribute
For the full info about this event, please visit the HackMD agenda.
During the event, you can contribute alt text to any of the images on currently used in a blog post. Please contribute via suggestions so we can easily review each other's work.
If you plan to work on a file, let people know by commenting below. We can have multiple suggestions for the same alt text, but it would be nice if we spread out to cover more images.
If you think an image is missing from these files, let @scharlottej13 know and she'll add it to the PR.
Images in this PR
To make collaborating easier, comment below with the number of the image you'd like to work on. You can do this as a group, and you can write alt text for as many images as you'd like.
file:
docs/source/logos.rst
file:
docs/source/why.rst
rendered docsfile
docs/source/10-minutes-to-dask.rst
rendered docsfile
docs/source/array-chunks.rst
rendered docsfile
docs/source/array-design.rst
rendered docsfile
docs/source/array-overlap.rst
rendered docsfile
docs/source/delayed.rst
rendered docsfile
docs/source/develop.rst
rendered docsfile
docs/source/graphs.rst
rendered docsfile
docs/source/graphviz.rst
rendered docsfile
docs/source/optimize.rst
rendered docsfile
docs/source/order.rst
rendered docsfile
docs/source/shared.rst
rendered docs