Update autotuning documentation to reflect current interface #688
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates the LinearSolveAutotune documentation to accurately reflect the current implementation, including the simplified AutotuneResults-based interface and GitHub-based result sharing workflow.
Changes
Interface Updates
autotune_setup()
returns anAutotuneResults
object containingresults_df
andsysinfo
plot(results)
method for generating performance visualizationsshare_results(results)
function for community sharingContent Improvements
:tiny
,:small
,:medium
,:large
,:big
) with their actual size rangesExamples Added
Documentation Structure
The updated documentation follows a logical progression:
Related Issues
🤖 Generated with Claude Code
Co-Authored-By: Claude [email protected]