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.

Sign up for GitHub

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

Jump to bottom

New starter notebook #881

Merged
merged 8 commits into from
Aug 3, 2023
Merged

New starter notebook #881

merged 8 commits into from
Aug 3, 2023

Conversation

atroyn
Copy link
Contributor

@atroyn atroyn commented Jul 26, 2023 •
edited
Loading

Description of changes

This PR creates a new starter notebook intended to familiarize people with the very basic, core functionality of embedding retrieval with Chroma. It's self-contained, and hopefully straightforward and easy to understand.

There is also a minor fix to the experimental notebook.

Test plan

Ran the notebook, also via Colab.

Documentation Changes

None.

TODO

@github-actions
Copy link

Reviewer Checklist

Please leverage this checklist to ensure your code review is thorough before approving

Testing, Bugs, Errors, Logs, Documentation

  • Can you think of any use case in which the code does not behave as intended? Have they been tested?
  • Can you think of any inputs or external events that could break the code? Is user input validated and safe? Have they been tested?
  • If appropriate, are there adequate property based tests?
  • If appropriate, are there adequate unit tests?
  • Should any logging, debugging, tracing information be added or removed?
  • Are error messages user-friendly?
  • Have all documentation changes needed been made?
  • Have all non-obvious changes been commented?

System Compatibility

  • Are there any potential impacts on other parts of the system or backward compatibility?
  • Does this change intersect with any items on our roadmap, and if so, is there a plan for fitting them together?

Quality

  • Is this code of a unexpectedly high quality (Readbility, Modularity, Intuitiveness)

@atroyn atroyn requested review from jeffchuber and HammadB July 26, 2023 21:29
HammadB
HammadB approved these changes Jul 26, 2023
View reviewed changes
Copy link
Collaborator

@HammadB HammadB left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Approved with comments.

Nit - I find the name a bit ugly. Could we do something a little different than all-caps START_HERE.ipynb ? Perhaps just Chroma_101 or Start_Here?

@atroyn
Copy link
Contributor Author

atroyn commented Jul 26, 2023

Approved with comments.

Nit - I find the name a big ugly. Could we do something a little different than all-caps START_HERE.ipynb ? Perhaps just Chroma_101 or Start_Here?

Will rename to start_here.ipynb

@atroyn atroyn requested a review from HammadB August 1, 2023 22:09
@atroyn
Copy link
Contributor Author

atroyn commented Aug 1, 2023

@HammadB @jeffchuber I've added a minimal chat-your-docs application to point the notebook to, PTAL

jeffchuber
jeffchuber approved these changes Aug 3, 2023
View reviewed changes
Copy link
Contributor

@jeffchuber jeffchuber left a comment

Choose a reason for hiding this comment

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

a bunch of improvements and i think one bug (doesnt use openai)

examples/basic_functionality/start_here.ipynb Show resolved Hide resolved
examples/basic_functionality/start_here.ipynb Outdated Show resolved Hide resolved
examples/basic_functionality/start_here.ipynb Show resolved Hide resolved
examples/basic_functionality/start_here.ipynb Show resolved Hide resolved
examples/basic_functionality/start_here.ipynb Show resolved Hide resolved
examples/chat_with_your_documents/README.md Outdated Show resolved Hide resolved
examples/chat_with_your_documents/load_data.py Show resolved Hide resolved
examples/chat_with_your_documents/load_data.py Outdated Show resolved Hide resolved
examples/chat_with_your_documents/load_data.py Outdated Show resolved Hide resolved
examples/chat_with_your_documents/main.py Show resolved Hide resolved
@atroyn
Copy link
Contributor Author

atroyn commented Aug 3, 2023

one bug (doesnt use openai)

it uses the OpenAI LLM but not their embeddings. I think that's fine.

@atroyn atroyn enabled auto-merge (squash) August 3, 2023 22:14
@atroyn atroyn merged commit c387e1d into main Aug 3, 2023
@atroyn atroyn deleted the anton/example-notebook branch August 3, 2023 22:42
@atroyn atroyn mentioned this pull request Aug 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@HammadB HammadB HammadB approved these changes

@jeffchuber jeffchuber jeffchuber approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@atroyn @jeffchuber @HammadB