Skip to main content

('A library for augmenting large language models',)

Project description

augllm

augllm is a wrapper library for operating Augmented Large Language Models (LLMs) using Ollama.
It provides an interface for utilizing external tools via Function Calling.
Note that the actual implementations of the tools are not included—users are expected to integrate their own external implementations as needed.

Repository: https://github.com/ToPo-ToPo-ToPo/augllm


Table of Contents

  1. Features / Overview
  2. Requirements
  3. Installation
  4. Usage
    • Sample Programs
    • Integration with Function Calling
  5. License

1. Features / Overview

  • Interact with LLMs (either local or cloud-based) through Ollama
  • Support for tool integration using Function Calling
  • Tools are defined as abstract interfaces; concrete implementations (e.g., API calls, local script execution) can be freely developed by the user
  • Designed with extensibility in mind: easy integration with custom tools, chaining, and prompt engineering

2. Requirements

  • Python 3.11 or higher
  • An environment where Ollama CLI or API client is available

3. Installation

  1. Create and activate a virtual environment
python -m venv env

On macOS, activate the virtual environment:

source env/bin/activate
  1. Install the library
pip install augllm

4. Usage

Sample Programs

A test/ directory is included in the repository.
Please refer to the two files inside as examples.

Integration with Function Calling

  1. Provide function signatures in the prompt that represent expected tool calls
  2. Receive the function call request returned by the model (tool name + arguments)
  3. Invoke the corresponding tool interface’s run(...) method and obtain the result
  4. Pass the result back to the model to obtain the final response

5. License

This project is licensed under the Apache-2.0 License.
See the LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

augllm-1.3.tar.gz (21.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

augllm-1.3-py3-none-any.whl (26.2 kB view details)

Uploaded Python 3

File details

Details for the file augllm-1.3.tar.gz.

File metadata

  • Download URL: augllm-1.3.tar.gz
  • Upload date:
  • Size: 21.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for augllm-1.3.tar.gz
Algorithm Hash digest
SHA256 62ddf721a29213c2b375f78da565ffbe1bb70bd53f37769c0ff4fa0af8e17758
MD5 7ee0691559680ecc194f2c9a21a477ec
BLAKE2b-256 6b9f0323bbdcecc3592e667eabc2ff74a77c60025ba5c9b4889eb99da37a519e

See more details on using hashes here.

File details

Details for the file augllm-1.3-py3-none-any.whl.

File metadata

  • Download URL: augllm-1.3-py3-none-any.whl
  • Upload date:
  • Size: 26.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.7

File hashes

Hashes for augllm-1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b0156995dbe1b435ee2571d9fba9e7f0a6af3632a2de4173993cf375007ee50d
MD5 ecdf89767f17b33c924c16bb26a61e9c
BLAKE2b-256 fe51e38f394f61c802a15f099e3abe82ec5c16d512d5b6bad631411b111dc04b

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page