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

Added LMFormatEnforcer integration #65

Merged
merged 6 commits into from
Nov 10, 2023

Conversation

noamgat
Copy link
Contributor

@noamgat noamgat commented Nov 9, 2023

Following the discussion on the main haystack repo : deepset-ai/haystack#6222

This PR adds the LMFormatEnforcer integration.

Note: The pypi link is to the main repository, not a dedicated haystack integration one. LMFormatEnforcer is a relatively small library, and all of the integrations are lazily loaded and are not part of the project's dependencies. Therefore there is no "extra baggage" by just pointing to the library itself.

Copy link
Member

@TuanaCelik TuanaCelik left a comment

Choose a reason for hiding this comment

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

Linking to the main repo that's not only a haystack integration is totally fine. If you like, you can make the repo link go to the file where the custom component is implemented.

A couple of notes:
You could add version: Haystack 2.0 into your frontmatter which will generate the 'Haytsack 2.0' badge on the website for you.

I will suggest some edits on certainl lines here too. Other than that, all looks good! I will maybe change the size of the image but we can see how this one looks once we merge it first.

integrations/lmformatenforcer.md Outdated Show resolved Hide resolved
integrations/lmformatenforcer.md Outdated Show resolved Hide resolved
integrations/lmformatenforcer.md Outdated Show resolved Hide resolved
integrations/lmformatenforcer.md Outdated Show resolved Hide resolved
integrations/lmformatenforcer.md Outdated Show resolved Hide resolved
@noamgat
Copy link
Contributor Author

noamgat commented Nov 9, 2023

Edited based on all of your comments.
About the logo - maybe it's time I actually make one :)

@noamgat
Copy link
Contributor Author

noamgat commented Nov 9, 2023

OK, Added a logo. I think we're ready

@TuanaCelik
Copy link
Member

@noamgat LGTM, I'm sorry I didn't spot this the first round, but if possible at the very top I think it would be useful to have a short description on why this component is useful and why to use it. Something like the intro paragraph on your own repo. I think it would be useful for people who don't know about why format enforcing matrers. Once that's done, I will merge this and it will go live 🚀

Thanks for the contribution!

@noamgat
Copy link
Contributor Author

noamgat commented Nov 10, 2023

No problem, done!

@TuanaCelik TuanaCelik merged commit 2a4e92f into deepset-ai:main Nov 10, 2023
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

2 participants