Skip to content

Conversation

@FayazRahman
Copy link
Contributor

@FayazRahman FayazRahman commented May 25, 2023

Summary

Added an example notebook that shows how to implement a QA system with LangChain's Deep Lake integration as a vector store and OpenAI embeddings.

Changes

List the major and minor changes.

  • Major Changes
    • Adds a new vector database example
  • Minor Changes
    • ...

Motivation

Add a new vector database to the collection, hence expanding the cookbook.

Self Review Checklist

  • Is the writing easily skimmable?
    • Sections have informative titles.
    • Key takeaways are upfront.
    • Short paragraphs and topic sentences are used.
  • Is the writing quality high?
    • Sentences are simple and unambiguous.
    • Demonstrative pronouns are avoided or clearly referenced.
    • No left-branching sentences.
  • Is the content universally helpful?
    • Terminology is specific and avoids jargon.
    • Provides solutions to common problems.
    • Code examples are general and exportable.
  • Is the content consistent?
    • Styling and formatting align with existing documentation.
    • Consistent use of punctuation and case.

Note: For additional guidelines on writing good documentation, check out What Makes Documentation Good.

@mikayelh
Copy link

mikayelh commented Jun 5, 2023

hi there @logankilpatrick , bumping this up in case it's possible to merge to add Deep Lake to the list of vector databases, we need more open source ones out there:)

@mikayelh
Copy link

hi @ted-at-openai, just noticed you review a similar pr . Would really appreciate you taking a look at this, too, as it has been up there for a while now.

@github-actions
Copy link

This PR is stale because it has been open 60 days with no activity. Remove stale label or comment or this will be closed in 10 days.

@github-actions github-actions bot added the Stale label Sep 23, 2023
Copy link
Collaborator

@simonpfish simonpfish left a comment

Choose a reason for hiding this comment

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

Hi @FayazRahman and @mikayelh. Apologies for the delay in reviewing this PR, and thank you for your contribution.

I just ran through the notebook and noticed a couple of broken links. It also looks like you're using a deprecated langchain api.

CleanShot 2023-09-27 at 15 40 58@2x

Would it also be possible for you guys to fill out our new pull request template? Let us know if you have any feedback on this template!

@simonpfish simonpfish removed the Stale label Sep 28, 2023
@FayazRahman
Copy link
Contributor Author

@simonpfish I have updated the PR and the description, hope everything looks good now!

@simonpfish
Copy link
Collaborator

Looks good! Thank you for doing that. One last thing, I'd recommend dealing with this deprecation warning and using the latest version of that function:

CleanShot 2023-09-28 at 17 56 26@2x

And completely optional, but sometimes I find it helpful to hide the outputs of the installation cell to make the notebooks easier to read.

CleanShot 2023-09-28 at 17 55 56@2x

@FayazRahman
Copy link
Contributor Author

@simonpfish Fixed!

@simonpfish simonpfish merged commit 24b7a8e into openai:main Oct 2, 2023
@simonpfish
Copy link
Collaborator

Thanks for the contribution!

katia-openai pushed a commit that referenced this pull request Feb 29, 2024
imran-binhasan added a commit to imran-binhasan/openai-cookbook that referenced this pull request Oct 27, 2025
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.

3 participants