Skip to content

Temporarily drop Benchmark section from Docs + delete legacy_benchmarks#5412

Merged
navidcy merged 6 commits intomainfrom
bp/legacy-benchmark-docs-link
Mar 20, 2026
Merged

Temporarily drop Benchmark section from Docs + delete legacy_benchmarks#5412
navidcy merged 6 commits intomainfrom
bp/legacy-benchmark-docs-link

Conversation

@briochemc
Copy link
Copy Markdown
Collaborator

@briochemc briochemc commented Mar 18, 2026

Addresses #5317 (comment)


EDIT: This is my quick band-aid fix, pointing to the "archived" directory, so that the docs build during CI. But maybe you guys want to revise that section of the docs and point to the new "benchmarking" directory?

@briochemc briochemc requested a review from navidcy March 18, 2026 23:06
@glwagner
Copy link
Copy Markdown
Member

Right, we should not merge this but instead update the docs to point to the benchmarks we will continue to add to and maintain.

@briochemc
Copy link
Copy Markdown
Collaborator Author

Do you want me to just change the link, or does the surrounding text also need updating (in which case I think best you or someone knowledgeable about these benchmarks writes it)?

@navidcy
Copy link
Copy Markdown
Member

navidcy commented Mar 19, 2026

I did what the title of the PR suggests in 2c69c63 over at #5355, so we can have docs that built without erroring and merge PRs.

So we can use this PR to implement the changes @glwagner is suggesting

@navidcy navidcy added documentation 📜 The sacred scrolls benchmark performance runs preconfigured benchamarks and spits out timing labels Mar 19, 2026
@navidcy
Copy link
Copy Markdown
Member

navidcy commented Mar 19, 2026

I don't think it's just a link change as the whole directory structure changed so probably some rephrasing is needed?

@glwagner
Copy link
Copy Markdown
Member

To make a quick PR we can just comment out the docs section, then restore it in a new PR.

@navidcy navidcy force-pushed the bp/legacy-benchmark-docs-link branch from 77523fe to 3d0cd68 Compare March 19, 2026 21:39
@navidcy
Copy link
Copy Markdown
Member

navidcy commented Mar 19, 2026

Done.

Should we also delete the legacy_benchmarks directory?

@navidcy navidcy changed the title Update benchmark directory links to legacy_benchmark in docs Temporarily drop Benchmark section from Docs Mar 19, 2026
@navidcy navidcy changed the title Temporarily drop Benchmark section from Docs Temporarily drop Benchmark section from Docs + delete legacy_benchmarks Mar 19, 2026
@navidcy navidcy requested a review from glwagner March 19, 2026 22:55
@navidcy
Copy link
Copy Markdown
Member

navidcy commented Mar 19, 2026

Should we also delete the legacy_benchmarks directory?

Question was answered here: #5317 (comment)

@navidcy
Copy link
Copy Markdown
Member

navidcy commented Mar 20, 2026

How long the benchmark CI should take? It’s been 3hrs. Is that expected?

@codecov
Copy link
Copy Markdown

codecov bot commented Mar 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 68.82%. Comparing base (19a4417) to head (e3f532d).
⚠️ Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5412      +/-   ##
==========================================
+ Coverage   68.73%   68.82%   +0.09%     
==========================================
  Files         398      398              
  Lines       21920    21968      +48     
==========================================
+ Hits        15066    15119      +53     
+ Misses       6854     6849       -5     
Flag Coverage Δ
buildkite 68.82% <ø> (+0.09%) ⬆️
julia 68.82% <ø> (+0.09%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ 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.

@navidcy navidcy merged commit 85a27b8 into main Mar 20, 2026
60 checks passed
@navidcy navidcy deleted the bp/legacy-benchmark-docs-link branch March 20, 2026 04:15
glwagner added a commit that referenced this pull request Mar 21, 2026
briochemc added a commit to briochemc/Oceananigans.jl that referenced this pull request Mar 23, 2026
…ine-ACCESS-OM2

* bp-claude/distributed-FPivot-TripolarGrid:
  Replace reverse() with reversed-range views in fold halo fills
  Reinstate Docs/Benchmarks (CliMA#5419)
  Update fill_halo_regions.jl (CliMA#5415)
  Temporarily drop Benchmark section from Docs + delete `legacy_benchmarks` (CliMA#5412)
  Add restart verification script (CliMA#5379)
  Rework support for reduction operations on Metal GPU to avoid materialization of the interior (CliMA#5329)
  Fix typo with density perturbation in docs (CliMA#5398)
  Implement ReactantCore.materialize_traced_array for Field (CliMA#5409)
  Remove Oceananigans dependency from Project.toml (CliMA#5414)
  (0.106) Log checkpoint file and mtime when restoring simulations (CliMA#5355)
glwagner added a commit that referenced this pull request Mar 23, 2026
* Extend TabulatedFunction to support 4D quadrilinear interpolation

Add support for 4-dimensional lookup tables with quadrilinear interpolation,
following the same patterns as the existing 1D/2D/3D implementations.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>

* Extend TabulatedFunction to support 5D quintilinear interpolation

Same mechanical pattern as 4D: adds 5D kernel, builder, evaluation method,
32-term _interpolate, TabulatedFunction5D alias, and comprehensive tests.

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>

* Apply suggestions from code review

Co-authored-by: Navid C. Constantinou <[email protected]>

* Ignore legacy_benchmark linkcheck (directory removed in #5412)

Co-Authored-By: Claude Opus 4.6 (1M context) <[email protected]>

* Apply suggestion from @glwagner

---------

Co-authored-by: Claude Opus 4.6 (1M context) <[email protected]>
Co-authored-by: Navid C. Constantinou <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

benchmark performance runs preconfigured benchamarks and spits out timing documentation 📜 The sacred scrolls

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants