search

tensorly / viz

Easy visualization and evaluation of matrix and tensor factorization models
https://tensorly.org/viz/
MIT License
16 stars 4 forks source link

ordering of the examples #9

Closed yiitozer closed 1 year ago

yiitozer commented 1 year ago

In TLViz + PlotLy for interactive visualisations, the split-half analysis example is referred to, but it comes after the TLVir + PlotLy example. I would switch the ordering.

https://github.com/openjournals/joss-reviews/issues/4754

yngvem commented 1 year ago

Good point @yiitozer !

The example gallery is automatically generated by sphinx-gallery which orders based on number of lines of code (as a proxy for example complexity) and so the examples are not meant to be read in a particular order, but rather based on the interest of the reader. Therefore, we have tried to split each topic into its own example and link related topics through links to make it easy for a reader to find a relevant example for the functionality/topic they are interested in. Do you think that it would clearer, if we update the text to not imply an order? For example

We fit a three-component PARAFAC2 model to this data (to see why a three-component model is a good choice, see the split-half analysis example).

instead of

We know from the split-half analysis example that 3 components is a good choice for this data.

What do you think? Would a change like this be sufficient?

yiitozer commented 1 year ago

I think that's a good solution and I also understand that it's not a step by step documentation. We can close this issue!