Skip to main content

[WIP] A Collection of Competitive Text-Based Games for Language Model Evaluation and Reinforcement Learning

Project description

PyPI version Discord Website

TextArena  

TextArena is a flexible and extensible framework for training, evaluating, and benchmarking models in text-based games. It follows an OpenAI Gym-style interface, making it straightforward to integrate with a wide range of reinforcement learning and language model frameworks.


Example

Installation

Install TextArena directly from PyPI:

pip install textarena

Install enchant on ubuntu:

apt install enchant2

Play Offline

import textarena as ta

# Initialize agents
agents = {
    0: ta.agents.OpenRouterAgent(model_name="GPT-4o-mini"),
    1: ta.agents.OpenRouterAgent(model_name="anthropic/claude-3.5-haiku"),
}

# Initialize environment from subset and wrap it
env = ta.make(env_id="BalancedSubset-v0")
env = ta.wrappers.LLMObservationWrapper(env=env)
env = ta.wrappers.SimpleRenderWrapper(
    env=env,
    player_names={0: "GPT-4o-mini", 1: "claude-3.5-haiku"},
)

env.reset()
done = False
while not done:
    player_id, observation = env.get_observation()
    action = agents[player_id](observation)
    done, info = env.step(action=action)
rewards = env.close()

Implementation Status

Single-Player Games

Game Name Offline Play Online Play Documentation
CarPuzzle
Chess
ConnectFour
Crosswords link
FifteenPuzzle link
GuessTheNumber link
GuessWho link
Hangman link
LogicPuzzle link
MathProof
Minesweeper link
Sudoku link
TowerOfHanoi link
TwentyQuestions link
WordLadder link
WordSearch link

Two-Player Games

Game Name Offline Play Online Play Documentation
Battleship link
Brass
CarPuzzle
Chess link
ConnectFour link
Debate link
DontSayIt link
IteratedPrisonersDilemma link
Jaipur
LetterAuction
LiarsDice link
Mastermind link
MathProof
MemoryGame
Negotiation link
Poker link
ScenarioPlanning
SpellingBee link
SpiteAndMalice link
Stratego link
Taboo
Tak link
UltimateTicTacToe link
TruthAndDeception link
WordChains link

Multi-Player Games

Game Name Offline Play Players Online Play Documentation
Diplomacy 3+
7 Wonders 3+
Bohnanza 3+
Codenames 4+
Negotiation 3+
Poker 3+
Risk 3+
SettlersOfCatan 3-4
TerraformingMars 1-5
Werewolf 5+

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

textarena-0.4.8.tar.gz (211.0 kB view details)

Uploaded Source

Built Distribution

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

TextArena-0.4.8-py3-none-any.whl (253.0 kB view details)

Uploaded Python 3

File details

Details for the file textarena-0.4.8.tar.gz.

File metadata

  • Download URL: textarena-0.4.8.tar.gz
  • Upload date:
  • Size: 211.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for textarena-0.4.8.tar.gz
Algorithm Hash digest
SHA256 6184fd6cfd0e0d06e3448ece10399b7f568f5e1a7cdddac1feed68f9ca9b8753
MD5 5b3079df7b56166b068373343b3fd30f
BLAKE2b-256 64ae35c159b3b5643bb1936185d677e458c1941d71c87b38d6c248b9ff99c3d3

See more details on using hashes here.

File details

Details for the file TextArena-0.4.8-py3-none-any.whl.

File metadata

  • Download URL: TextArena-0.4.8-py3-none-any.whl
  • Upload date:
  • Size: 253.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.10.12

File hashes

Hashes for TextArena-0.4.8-py3-none-any.whl
Algorithm Hash digest
SHA256 91ce0c188d75f94b8434b5626bb07724a777800d45dd37c07502c0bb992449e9
MD5 977d63dcb16e6f7ee87260441c6b0aea
BLAKE2b-256 aedc04588446efc3a64674a03e0b7f206967e894d896b9d8d6a6703a5ef626e6

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