DOC: Re-execute 1_class_registry notebook to populate cell outputs#1713
Open
romanlutz wants to merge 1 commit intomicrosoft:mainfrom
Open
DOC: Re-execute 1_class_registry notebook to populate cell outputs#1713romanlutz wants to merge 1 commit intomicrosoft:mainfrom
romanlutz wants to merge 1 commit intomicrosoft:mainfrom
Conversation
doc/code/registry/1_class_registry.ipynb was committed with execution_count: null on every code cell, so the published docs page (https://microsoft.github.io/PyRIT/code/registry/class_registry/) renders all 5 code cells with no output. Re-executing populates: - the available scenario names and their metadata - the resolved class for 'garak.encoding' - the result of instantiating it after pyrit init - registry container operations (in / len / iter) - the same flow on InitializerRegistry Note: a SyntaxWarning from the upstream confusables 1.2.0 package is visible in cell 1 output. The package is unfixed upstream (woodgern/confusables); we will audit our use of confusables in a follow-up. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
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
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.
What
doc/code/registry/1_class_registry.ipynbwas committed withexecution_count: nullon every code cell. As a result, the published docs page at https://microsoft.github.io/PyRIT/code/registry/class_registry/ renders all 5 code cells with no output. Re-executing populates them:garak.encodingin/len/iter)InitializerRegistryNotes
SyntaxWarningfrom upstreamconfusables 1.2.0(unfixed; see woodgern/confusables). I'll audit our use ofconfusablesin a follow-up — we may be able to swap it forconfusable_homoglyphs(already in our deps) or remove it entirely.multiprocessSyntaxWarning addressed by MAINT: Bump datasets to >=4.8.0 to silence multiprocess SyntaxWarning #1709. Once MAINT: Bump datasets to >=4.8.0 to silence multiprocess SyntaxWarning #1709 merges and these notebooks are next re-executed (manually or viapct_to_ipynb.pyin CI), it will disappear from outputs.