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.

Sign up for GitHub

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

Jump to bottom

[docs] API docs #1196

Merged
merged 10 commits into from
Dec 4, 2023
Merged

[docs] API docs #1196

merged 10 commits into from
Dec 4, 2023

Conversation

stevhliu
Copy link
Member

Expands and reorganizes the API docs to include other supported adapter methods, the BaseTuner class, and Lycoris classes.

@HuggingFaceDocBuilderDev
Copy link

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint.

BenjaminBossan
BenjaminBossan requested changes Nov 30, 2023
View reviewed changes
Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot Steven for extending the API docs and even writing a short summary for all methods. Apart from a typo, this LGTM.

I think we should also go through the code and add docstring for a couple of important methods. I'll try to do that today.

docs/source/package_reference/llama_adapter.md Outdated Show resolved Hide resolved
@BenjaminBossan
Copy link
Member

One more thing I noticed, there is an "UNDEFINED" section in the docs:

image

BenjaminBossan
BenjaminBossan approved these changes Dec 1, 2023
View reviewed changes
Copy link
Member

@BenjaminBossan BenjaminBossan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot, LGTM.

@stevhliu stevhliu marked this pull request as ready for review December 4, 2023 19:42
@stevhliu stevhliu merged commit 9c70468 into huggingface:main Dec 4, 2023
14 checks passed
@stevhliu stevhliu deleted the api-docs branch December 4, 2023 19:45
TaoSunVoyage pushed a commit to TaoSunVoyage/peft that referenced this pull request Dec 14, 2023
@stevhliu @TaoSunVoyage
[docs] API docs (huggingface#1196)
e4209b2 
* first draft

* fix path

* fix all paths

* typo

* last typo 🤞

* fix toctree

* typo

* fix section title

* feedback

* update
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@BenjaminBossan BenjaminBossan BenjaminBossan approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@stevhliu @HuggingFaceDocBuilderDev @BenjaminBossan