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

Added doc for importing private model. #2360

Closed
wants to merge 1 commit into from

Conversation

saskiabosma
Copy link
Contributor

Follow up to the discussion on issue-2336: adding details on how to import a local private model following HuggingFace base models/architecture but not hosted remotely on HuggingFace.

@saskiabosma
Copy link
Contributor Author

@tomaarsen here's the PR !

@tomaarsen tomaarsen added the documentation Improvements or additions to documentation label Dec 7, 2023
@tomaarsen
Copy link
Collaborator

Hello!

I did some more digging around this PR & #2336, and I think the documentation should mention the (recommended) code-only procedure for converting a non-Sentence Transformer CLIP model to Sentence Transformers. Like always in Sentence Transformers, the model name can also just be a path to a local model. I've implemented this in #2369. I think this is more intuitive & useful for users than this PR. What do you think?

  • Tom Aarsen

@saskiabosma
Copy link
Contributor Author

Hi ! I think your version is cleaner but I'd replace from the Hugging Face Hub by from the Hugging Face Hub or a local path to make clear the fact that the model doesn't need to be hosted remotely on HuggingFace (in case of private fine tuned models for example) and just needs to follow the HuggingFace structure.

@tomaarsen
Copy link
Collaborator

@saskiabosma That's a great idea! I've added it in my PR here & mentioned you as a co-author of the commit.
I'll close this one, and merge that one! Thanks for all the help.

@tomaarsen tomaarsen closed this Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants