Adds one trick to pytest README

[skrawcz]

Adds example of testing for stability / variance.

Changes

How I tested this

Notes

Checklist

• PR has an informative and human-readable title (this will be pulled into the release notes)
• Changes are limited to a single goal (no scope creep)
• Code passed the pre-commit check & code is left cleaner/nicer than when first encountered.
• Any change in functionality is tested
• New functions are documented (with a description, list of inputs, and expected output)
• Placeholder code is flagged / future TODOs are captured in comments
• Project documentation has been updated if adding/changing functionality.

---

Important

Adds a section in README.md for testing output stability/variance in generative models using pytest.

• Documentation:
  • Adds a section in README.md for testing stability/variance of outputs in generative models using pytest.
  • Provides a code example test_an_actions_stability() to run actions multiple times and check output consistency.

^{This description was created by for cb28888. It will automatically update as commits are pushed.}

[github-actions]

A preview of is uploaded and can be seen here:

✨ https://burr.dagworks.io/pull/489 ✨

Changes may take a few minutes to propagate. Since this is a preview of production, content with draft: true will not be rendered. The source is here: https://github.com/DAGWorks-Inc/burr/tree/gh-pages/pull/489/

[ellipsis-dev]

👍 Looks good to me! Reviewed everything up to cb28888 in 1 minute and 25 seconds

More details

• Looked at 32 lines of code in 1 files
• Skipped 0 files when reviewing.
• Skipped posting 1 drafted comments based on config settings.

1. examples/pytest/README.md:314

• Draft comment:
  json is used but not imported. Add import json at the beginning of the code snippet.
• Reason this comment was not posted:
  Decided after close inspection that this draft comment was likely wrong and/or not actionable:
  This is a code snippet in a README.md file, not actual implementation code. Documentation often omits imports for brevity. The code is meant to illustrate a concept rather than be directly copy-pasted. Additionally, this is a minor issue that would be immediately caught by any Python interpreter or linter if someone tried to run it.
  The comment is technically correct - the code does use json without importing it. Missing imports could confuse readers who are new to Python.
  While technically correct, this level of detail is unnecessary in documentation. The focus should be on the concept being illustrated, not implementation details that would be obvious when actually implementing.
  Delete the comment. Missing imports in documentation examples are common and acceptable, and this would be immediately caught by tools if implemented.

Workflow ID: wflow_wvsiGGiYoaTYwSgC

---

You can customize Ellipsis with 👍 / 👎 feedback, review rules, user-specific overrides, quiet mode, and more.