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

docs: update README to include note on decoupled model responses #49

Merged
merged 2 commits into from
Sep 30, 2024

Conversation

mattwittwer
Copy link
Contributor

@mattwittwer mattwittwer commented Sep 16, 2024

What does the PR do?

Adding a note to clarify the collection of results from decoupled model requests. This has caused some confusion since this is different from response collection using '.get()' from fixed length responses.

Checklist

  • PR title reflects the change and is of format <commit_type>: <Title>
  • Changes are described in the pull request.
  • Related issues are referenced.
  • Populated github labels field
  • Added test plan and verified test passes.
  • Verified that the PR passes existing CI.
  • Verified copyright is correct on all changed files.
  • Added succinct git squash message before merging ref.
  • All template sections are filled out.
  • Optional: Additional screenshots for behavior/output changes with before/after.

Commit Type:

Check the conventional commit type
box here and add the label to the github PR.

  • build
  • ci
  • docs
  • feat
  • fix
  • perf
  • refactor
  • revert
  • style
  • test

Related PRs:

Where should the reviewer start?

Review the added note and the links to decoupled models and example code.

Test plan:

  • CI Pipeline ID:

Caveats:

Background

Related Issues: (use one of the action keywords Closes / Fixes / Resolves / Relates to)

@mattwittwer mattwittwer self-assigned this Sep 16, 2024
@mattwittwer mattwittwer added the documentation Improvements or additions to documentation label Sep 16, 2024
Copy link

@oandreeva-nv oandreeva-nv left a comment

Choose a reason for hiding this comment

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

lgtm

@mattwittwer mattwittwer merged commit d9e1d57 into main Sep 30, 2024
1 of 3 checks passed
@mattwittwer mattwittwer deleted the mwittwer-update-readme-results branch September 30, 2024 17:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants