Skip to content

Conversation

maxreid-openai
Copy link
Contributor

@maxreid-openai maxreid-openai commented Jul 8, 2024

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.

@maxreid-openai maxreid-openai requested review from colin-openai and ibigio and removed request for colin-openai and ibigio July 8, 2024 14:49
Copy link
Collaborator

@justonf justonf left a comment

Choose a reason for hiding this comment

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

Added a comments primarily to the notebook.

Overall, it looks very in-depth, but it's also a bit overwhelming. Some high level recommendations:

  1. Try to add some type of map or guidance at the beginning that gives some overview for all of the content that'll be reviewed.
  2. There's a few cases where code blocks are broken up by single lines of text; we should try to consolidate these so it doesn't feel as choppy
  3. The very end doesn't feel finished; could you add a summary section and review what was demonstrated?

maxreid-openai and others added 6 commits July 11, 2024 15:17
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb

Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb

Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Copy link
Collaborator

@justonf justonf left a comment

Choose a reason for hiding this comment

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

Thanks for adding the sections!

Added a few more comments. Another high-level - there's a lot of repetitive phrases throughout the cookbook - "In this code block" "In this section" "the below section" "Feel free to".

Consider removing these references since they reduce clarity and conciseness, and tend to be more passive.

maxreid-openai and others added 4 commits July 12, 2024 13:50
…re_Functions_and_GPT_Actions_in_ChatGPT.ipynb

Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
Copy link
Collaborator

@justonf justonf left a comment

Choose a reason for hiding this comment

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

Looks good to me. There's still points where more polish can be added, if you have the time to improve them, but this should be good to put up now.

Feedback areas:

  • Code blocks are difficult to read due to the comments - consolidating these comments into block comments or adding more intentional spacing.

@maxreid-openai maxreid-openai merged commit 5f55266 into main Jul 25, 2024
@maxreid-openai maxreid-openai deleted the mr-azure-rag-cookbook branch July 25, 2024 19:12
nelsonauner pushed a commit to nelsonauner/openai-cookbook that referenced this pull request Aug 14, 2024
Co-authored-by: juston <96567547+justonf@users.noreply.github.com>
joshagilend pushed a commit to joshagilend/openai-cookbook that referenced this pull request Oct 23, 2024
Co-authored-by: juston <96567547+justonf@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.

2 participants