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

[ENH] Removing new line cleanup from OpenAI EF (python) #2125

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

tazarov
Copy link
Contributor

@tazarov tazarov commented May 3, 2024

Closes #2129

Description of changes

Summarize the changes made by this PR.

  • Improvements & Bug fixes
    • New line removal from OpenAI inputs is not required

Test plan

How are these changes tested?

  • Tests pass locally with pytest for python, yarn test for js, cargo test for rust

Documentation Changes

N/A

Copy link

vercel bot commented May 3, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
chroma ✅ Ready (Inspect) Visit Preview 💬 Add feedback May 3, 2024 1:34pm

Copy link
Contributor Author

tazarov commented May 3, 2024

This stack of pull requests is managed by Graphite. Learn more about stacking.

Join @tazarov and the rest of your teammates on Graphite Graphite

Copy link

github-actions bot commented May 3, 2024

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 (Readability, Modularity, Intuitiveness)

@atroyn
Copy link
Contributor

atroyn commented May 3, 2024

I agree that this is correct. However, this may impact people who already have collections using the old EF.

They would have to migrate, and we should let them know when we release this. Assigning myself here so that I remember to do this when this releases.

@atroyn atroyn self-assigned this May 3, 2024
@tazarov
Copy link
Contributor Author

tazarov commented May 3, 2024

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

@tazarov
Copy link
Contributor Author

tazarov commented May 3, 2024

Another minutiae from my investigation was that non-code first gen models (-001) need new line removal, but it feels that while available from API perspective are being silently phased out by OpenAI (couldn't find refs on the latest embeddings OAI docs).

@atroyn
Copy link
Contributor

atroyn commented May 3, 2024

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

Whether or not this makes retrieval accuracy worse, users may be relying on the embeddings themselves, e.g. for deduplication. We must notify them after this change.

@tazarov
Copy link
Contributor Author

tazarov commented May 4, 2024

I had similar realization that users' new queries will have slightly worse outcome for exact matches, but perhaps that would be marginal. I'll do a small test to prove myself wrong

Whether or not this makes retrieval accuracy worse, users may be relying on the embeddings themselves, e.g. for deduplication. We must notify them after this change.

Will it make sense to add a flag (constructor param) so that whoever needs/uses new line removals can do so going forward? But perhaps making an opt-in thing by default + the warning for the change.

@atroyn
Copy link
Contributor

atroyn commented May 6, 2024

I think we should just pull the trigger and not complicate the interface with cruft, while ensuring we communicate to users.

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.

[Bug]: Chroma v0.5.0 unnecessarily replaces newline characters with spaces before generating embeddings
2 participants