docs: add module docstrings to example scripts#639
Open
Pawansingh3889 wants to merge 1 commit intoollama:mainfrom
Open
docs: add module docstrings to example scripts#639Pawansingh3889 wants to merge 1 commit intoollama:mainfrom
Pawansingh3889 wants to merge 1 commit intoollama:mainfrom
Conversation
Adds descriptive docstrings to 8 example files explaining what each demonstrates, prerequisites (which model to pull), and how to run it. Files: chat.py, generate.py, embed.py, tools.py, structured-outputs.py, chat-stream.py, chat-with-history.py, multimodal-chat.py
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds module-level docstrings to 8 example scripts explaining what each demonstrates, prerequisites (which model to pull), and how to run it.
Currently none of the examples have docstrings, which means newcomers have to read through the code to understand what each file does.
Files Changed
Format
Each docstring follows the same structure:
Test Plan