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

Developing Hallucination Guardrails #1211

Merged
merged 10 commits into from
Jun 7, 2024
Merged

Conversation

royziv11
Copy link
Contributor

Summary

Briefly describe the changes and the goal of this PR. Make sure the PR title summarizes the changes effectively.

Motivation

Why are these changes necessary? How do they improve the cookbook?


For new content

When contributing new content, read through our contribution guidelines, and mark the following action items as completed:

  • I have added a new entry in registry.yaml (and, optionally, in authors.yaml) so that my content renders on the cookbook website.
  • I have conducted a self-review of my content based on the contribution guidelines:
    • Relevance: This content is related to building with OpenAI technologies and is useful to others.
    • Uniqueness: I have searched for related examples in the OpenAI Cookbook, and verified that my content offers new insights or unique information compared to existing documentation.
    • Spelling and Grammar: I have checked for spelling or grammatical mistakes.
    • Clarity: I have done a final read-through and verified that my submission is well-organized and easy to understand.
    • Correctness: The information I include is correct and all of my code executes successfully.
    • Completeness: I have explained everything fully, including all necessary references and citations.

We will rate each of these areas on a scale from 1 to 4, and will only accept contributions that score 3 or higher on all areas. Refer to our contribution guidelines for more details.

@royziv11 royziv11 changed the title Initial draft of cookbook Developing Hallucination Guardrails May 30, 2024
@shyamal-anadkat shyamal-anadkat self-requested a review June 3, 2024 15:45
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
examples/Developing_hallucination_guardrails.ipynb Outdated Show resolved Hide resolved
@royziv11
Copy link
Contributor Author

royziv11 commented Jun 6, 2024

@shyamal-anadkat - Made all of the necessary tweaks. Let me know if you have an additional suggestions. Thank you!

Copy link
Collaborator

@shyamal-anadkat shyamal-anadkat left a comment

Choose a reason for hiding this comment

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

lgtm!

registry.yaml Outdated Show resolved Hide resolved
@royziv11 royziv11 merged commit 5ea0f34 into main Jun 7, 2024
@royziv11 royziv11 deleted the cookbook/rz/hallucinationGuardrails branch June 7, 2024 18:30
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

3 participants