chatarena下載 - chatarena源代碼下載

chatarena

其他源碼

v0.1.18

下載

LLMS的多代理語言遊戲環境

Chatarena是一個提供多代理語言遊戲環境的圖書館，並促進了有關自主LLM代理商及其社交互動的研究。它提供以下功能：

抽象：它提供了一個靈活的框架來根據馬爾可夫決策過程來定義多個玩家，環境及其之間的交互。
語言遊戲環境：它提供了一組可以幫助理解，基準測試或培訓代理LLM的環境。
用戶友好的接口：它提供Web UI和CLI，以開發/提示您的LLM代理在環境中行動。

Chatarena架構

入門

嘗試我們的在線演示：

安裝

要求：

python> = 3。7
OpenAI API鍵（可選，用於使用GPT-3.5-Turbo或GPT-4作為LLM代理）

使用PIP安裝：

pip install chatarena

或從來源安裝：

pip install git+https://github.com/chatarena/chatarena

要使用GPT-3作為LLM代理，請設置OpenAI API密鑰：

 export OPENAI_API_KEY= " your_api_key_here "

可選依賴性

默認情況下pip install chatarena Chatarena核心功能所需的依賴項。您可以使用以下命令安裝可選依賴項：

pip install chatarena[all_backends] # install dependencies for all supported backends: anthropic, cohere, huggingface, etc.
pip install chatarena[all_envs]     # install dependencies for all environments, such as pettingzoo
pip install chatarena[all]          # install all optional dependencies for full functionality

本地啟動演示

看到Chatarena的最快方法是通過演示Web UI。要在本地計算機上啟動演示，您首先要使用額外的gradio依賴性安裝chatarena，然後將此存儲庫克隆到您的本地文件夾，最後在存儲庫的根目錄中調用app.py ：

pip install chatarena[gradio]
git clone https://github.com/chatarena/chatarena.git
cd chatarena
gradio app.py

這將啟動用於Chatarena的演示服務器，您可以從瀏覽器（端口8080）訪問它。

查看此視頻以了解如何使用Web UI：

對於開發人員

有關Chatarena框架的介紹，請參閱此文檔。要進行構建新環境的演練，請檢查

在這裡，我們提供了最小設置的緊湊指南，以運行遊戲和一些有關自定義的一般建議。

關鍵概念

競技場：競技場封裝了環境和一系列玩家。它驅動遊戲的主要循環，並提供HCI實用程序，例如WebUI，CLI，配置加載和數據存儲。
環境：環境存儲遊戲狀態並執行遊戲邏輯以在遊戲狀態之間進行過渡。它還為玩家提供了觀察，觀察結果是自然語言。
1. 遊戲狀態對玩家不直接可見。玩家只能看到觀察結果。
語言後端：語言後端是語言智能的來源。它將文本（或文本收集）作為輸入，並返迴響應中的文本。
玩家：玩家是玩遊戲的代理商。在RL術語中，這是一個策略，是從觀察到動作的無狀態函數映射。

與Python API一起運行遊戲

來自配置文件的負載Arena - 在這裡，我們在此存儲庫中使用examples/nlp-classroom-3players.json作為示例：

 arena = Arena . from_config ( "examples/nlp-classroom-3players.json" )
arena . run ( num_steps = 10 )

在交互式CLI界面中運行遊戲：

 arena . launch_cli ()

查看此視頻以了解如何使用CLI：可以在此處找到有關如何使用Finer Grean Control運行主要互動循環的更詳細的指南

一般定制建議

競技場：覆蓋舞台基本上意味著人們將寫自己的主循環。這可以允許以更自動化的方式進行不同的互動接口或驅動遊戲，例如，運行在線RL培訓循環
環境：一個新的環境對應於新遊戲，可以在這裡使用硬編碼規則或規則和語言後端的混合來定義遊戲動力學。
後端：如果需要將格式化觀測（以消息）的方式更改為語言模型的查詢，則應覆蓋後端。
播放器：默認情況下，當餵食新的觀察結果時，玩家會查詢後端的語言，並將響應歸還為動作。但是，也可以自定義玩家與語言後端互動的方式。

創建您的自定義環境

您可以通過擴展Environment類來定義自己的環境。這是一般步驟：

通過從基類和設置type_name繼承ALL_ENVIRONMENTS定義類
通過定義__init__方法初始化類（其參數將定義相應的配置）並初始化類屬性
在方法step中實現遊戲機制
通過實現諸如reset ， get_observation ， is_terminal和get_rewards類的方法來處理遊戲狀態和獎勵
為使用CLI或Web UI的玩家開發角色說明提示（以及必要時的全局提示）並將其保存到配置文件中。

我們提供了一個詳細的教程，以使用Chameleon環境為例，演示如何定義自定義環境。

如果您想將現有庫的環境移植到Chatarena，請查看PettingzooChess環境。

環境列表

對話

模擬對話的多玩家語言遊戲環境。

NLP教室：模擬教室設置的3個玩家語言遊戲環境。遊戲輪流玩，每個轉彎都可以問一個問題或回答問題。當所有玩家都問並回答所有問題時，遊戲結束了。

主持人對話

基於對話，但使用主持人控制遊戲動力學。

岩紙剪輯器：一個2播放器的語言遊戲環境，通過主持人對話模擬岩石剪輯遊戲。兩位球員都將並行行動，當一個玩家贏得2輪時，比賽結束。
TIC-TAC-TOE：一個2播放器語言遊戲環境，通過主持人對話模擬TIC-TAC-TOE遊戲。遊戲輪流玩，玩家可以要求移動或進行動作。當一個玩家獲勝或板上滿是板時，遊戲結束。

變色龍

一個多玩家的社交扣除遊戲。遊戲中有兩個角色，Chameleon和Non-Chameleon。秘密單詞的主題將首先向所有玩家展示。然後，秘密單詞將被揭示給非chameleons。變色龍不知道秘密單詞。遊戲中的目標取決於玩家的角色：

如果您不是變色龍，那麼您的目標是在不暴露秘密單詞的情況下透露變色龍。
如果您是變色龍，那麼您的目標是與其他玩家融為一體，避免被抓住，並找出秘密單詞。遊戲中有三個階段：

給予線索階段：每個玩家都會描述有關秘密單詞的線索。
指控階段：在這個階段，每個球員將投票給最有可能是變色龍的球員。變色龍應投票支持其他球員。
猜測階段：如果指控是正確的，那麼鑑於其他玩家揭示的線索，變色龍應該猜測秘密單詞。

Pettingzoochess

使用Pettingzoo國際象棋環境的兩人國際象棋遊戲環境。

Pettingzoo Tictactoe

使用Pettingzoo Tictactoe環境的兩種玩家TIC-TAC-TOE遊戲環境。與Moderator Conversation環境不同，此環境是由硬編碼規則而不是LLM主持人驅動的。

貢獻

我們歡迎捐款改善和擴展Chatarena。請按照以下步驟進行貢獻：

分叉存儲庫。
為您的功能或BugFix創建一個新的分支。
將您的更改提交新分支。
創建一個描述您更改的拉請請求。
我們將查看您的拉請請求，並提供反饋或合併您的更改。

請確保您的代碼遵循現有樣式和結構。

引用

如果您發現Chatarena對您的研究有用，請引用我們的存儲庫（我們的Arxiv論文即將推出）：

 @software { ChatArena ,
  author = { Yuxiang Wu, Zhengyao Jiang, Akbir Khan, Yao Fu, Laura Ruis, Edward Grefenstette, and Tim Rocktäschel } ,
  title = { ChatArena: Multi-Agent Language Game Environments for Large Language Models } ,
  year = { 2023 } ,
  publisher = { GitHub } ,
  journal = { GitHub repository } ,
  version = { 0.1 } ,
  howpublished = { url{https://github.com/chatarena/chatarena} } ,
}