fix: library cleanup — dead links, bare except, stale refs#3
Closed
nathanhubens wants to merge 4 commits into
Closed
fix: library cleanup — dead links, bare except, stale refs#3nathanhubens wants to merge 4 commits into
nathanhubens wants to merge 4 commits into
Conversation
- Fix 4 dead links: tutorial.html → benchmark.html, remove sensitivity.html refs - Remove report.html link (source notebook missing) - Remove analysis/report.ipynb from _quarto.yml (file doesn't exist) - Fix bare except: → except Exception: in profiling hooks - Remove unused `from typing import Any` in compute - Fix stale summary() example output in index.ipynb
Structural alignment for all 10 API notebooks: - Add raw YAML frontmatter (title, description, skip_showdoc) - Add #| include: false setup cell with from nbdev.showdoc import * - Add show_doc() for all public classes and functions - Add #| hide test cells with fastcore.test assertions - Add See Also cross-reference sections - Remove stale nbdev_export() call from core.ipynb Notebooks updated: core/core, core/utils, metrics/size, metrics/speed, metrics/memory, metrics/energy, metrics/compute, analysis/profiling, analysis/benchmark, visualization/plot
- Recreate nbs/analysis/report.ipynb from report.py (source notebook was missing — code existed but couldn't be edited via nbdev) - Add show_doc for Report, ComparisonReport, ReportMetricDelta - Add inline tests for both classes - Create nbs/tutorials/report.ipynb showing full compression workflow: benchmark → compress → benchmark again → ComparisonReport - Add both notebooks to _quarto.yml sidebar
Contributor
Author
|
Superseded by #4 (rebased on post-v0.1.0 master) |
2 tasks
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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
From a full library audit (3 agents: API coherence, typos, notebook conventions).
Fixes
tutorial.html→benchmark.htmlin See Also sections; removedsensitivity.htmlrefs (notebook doesn't exist)report.htmllink from benchmark See Also (sourceanalysis/report.ipynbis missing)analysis/report.ipynbfrom_quarto.ymlsidebar (file doesn't exist, would break Quarto build)except:→except Exception:in profiling hook setup (was catching KeyboardInterrupt)from typing import Anyin compute modulesummary()example in index.ipynb (Params line under Compute section)Not addressed (structural debt)
analysis/report.ipynbsource notebook — needs to be reverse-engineered fromreport.pyTest plan
nbdev-testfull suite passesnbdev-exportclean