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

DOC: List of TODOs for the documentation #1089

Closed
10 tasks done
BenjaminBossan opened this issue Nov 7, 2023 · 8 comments
Closed
10 tasks done

DOC: List of TODOs for the documentation #1089

BenjaminBossan opened this issue Nov 7, 2023 · 8 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed

Comments

@BenjaminBossan
Copy link
Member

BenjaminBossan commented Nov 7, 2023

Feature request

This issue serves to list areas in which the documentation can be improved. It can be extended in the future if we find more gaps.

Contributions are welcome, if you want to pick up one of the open topics, let us know beforehand so that we can avoid duplicate work.

Motivation

Better docs, happier users.

Your contribution

Possible.

@BenjaminBossan BenjaminBossan added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed labels Nov 7, 2023
@aldakata
Copy link

Wouldn't this PR in /transformers close Quantization docs issue?

@BenjaminBossan
Copy link
Member Author

Thanks for the pointer. I think it would be good to link there, but I'd also like to see a PEFT-specific section on quantization in the PEFT docs.

@dame-cell
Copy link

dame-cell commented Dec 2, 2023

Hi,

I'm interested in contributing to the project and would like to write documentations but only for quantization for now.

I've outlined an initial structure for the documentation, covering topics such as:

  • Introduction to Quantization
  • Benefits of Quantization
  • How to Use Quantization in the Project
  • Supported Tuners for Quantization
  • Examples and Best Practices

I'd love to get your thoughts on this, and if there are specific guidelines or preferences for documentation, please let me know. I'm looking forward to working with the community to enhance the project's documentation.

@BenjaminBossan
Copy link
Member Author

Thanks @dame-cell for offering your help. I think when it comes to your points 1 & 2, we can keep it short and reference existing sources on that, as those are not PEFT-specific. Apart from that, your suggestion looks good.

@dame-cell
Copy link

hey @BenjaminBossan just got done writing it , I've just submitted a pull request hopefully that's enough if you need more please tell me , I'll make sure to make it better

@younesbelkada
Copy link
Contributor

@BenjaminBossan seems everything has been addressed, what about closing the issue?

@BenjaminBossan
Copy link
Member Author

BenjaminBossan commented Dec 18, 2023

I'd still like to add (or have contributions for) LoHa, LoKr, OFT in the conceptual guides. Edit: See #1269.

@BenjaminBossan
Copy link
Member Author

Done. Thanks so much to everyone involved, especially @stevhliu.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants