Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Convert PyRIT Framework How to Guide to jupytext #51

Merged
merged 7 commits into from
Feb 21, 2024

Conversation

nina-msft
Copy link
Contributor

@nina-msft nina-msft commented Feb 20, 2024

Description

This PR converts the wiki page to Jupytext / Jupyter Notebook. It contains the min set of changes needed to create a notebook with Jupytext. There was some overlap with @rlundeen2's PR: #49 which is now merged.

Note: In converting to a Jupyter Notebook that passed, I modified the original Wiki content a bit to:

  • Add more import statements where needed
  • Use a deployment name that exists in the chosen Azure Open AI Chat endpoint
  • Take variables from environment variables and load default env
  • Removed the # returns comments since the Python Notebook has that output now when its created with jupytext

Tests

  • no new tests required
  • new tests added
  • existing tests adjusted

Documentation

  • no documentation changes needed
  • documentation added or edited
  • example notebook added or updated

Note: Need to coordinate with Marketing folks to redirect to this How To page instead of the one on the Wiki, then need to delete the Wiki page. @romanlutz is there any other redirection needed for this change?

Copy link

github-actions bot commented Feb 21, 2024

Test Results

114 tests  ±0   114 ✅ ±0   12s ⏱️ +3s
  1 suites ±0     0 💤 ±0 
  1 files   ±0     0 ❌ ±0 

Results for commit f287ff1. ± Comparison against base commit 6bebd48.

♻️ This comment has been updated with latest results.

Copy link
Contributor

@romanlutz romanlutz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That was fast! Thanks, @nina-msft

examples/setup/pyrit_framework_how_to_guide.pct.py Outdated Show resolved Hide resolved
@romanlutz romanlutz marked this pull request as ready for review February 21, 2024 17:59
@nina-msft nina-msft merged commit aaadfe4 into main Feb 21, 2024
7 checks passed
@nina-msft nina-msft deleted the users/nichikan/2180-convert-howto-jupytext branch February 21, 2024 18:25
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.

None yet

5 participants