Speed up link checker by not loading historical API docs #496
Conversation
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
Eric-Arellano
commented
Dec 7, 2023
| @@ -116,7 +142,6 @@ const readArgs = (): Arguments => { | |||
| .version(false) | |||
| .option("external", { | |||
| type: "boolean", | |||
| demandOption: false, | |||
There was a problem hiding this comment.
This is the default. No need to set it.
| @@ -134,57 +159,60 @@ function markdownFromNotebook(source: string): string { | |||
| return markdown; | |||
| } | |||
|
|
|||
| async function getMarkdownAndAnchors( | |||
There was a problem hiding this comment.
Same logic as before.
arnaucasau
approved these changes
Dec 8, 2023
There was a problem hiding this comment.
Thank you Eric! On my end, the execution time goes from 1 minute 40 seconds to roughly 15 seconds! Awesome work!!
Indeed, the problem with the script was the amount of historical files we were parsing its anchors. Having an extra glob to decide which ones we want to load is a really good idea, and now we can avoid having extra logic to ignore files in addition to the speed up.
Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
This was referenced Dec 21, 2023
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 29, 2023
In #495, we will start checking historical API docs. For performance, it's important that we don't load every single file in the project at once in memory. Instead, we want to operate in batches: e.g. check all of 0.44, then drop from memory and move on to 0.43. This PR is a pre-factor to add a new `FileBatch` class. For now, we only have a single `FileBatch`, the same as before. This class still differentiates between files "to load" vs "to check", per #496.
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
Closes Qiskit#461. Before, the script took me about 42 seconds. Now, about 5.7: ``` ❯ hyperfine 'npm run check:links' Benchmark 1: npm run check:links Time (mean ± σ): 5.680 s ± 0.143 s [User: 7.285 s, System: 0.471 s] Range (min … max): 5.548 s … 5.964 s 10 runs ``` This PR differentiates between files we want to check vs. files that we only need to know they exist because other files might link to them. For the latter, we do still need to read in those files to determine their anchors. The key insight of this PR is that 99% of the historical API docs can be ignored because the stable docs don't link to them. We only need to load a couple of historical API docs because our migration guides link to them. -- I think we probably will want to add an argument to allow checking links for historical API docs: Qiskit#495. This should work well with that change; we'd update the list based off of the `Arguments` passed in. --------- Co-authored-by: Arnau Casau <47946624+arnaucasau@users.noreply.github.com>
frankharkins
pushed a commit
to frankharkins/documentation
that referenced
this pull request
Jul 22, 2024
In Qiskit#495, we will start checking historical API docs. For performance, it's important that we don't load every single file in the project at once in memory. Instead, we want to operate in batches: e.g. check all of 0.44, then drop from memory and move on to 0.43. This PR is a pre-factor to add a new `FileBatch` class. For now, we only have a single `FileBatch`, the same as before. This class still differentiates between files "to load" vs "to check", per Qiskit#496.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Closes #461.
Before, the script took me about 42 seconds. Now, about 5.7:
This PR differentiates between files we want to check vs. files that we only need to know they exist because other files might link to them. For the latter, we do still need to read in those files to determine their anchors.
The key insight of this PR is that 99% of the historical API docs can be ignored because the stable docs don't link to them. We only need to load a couple of historical API docs because our migration guides link to them.
--
I think we probably will want to add an argument to allow checking links for historical API docs: #495. This should work well with that change; we'd update the list based off of the
Argumentspassed in.