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 documentation for ClarifaiRM retriever module #1697

Merged
merged 5 commits into from
Oct 27, 2024

Conversation

sushmanthreddy
Copy link
Contributor

Hello team! I've added documentation for the ClarifaiRM module, following our existing docs style. This should help users get started with Clarifai integration in DSPy.

What's included:

  • Basic setup and configuration
  • Authentication details (since Clarifai needs this)
  • Core method documentation
  • Lots of examples covering common use cases
  • Error handling patterns (something I wish I had when first using it!)

The examples section is a bit longer than other RMs but I think it'll be really helpful for new users.

Would love your feedback, especially on:

  • Is the examples section too detailed? Happy to trim if needed
  • Did I miss any important use cases?
  • Does the auth setup section make sense?

@sushmanthreddy sushmanthreddy marked this pull request as draft October 26, 2024 08:35
@arnavsinghvi11
Copy link
Collaborator

Thanks @sushmanthreddy ! This is really helpful documentation!

I left some very minor edits and formatting touches and LGTM to merge when you're ready!

@sushmanthreddy sushmanthreddy marked this pull request as ready for review October 26, 2024 18:37
@sushmanthreddy
Copy link
Contributor Author

@arnavsinghvi11 can u pls review the pr ??

@arnavsinghvi11
Copy link
Collaborator

Thanks @sushmanthreddy . can we change the notes formatting to the one in this commit. Currently, it shows up as a block that requires people to scroll when we just want to display the full text. Thanks!

@sushmanthreddy
Copy link
Contributor Author

@arnavsinghvi11 is this fine now ??

@okhat okhat merged commit 4bc9866 into stanfordnlp:main Oct 27, 2024
6 checks passed
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