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

Dev/tools documentations #12

Merged
merged 9 commits into from
Feb 5, 2025
Merged

Dev/tools documentations #12

merged 9 commits into from
Feb 5, 2025

Conversation

MAfarrag
Copy link
Member

@MAfarrag MAfarrag commented Feb 5, 2025

Description

Docs

  • add instructions to run ollama locally ollama.md

models

  • add more detailed parameters for the get_ollama_llm function for more control over the ollama model.

  • add LLMModel class as an abstraction layer to cover all llm models in the background.

  • Fixes #

Type of change

Check relevant points.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How Has This Been Tested?

  • tests/utils/test_models.py::TestGetOllamaLLM
  • tests/utils/test_models.py::TestLLMModel

Checklist:

  • updated version number in pyproject.toml.
  • updated environment.yml and the lock file.
  • added changes to change-log.md.
  • updated the latest version in README file.
  • I have added tests that prove my fix is effective or that my feature works.
  • New and existing unit tests pass locally with my changes.
  • documentation are updated.

@MAfarrag MAfarrag merged commit eabbfcb into main Feb 5, 2025
8 checks passed
@MAfarrag MAfarrag deleted the dev/tools-documentations branch February 5, 2025 21:25
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.

1 participant