Experiments - Add two of notebooks/experiments/*.ipynb files to project documentation#119
Merged
Conversation
… et al. Remove the whole "Comparison with line annotations in the Herbold et al. dataset (hunk_labels.json only)" section, as the comparison there was based on a faoulty assumption on how changes are represented in the hunk_labels.json data file, and how that representation corresponds to the diff of changes. The correct comparison is present in a separate notebook, namely experiments/02-compare_annotations_Herbold.ipynb The state before the change was tagged with 'notebooks-before_experiments_cleanup'.
…g.ipynb Adjust name of the notebook, now that it consists only of the "Comparison with line annotations in the HaPy-Bug dataset" section.
This new dependency is intended to make it possible to add Jupyter Notebooks directly to the MkDocs navigation. Of the two MkDocs plugins created for this purpose, namely mkdocs-jupyter and mknotebooks, the first (and the one selected) seems to be actively maintained.
Copy those Jupyter Notebooks that would be used in project documentation to newly created docs/notebooks/ directory. The copy might be replaced later with symlinks.
One think that I have noticed that is missing is support for LaTeX-based
math equations, like $D_{BIP}$.
There is https://github.com/mitya57/python-markdown-math extension for
Python-Markdown, but is there some plugin or extension like that for
MkDocs?
In commit 11c6d01 (docs: Copy relevant Jupyter Notebooks to docs/notebooks/, 2025-04-03) two *.ipynb files were copied to docs/notebooks. Instead of taking space by duplicated files, use symbolic links.
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.
Add two notebooks comparing annotations generated with the PatchScope project with manual annotations in two publications: HaPy-Bug and Herbold et. al to the project documentation available at https://ncusi.github.io/PatchScope/, cleaning first of those beforehand.
Jupyter Notebooks are added to the MkDocs-generated documentation with the help of the mkdocs-jupyter plugin.