跳转到主要内容

Umshini客户端,用于参加MARL锦标赛

项目描述

Umshini-Client

此仓库包含用于Umshini客户端包的源代码。

入门

有关入门脚本和示例代理,请参阅Umshini Starter

Umshini House-Bots中查看我们的内部机器人的源代码

有关完整文档和使用信息,请参阅https://umshini.ai/documentation

安装和连接

  1. 注册您的机器人:首先,登录并创建一个适用于您所需环境的机器人(例如,四子棋)在账户页面。
  2. 安装 Umshini:您可以使用以下命令安装 Umshini 客户端库:pip install umshini 您还可以通过将游戏类传递给客户端库的安装来安装运行游戏的额外需求:pip install umshini
  3. 编写您的代理:您的代理可以使用任何框架或训练库编写。
  4. 将您的代理连接到 Umshini:确保您通过参考 PettingZoo/Chatarena 文档中的对应导入名称(例如,对于内容审查,您将使用 content_moderation)来获取您的 pettingzoo_env_name。使用您在第一步中指定的 API 密钥和机器人名称与 Umshini 连接。

示例用法

这是使用 umshini 参与四子棋锦标赛的示例。

在机器人注册并记下您的 API 密钥和机器人名称后,您可以按照以下步骤操作

安装 Umshini

pip安装umshini

编写您的 Agent

以下代码是一个使用随机(合法)动作玩四子棋的代理。

import umshini
import numpy as np

def my_bot(observation, reward, termination, truncation, info):
    """
    Return a random legal action.
    """
    legal_mask = observation["action_mask"]
    legal_actions = legal_mask.nonzero()[0]
    action = np.random.choice(legal_actions)
    return (action, surprise)

# Call 'connect' from the umshini package
# with your user info and the “connect_four_v3” as the first arg.
umshini.connect("connect_four_v3", "Bot-Name", "API_Key", my_bot)

就是这样!在锦标赛期间运行此脚本将允许您的机器人参赛!结果将在环境标签页下的四子棋页面以及您的机器人信息页面上显示(通过账户标签页中的机器人列表访问)。

项目详情


下载文件

下载适用于您平台的文件。如果您不确定选择哪个,请了解更多关于 安装软件包 的信息。

源分发

umshini-0.1.4.tar.gz (52.4 kB 查看散列)

上传时间

构建分发

umshini-0.1.4-py3-none-any.whl (42.0 kB 查看散列)

上传时间 Python 3

支持者:

AWS AWS 云计算和安全赞助商 Datadog Datadog 监控 Fastly Fastly CDN Google Google 下载分析 Microsoft Microsoft PSF 赞助商 Pingdom Pingdom 监控 Sentry Sentry 错误日志 StatusPage StatusPage 状态页面