Skip to main content

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

Project description

augllm

English README is here

augllm は、Ollama を用いた拡張型(Augmented)大規模言語モデル(LLM)操作のためのラッパーライブラリです。
Function Calling による外部ツール利用のためのインターフェースを提供します。
ただし、ツール本体の実装は含まず、利用者が必要に応じて外部実装を組み込む形を想定しています。

リポジトリ:
https://github.com/ToPo‑ToPo‑ToPo/augllm

目次

  1. 特長 / 概要
  2. 前提条件
  3. インストール方法
  4. 使い方
    • サンプルプログラム
    • Function Calling との連携
  5. ライセンス

1. 特長 / 概要

  • Ollama を通じて LLM(ローカルまたはクラウド上)とやり取り
  • Function Calling(関数呼び出し)形式でのツール連携をサポート
  • ツールは抽象インターフェースとして定義されており、具体的な実装(API 呼び出し、ローカルスクリプト実行など)はユーザーが自由に実装可能
  • 拡張性重視:カスタムツール、チェーン処理、プロンプト設計などへの組み込み容易

2. 前提条件

  • Python 3.8 以上
  • Ollama コマンドラインや API クライアントが動作可能な環境

3. インストール方法

  1. 仮想環境の作成と起動

以下を実行し、仮想環境を作成します。

python -m venv env

仮想環境を起動します。Macの場合は以下を実行します。

source env/bin/activate
  1. ライブラリのインストール
pip install .

4. 使い方

サンプルプログラム

リポジトリ内に test/ ディレクトリがあります。中の2つのファイルを参考にしてください。

Function Calling との連携

  1. プロンプト内で、ツール呼び出しを期待する関数署名を与える
  2. モデルから返ってきた関数呼び出し要求(ツール名 + 引数)を受け取り
  3. 対応ツールインターフェースの run(...) を呼び出し、結果を受け取り
  4. 結果をモデルに返して最終応答を得る

5. ライセンス

このプロジェクトは Apache‑2.0 ライセンス のもとで公開されています。 詳細は、LICENSEファイルを確認してください。

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.0.tar.gz (19.1 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.0-py3-none-any.whl (21.7 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for augllm-1.0.tar.gz
Algorithm Hash digest
SHA256 c399f5129024ec0156358b59cfc818f546e19ad7b842cb0b1039c699d289c6fd
MD5 7e0d1fb385339ab59335ff5f3870f274
BLAKE2b-256 9665633b3005a957bcd0ed9415071d57eaee973952aa854c841cf020b3c93f60

See more details on using hashes here.

File details

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

File metadata

  • Download URL: augllm-1.0-py3-none-any.whl
  • Upload date:
  • Size: 21.7 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fdd2758c9ff7dfd789d464b9c95cd03b762c0fe7eafda14f6a8c840f0b1a7390
MD5 0c26befd9481d1af1e5130daf3f7bbff
BLAKE2b-256 b2c7941ad0df01138f6a623468a077859a6bce62ceb9989e3e8e20e0cff5f32b

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