Skip to content

[documentation] Add tutorials & citation#192

Merged
gdalle merged 6 commits intomainfrom
tutorials
May 26, 2025
Merged

[documentation] Add tutorials & citation#192
gdalle merged 6 commits intomainfrom
tutorials

Conversation

@amontoison
Copy link
Copy Markdown
Collaborator

@amontoison amontoison commented Feb 15, 2025

close #95
cc @adrhill

--> preview <--

Add the tutorials prepared for AD2024 in the documentation, updated for PPoPP25 next month, and using the latest visualization features of SMC.jl.

Adrian and Guillaume, is it already possible to display the sparsity pattern on which we apply a coloring with all nnz in black?
A workaround will be to set all colors to black but it could be nice to have an option sparsity_pattern in show_colors (if it doesn't exist already).

@amontoison amontoison added the documentation Improvements or additions to documentation label Feb 15, 2025
@amontoison amontoison requested a review from gdalle February 15, 2025 22:42
@codecov
Copy link
Copy Markdown

codecov bot commented Feb 15, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (172fd12) to head (1cb0751).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #192   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           15        15           
  Lines         1833      1833           
=========================================
  Hits          1833      1833           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Copy link
Copy Markdown
Member

@gdalle gdalle left a comment

Choose a reason for hiding this comment

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

Thanks for this initiative!

I see two ways to make this even better:

  • Say a couple words about each variant of coloring instead of just dropping the result on the user. What problem is each one supposed to solve? How does it compare to the previous ones? In particular, the point of bicoloring is not so obvious in this case (since the matrix is symmetric, it will always be worse than symmetric coloring?)
  • Can we avoid carrying and versioning an mtx file in the repo? We could download one on the fly instead with MatrixDepot.jl.

@gdalle gdalle changed the title [documentation] Add tutorials [documentation] Add tutorials & citation May 26, 2025
@gdalle gdalle merged commit a34cbdd into main May 26, 2025
7 checks passed
@gdalle gdalle deleted the tutorials branch May 26, 2025 12:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Add tutorials

2 participants