Skip to content

Add an example notebook showcasing replicability analysis to aid component selection#11

Merged
MarieRoald merged 10 commits intoMarieRoald:mainfrom
blzserdos:replicability_example
Feb 1, 2026
Merged

Add an example notebook showcasing replicability analysis to aid component selection#11
MarieRoald merged 10 commits intoMarieRoald:mainfrom
blzserdos:replicability_example

Conversation

@blzserdos
Copy link
Contributor

Following up on #8 and heavily based on tensorly/viz#24 (comment), i've added an example notebook describing 'component selection via replicability analysis for PARAFAC2' to the Gallery of examples. The notebook takes approx. 10 min to execute due to the large number of models being ran. Normally, these would be run in parallel, but i think this should be ok for demonstration?

@cchatzis

Please let me know what you think!

@blzserdos blzserdos marked this pull request as draft December 31, 2025 15:32
@blzserdos blzserdos marked this pull request as ready for review December 31, 2025 15:32
Copy link
Owner

@MarieRoald MarieRoald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks really good, just a couple of minor tweaks here and there. Regarding the build time, that will be a problem, and I'm pretty sure the build process will time out. As I see it, there are two ways around it:

  1. Have this as an example notebook instead of a example script. The notebooks are not run when we build, but then we wouldn't be able to keep the citation in the reference list.
  2. Commit the build artifacts in docs/auto_examples the plot_replicability.py-file. This will make it so we don't need to run the example when we build the docs, but we would loose the nice separation where the example gallery is automatically built and the notebooks are manually built.

I think I preffer solution 2, which would require running git add ./docs/auto_examples/plot_replicability* -f to forcefully add the sphinx-gallery build artifacts, but it's up to you :)

blzserdos and others added 6 commits January 10, 2026 18:21
fix notation

Co-authored-by: Marie Roald <roald.marie@gmail.com>
fix notation

Co-authored-by: Marie Roald <roald.marie@gmail.com>
improve readability

Co-authored-by: Marie Roald <roald.marie@gmail.com>
@blzserdos
Copy link
Contributor Author

Thanks a lot for the scrutiny and the great suggestions. I went with the suggested option 2. Please let me know what you think!

@blzserdos blzserdos requested a review from MarieRoald January 11, 2026 16:49
Copy link
Owner

@MarieRoald MarieRoald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great job! I just have a couple of small suggestions, and after that you just need to rebuild the docs and commit the updated replicability-files in the auto_examples directory before we can merge :)

@cchatzis
Copy link
Contributor

Should be OK now! Thanks a lot for the further comments @MarieRoald !

Copy link
Owner

@MarieRoald MarieRoald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Great, thanks for the nice contribution @blzserdos and @cchatzis !

@MarieRoald MarieRoald merged commit 403e606 into MarieRoald:main Feb 1, 2026
1 of 2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants