neomatrix369 / learning-path-index

A repo with data files, assets and code supporting and powering the Learning Path Index Project
MIT License
15 stars 16 forks source link

fix: Update llm-variant-01 docs with Ollama setup and serve commands #76

Open TobeTek opened 1 month ago

TobeTek commented 1 month ago

Summary by Sourcery

Enhance the documentation with setup instructions for the Ollama server and refactor the lpiGPT.py script for better readability and maintainability.

Enhancements:

Documentation:

sourcery-ai[bot] commented 1 month ago

Reviewer's Guide by Sourcery

This pull request updates the documentation and code for the llm-variant-01 project, focusing on improving the setup process for Ollama and enhancing code readability. The changes include adding instructions for Ollama setup and serve commands, reorganizing imports, and applying code formatting improvements.

File-Level Changes

Change Details Files
Added Ollama setup and serve instructions to the README
  • Added a reference to the Ollama repository for installation instructions
  • Included a command to start the Ollama server
app/llm-poc-variant-01/README.md
Improved code organization and readability in the main Python script
  • Reorganized and sorted imports
  • Applied consistent code formatting
  • Improved string formatting and multiline string declarations
  • Enhanced readability of conditional statements
app/llm-poc-variant-01/lpiGPT.py
Refactored argument parsing for better clarity
  • Split long lines in argument definitions
  • Improved help text formatting for better readability
app/llm-poc-variant-01/lpiGPT.py

Tips - Trigger a new Sourcery review by commenting `@sourcery-ai review` on the pull request. - Continue your discussion with Sourcery by replying directly to review comments. - You can change your review settings at any time by accessing your [dashboard](https://app.sourcery.ai): - Enable or disable the Sourcery-generated pull request summary or reviewer's guide; - Change the review language; - You can always [contact us](mailto:support@sourcery.ai) if you have any questions or feedback.
neomatrix369 commented 1 week ago

@TobeTek have you tried to apply suggestions from @sourcery above? its a good idea to do few of the things, once we do these I can merge this PR for you