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

docs: update inference API examples for reranker model #1541

Merged
merged 2 commits into from
Dec 26, 2024

Conversation

Muhtasham
Copy link
Contributor

@Muhtasham Muhtasham commented Dec 20, 2024

  • Update code examples to show correct input format for reranker
  • Add examples for text/text_pair format
  • Include multiple input pairs to demonstrate batch processing
  • Update curl, Python and JavaScript examples consistently

- Update code examples to show correct input format for reranker
- Add examples for text/text_pair format required by mxbai-rerank-base-v1
- Include multiple input pairs to demonstrate batch processing
- Update curl, Python and JavaScript examples consistently
Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

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

Thanks for the update! @tomaarsen would you like to give it a look too please! 🙏

Copy link
Member

@tomaarsen tomaarsen left a comment

Choose a reason for hiding this comment

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

I'm not sure we should remove the mention of https://huggingface.co/docs/huggingface_hub/package_reference/inference_client#huggingface_hub.InferenceClient.text_classification, but otherwise I'm very much in favor of 1) the new model choice and 2) updated inputs.

@Muhtasham Muhtasham requested a review from Vaibhavs10 December 25, 2024 22:45
Copy link
Member

@Vaibhavs10 Vaibhavs10 left a comment

Choose a reason for hiding this comment

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

Thanks for iterating here @Muhtasham 🤗

@Vaibhavs10 Vaibhavs10 merged commit 9fe4b36 into huggingface:main Dec 26, 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