Add "generated_from_trainer" tag to auto-generated model cards #2710
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
osanseviero
reviewed
Jun 4, 2024
sentence_transformers/model_card.py
Outdated
| @@ -283,6 +283,7 @@ class SentenceTransformerModelCardData(CardData): | |||
| "sentence-transformers", | |||
| "sentence-similarity", | |||
| "feature-extraction", | |||
| "generated_from_trainer", | |||
There was a problem hiding this comment.
I think this one should be part of the SentenceTransformerTrainer rather than default model card (or have a check here so it's only added if it's being used with the trainer
There was a problem hiding this comment.
The model card is only generated if:
- the SentenceTransformerTrainer has been initialized with this model, or
- the loaded model wasn't a Sentence Transformer model
Otherwise, the original model card gets reused. E.g. if you load and save/upload BAAI/bge-base-en-v1.5 without training then it'll reuse that model card.
So, we would only get generated_with_trainer "wrongly" if someone loads a non-Sentence Transformer model, doesn't train it, and then uploads it. That said, I think this is really easy to fix, so I'll change it.
There was a problem hiding this comment.
Resolved this via 10d70ff
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello!
Pull Request overview
Details
This allows us to more easily track models and allows others to easily check out other models trained with ST v3.0.0.
cc @osanseviero