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

Add Redis example notebooks and READMEs #131

Merged
merged 2 commits into from
Feb 15, 2023

Conversation

Spartee
Copy link
Contributor

@Spartee Spartee commented Feb 14, 2023

Description

This PR adds in Redis examples for the vector database section. Redis is now in the main "into to vector dbs" notebook as well as a new folder dedicated to redis-specific examples.

The Redis example notebook details

  • Setting up an index
  • Loading documents
  • simple querying
  • hybrid querying
  • index types (FLAT vs HNSW)

Future Work

A couple items are in progress that can be included in this PR or subsequent PRs

  • Q/A example
  • Async example
  • JSON storage example

TODO

Copy link

@tylerhutcherson tylerhutcherson left a comment

Choose a reason for hiding this comment

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

Awesome. Added a few comments to consider!

examples/vector_databases/redis/README.md Show resolved Hide resolved
examples/vector_databases/redis/README.md Show resolved Hide resolved
"metadata": {},
"outputs": [],
"source": [
"def index_documents(client: redis.Redis, prefix: str, documents: pd.DataFrame):\n",

Choose a reason for hiding this comment

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

Could be good to at least show simple pipeline usage here since the synchronous function can take a while? Batches of 100-200 seem to be a sweet spot

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm planning a future "when to use Async/pipelines" notebook which this will go in. Dataset is small enough right now to where it only takes a minute to load in everything

@Spartee
Copy link
Contributor Author

Spartee commented Feb 14, 2023

@colin-jarvis ready for you!

@colin-openai
Copy link
Collaborator

Reviewed, ran end-to-end first time, content looks great. Happy to merge

@colin-openai colin-openai merged commit 9b17d00 into openai:main Feb 15, 2023
@Spartee Spartee deleted the add-redis-example branch February 16, 2023 18:11
syusuke9999 pushed a commit to syusuke9999/openai-cookbook that referenced this pull request May 12, 2023
Add Redis example notebooks and READMEs
katia-openai pushed a commit that referenced this pull request Feb 29, 2024
Add Redis example notebooks and READMEs
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