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.

Since it is registered on PyPI, you can install it with pip install. 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.1.tar.gz (19.7 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.1-py3-none-any.whl (22.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for augllm-1.1.tar.gz
Algorithm Hash digest
SHA256 cc6787b7e2bf289eb42248b6b4530395272037bcf0f3c0038817bc8c4ae05d5f
MD5 045c937d5fe8e07c2ea6baab2b358a64
BLAKE2b-256 b6381ba6846561e1313c189ae9d9de89af6de977683e80ebcee5f223847804d4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: augllm-1.1-py3-none-any.whl
  • Upload date:
  • Size: 22.1 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.1-py3-none-any.whl
Algorithm Hash digest
SHA256 df39dde628e841f8328880d7a377e134ed289325e13f4be10e9a576d80708d42
MD5 8d280c7a6b66ffd13d68863db58a005d
BLAKE2b-256 9863d40bcc534053f386f818154ddefd5c5f3a57471ddfe06812bc72e8a547e0

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