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

Add docs and examples for X-LoRA #1970

Merged
merged 9 commits into from
Aug 2, 2024

Conversation

EricLBuehler
Copy link
Member

@EricLBuehler EricLBuehler commented Jul 29, 2024

Adds docs for X-LoRA as well as examples:

  • Add docs
    • Package reference
    • Conceptual guide
    • Task guide
    • Developer guide
  • Add examples
    • Training example
    • Inference example

@HuggingFaceDocBuilderDev

The docs for this PR live here. All of your documentation changes will be reflected on that endpoint. The docs are available until 30 days after the last update.

@BenjaminBossan
Copy link
Member

Looks good so far: https://moon-ci-docs.huggingface.co/docs/peft/pr_1970/en/package_reference/xlora

Btw. did you join HF?

@EricLBuehler
Copy link
Member Author

@BenjaminBossan
Copy link
Member

Btw. did you join HF?

Yes!

Ha, very nice! Didn't see any announcement yet. Welcome on board.

More docs:

Nice. LMK when this is ready for review (won't have time today but will check tomorrow).

@EricLBuehler
Copy link
Member Author

Hi @BenjaminBossan! I think this should be ready for a review of the docs. I haven't added training examples yet, but I added one for mistralrs - do you think that's good or should we just add a link?

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 for the detailed docs. There isn't much to add from my side, just a few smaller comments.

I think it would still be great to have a training example to accompany the mistralrs inference example.

docs/source/package_reference/xlora.md Outdated Show resolved Hide resolved
examples/xlora_inference/xlora_inference_mistralrs.py Outdated Show resolved Hide resolved
examples/xlora_inference/xlora_inference_mistralrs.py Outdated Show resolved Hide resolved
EricLBuehler and others added 4 commits August 1, 2024 06:26
Co-authored-by: Benjamin Bossan <BenjaminBossan@users.noreply.github.com>
@BenjaminBossan
Copy link
Member

Please always ping me when the PR is ready for review.

@EricLBuehler
Copy link
Member Author

@BenjaminBossan it should be ready now!

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 for providing the documentation for X-LoRA. LGTM.

@BenjaminBossan BenjaminBossan merged commit f514283 into huggingface:main Aug 2, 2024
14 checks passed
@EricLBuehler EricLBuehler deleted the xlora_docs branch August 2, 2024 10:43
@EricLBuehler
Copy link
Member Author

Thanks! I'll add the training example in a later PR.

@cyx96
Copy link

cyx96 commented Dec 12, 2024

May I ask when will the training example be published?

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.

4 participants