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 README.md for Sentence transformer examples with HPU device #1355

Open
wants to merge 12 commits into
base: main
Choose a base branch
from

Conversation

ZhengHongming888
Copy link
Contributor

What does this PR do?

This PR will add one README.md for all sentence transformer HPU examples although they have each readme on how to run for each example. This README will give the whole pictures on all examples for sentence transformer with HPU device and their supported features/test configurations as below like :

image

Before submitting

  • This PR fixes a typo or improves the docs (you can dismiss the other checks if that's the case).
  • Did you make sure to update the documentation with your changes?
  • Did you write any new necessary tests?


We provide 3 examples to show how to use the sentence transformer with HPU devices.

- **[training_stsbenchmark.py](https://github.com/huggingface/optimum-habana/tree/main/examples/sentence-transformers-training/sts)** - This example shows how to create a SentenceTransformer model from scratch by using a pre-trained transformer model (e.g. [`distilbert-base-uncased`](https://huggingface.co/distilbert/distilbert-base-uncased)) together with a pooling layer.

Choose a reason for hiding this comment

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

*Sentence Transformers

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done!

examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
examples/sentence-transformers-training/README.md Outdated Show resolved Hide resolved
ZhengHongming888 and others added 8 commits September 24, 2024 13:42
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Co-authored-by: Harshvardhan Chauhan <hchauhan@habana.ai>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants