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] Custom model doc update #27213

Merged
merged 1 commit into from
Nov 3, 2023

Conversation

MKhalusova
Copy link
Contributor

This PR adds a documentation update to address the feedback left here, quote:

The clarity of the transformers documentation on custom models could be improved by describing 
the syntax of auto_map in config.json. We never used the register functions and would just directly 
modify the config.json. The behaviour that allowed one to use code on the Hub from another repo 
using "--" doesn't seem to be documented anywhere but we figured out that it was possible because 
save_pretrained saves in this format when using a custom model. The feature does seem to be pretty 
new though (I believe ~6 months ago?) so maybe that is why it hasn't been too well documented yet. 
But we think that if it was better communicated to users that it was possible to do this, more people 
would develop on the Hub as we did.

@HuggingFaceDocBuilderDev
Copy link

HuggingFaceDocBuilderDev commented Nov 1, 2023

The documentation is not available anymore as the PR was closed or merged.

Copy link
Collaborator

@amyeroberts amyeroberts 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 adding this!

@MKhalusova MKhalusova merged commit 011b15c into huggingface:main Nov 3, 2023
8 checks passed
EduardoPach pushed a commit to EduardoPach/transformers that referenced this pull request Nov 19, 2023
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