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

Inconsistent documentation #2359

Open
makelinux opened this issue Feb 4, 2025 · 4 comments
Open

Inconsistent documentation #2359

makelinux opened this issue Feb 4, 2025 · 4 comments

Comments

@makelinux
Copy link
Contributor

makelinux commented Feb 4, 2025

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.

Image

Expected behavior

Consistent documentation.
Clear unambiguous names.
Links match titles and the content.

@BenjaminBossan
Copy link
Member

@stevhliu do you have a suggestion what would be the best naming to guide readers?

@stevhliu
Copy link
Member

stevhliu commented Feb 4, 2025

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?

@BenjaminBossan
Copy link
Member

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.

@stevhliu
Copy link
Member

stevhliu commented Feb 5, 2025

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.)?

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

No branches or pull requests

3 participants