docs: add docstrings to ChatFormat class and its constructor#379
docs: add docstrings to ChatFormat class and its constructor#379mshsheikh wants to merge 1 commit intometa-llama:mainfrom
Conversation
Added clear, PEP-compliant docstrings to the ChatFormat class and its __init__ method in chat_format.py. These docstrings explain the purpose of the class (encoding/decoding chat messages with optional vision support), describe constructor arguments (tokenizer, vision_args, max_num_chunks), and outline return values where applicable. This documentation improves code readability and helps future maintainers understand the design intent without altering any existing logic.
mshsheikh
requested review from
ashwinb,
dltn,
ehhuang,
hardikjshah,
raghotham and
yanxi0830
as code owners
|
Hi @mshsheikh! Thank you for your pull request and welcome to our community. Action RequiredIn order to merge any pull request (code, docs, etc.), we require contributors to sign our Contributor License Agreement, and we don't seem to have one on file for you. ProcessIn order for us to review and merge your suggested changes, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA. Once the CLA is signed, our tooling will perform checks and validations. Afterwards, the pull request will be tagged with If you have received this in error or have any questions, please contact us at cla@meta.com. Thanks! |
2 participants
Added clear, PEP-compliant docstrings to the ChatFormat class and its init method in chat_format.py.
These docstrings explain the purpose of the class (encoding/decoding chat messages with optional vision support), describe constructor arguments (tokenizer, vision_args, max_num_chunks), and outline return values where applicable.
This documentation improves code readability and helps future maintainers understand the design intent without altering any existing logic.