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

Updated readme and models #305

Merged
merged 5 commits into from
Aug 8, 2024
Merged

Updated readme and models #305

merged 5 commits into from
Aug 8, 2024

Conversation

mskarlin
Copy link
Collaborator

@mskarlin mskarlin commented Aug 7, 2024

maspotts pointed out that our Readme is out of sync with the usage in our tests. (#304 )

This PR updates the readme to help make users aware of the correct Docs usage for custom embedding models. It also changes some of the default models to better OpenAI choices given the updates in the last few months.

Copy link
Collaborator

@jamesbraza jamesbraza left a comment

Choose a reason for hiding this comment

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

All your py snippets have trailing whitespace, can you remove it?

README.md Outdated Show resolved Hide resolved
README.md Outdated Show resolved Hide resolved
Copy link
Collaborator

@whitead whitead left a comment

Choose a reason for hiding this comment

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

Thanks!!!

.pre-commit-config.yaml Outdated Show resolved Hide resolved
.pre-commit-config.yaml Outdated Show resolved Hide resolved
mskarlin and others added 2 commits August 7, 2024 19:26
Co-authored-by: James Braza <jamesbraza@gmail.com>
Co-authored-by: James Braza <jamesbraza@gmail.com>
@mskarlin mskarlin merged commit 9fc10a7 into main Aug 8, 2024
1 check passed
@mskarlin mskarlin deleted the update-readme-and-models branch August 8, 2024 02:35
@whitead whitead mentioned this pull request Sep 11, 2024
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