-
Notifications
You must be signed in to change notification settings - Fork 1.7k
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
Inconsistent documentation #2359
Comments
@stevhliu do you have a suggestion what would be the best naming to guide readers? |
I think the easiest solution would be to remove those four cards entirely since it no longer directly reflects the structure of the docs. What do you think? |
Hmm, I think it provides a certain consistency with the docs of other HF packages, so I don't mind keeping them. Personally, I prefer the navigation menu and/or search. I think the cards would be mainly for readers who are new to PEFT. |
Maybe instead of linking to general sections in the docs, we can use them to link to specific docs that would be helpful for new users (something like Quicktour, Configurations and models, LoRA methods, etc.)? |
System Info
Content of https://huggingface.co/docs/peft/index is not synchronised with ToC.
"How-to guides" is already "PEFT method guides".
"PEFT method guides" are under directory
task_guides
.Expected behavior
Consistent documentation.
Clear unambiguous names.
Links match titles and the content.
The text was updated successfully, but these errors were encountered: