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

Allow extraction of revision id from model #2601

Open
KennethEnevoldsen opened this issue Apr 17, 2024 · 2 comments · Fixed by #2449
Open

Allow extraction of revision id from model #2601

KennethEnevoldsen opened this issue Apr 17, 2024 · 2 comments · Fixed by #2449
Labels
enhancement New feature or request

Comments

@KennethEnevoldsen
Copy link

Hi over at MTEB, we would love to make our results more reproducible. One way to do that is to know which model was used to produce a given result (revision id and all).

Would it be possible to make this information accessible from the SentenceTransformers object?

@tomaarsen tomaarsen added the enhancement New feature or request label Apr 18, 2024
@tomaarsen
Copy link
Collaborator

Hello!

My understanding is that this should be possible without introducing any additional overhead, as the hf_hub_download helper method caches files based on the repository revision. The repository ID could also be saved when it is successfully used to load a model.
I think it could make sense to incorporate this with #2449, which introduces model_card_data to store some information about the model (which is intended to be used in the model card generation). This already stores base_model, but I can convert that into base_model_id and base_model_revision. Do note that these would be None when loading a local model.

How does that sound?

  • Tom Aarsen

@KennethEnevoldsen
Copy link
Author

Sounds great, exactly something like that I am looking for!

@tomaarsen tomaarsen linked a pull request Apr 19, 2024 that will close this issue
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants