namedtensor / notation

108 stars 5 forks source link

Added footnote describing summing over a named axis #33

Closed azpoliak closed 3 years ago

azpoliak commented 3 years ago

Added footnote to 2.2.2 (Reductions) based on conversation in https://github.com/namedtensor/notation/issues/30 regarding how to express applying an operator (in this case summation) over (rather than across or along) a named axis.

image

davidweichiang commented 3 years ago

Thanks -- why not put it in the main text instead of a footnote?

azpoliak commented 3 years ago

Putting it in a footnote was the simplest fix without breaking the flow of the narrative.

One option could be at the end of these reductions there could be a simple paragraph about how we refer to "operating over a named axis". The paragraph could then write out in words the above operators, i.e "minimizing over the foo axis", "maximizing over the foo axis", "taking the mean over the foo axis", etc.

Another option is to put the text next to expressions themselves. When I tried this quickly, it looked too ugly. In this screenshot, it doesnt look too bad. image

I think for pedagogical reasons and to standardize language it might not be a bad to explicitly discussing this in a small paragraph after the reduction examples.

I'll leave these decisions to you all.