Skip to content

DOC: Re-execute 1_class_registry notebook to populate cell outputs#1713

Open
romanlutz wants to merge 1 commit intomicrosoft:mainfrom
romanlutz:fix/class-registry-notebook-output
Open

DOC: Re-execute 1_class_registry notebook to populate cell outputs#1713
romanlutz wants to merge 1 commit intomicrosoft:mainfrom
romanlutz:fix/class-registry-notebook-output

Conversation

@romanlutz
Copy link
Copy Markdown
Contributor

What

doc/code/registry/1_class_registry.ipynb was committed with execution_count: null on 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:

  • Cell 1: the list of available scenario names and their metadata (Cyber, Jailbreak, …)
  • Cell 3: the resolved class for garak.encoding
  • Cell 5: pyrit init logs and confirmation that the scenario was instantiated
  • Cell 7: registry container operations (in / len / iter)
  • Cell 9: the same flow on InitializerRegistry

Notes

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>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant