Mortal

Mortal（凡夫）是一款基于深度强化学习的免费开源日本麻将人工智能系统。

有关该项目的所有信息，请阅读文档。

好吧，现在把权重给我！

有关此主题的详细信息，请参阅这篇帖子。

许可证

代码

版权所有 © 2021–2022 Equim

本程序为自由软件：您可以按照自由软件基金会发布的 GNU Affero 通用公共许可证的条款重新分发和修改它，无论是该许可证的第 3 版，还是（由您选择）任何后续版本。

本程序以“希望它有用”的态度发布，但不提供任何担保；甚至不包括对适销性或特定用途适用性的默示担保。有关更多详情，请参阅 GNU Affero 通用公共许可证。

您应随本程序收到一份 GNU Affero 通用公共许可证的副本。如果没有，请访问 https://www.gnu.org/licenses/ 查看。

标志及其他资源

Mortal 快速上手指南

Mortal 是一个基于深度强化学习的开源日本麻将（日麻）AI 引擎。本指南将帮助你快速在本地环境中部署并运行该工具。

环境准备

在开始之前，请确保你的开发环境满足以下要求：

• 操作系统：Linux (推荐), macOS, 或 Windows (需配置 WSL2 以获得最佳兼容性)。
• 编程语言：Rust (最新稳定版)。
  • 安装命令：curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
• 构建工具：cargo (随 Rust 一起安装)。
• 依赖项：
  • git：用于克隆代码库。
  • cmake 和 build-essential (Linux) 或 Xcode Command Line Tools (macOS)：用于编译底层依赖。
  • Python 3.x (可选，仅当你需要运行训练脚本或使用特定辅助工具时)。

提示：国内用户若遇到 Rust 安装包下载缓慢，可使用国内镜像源： export RUSTUP_DIST_SERVER=https://mirrors.ustc.edu.cn/rust-static export RUSTUP_UPDATE_ROOT=https://mirrors.ustc.edu.cn/rust-static/rustup

安装步骤

1. 克隆项目仓库

使用 git 将 Mortal 源代码拉取到本地：

git clone https://github.com/Equim-chan/Mortal.git
cd Mortal

2. 编译项目

Mortal 主要使用 Rust 编写，使用 cargo 进行发布模式编译以获得最佳性能：

cargo build --release

注：首次编译可能需要较长时间，请耐心等待。

3. 获取模型权重

Mortal 的核心能力依赖于预训练的深度学习模型权重文件。由于版权和分发策略，权重文件不包含在代码库中。

请访问作者发布的专门说明文档获取权重文件及放置路径： 👉 获取权重文件指南 (GitHub Gist)

通常需要将下载的权重文件（如 .bin 或 .onnx 格式）放置在项目指定的目录中（例如 weights/ 或运行时参数指定的路径）。

基本使用

编译完成并准备好权重文件后，你可以通过命令行调用 Mortal。以下是典型的运行方式（具体参数取决于你使用的子命令，如对战、分析或自我对弈）：

运行示例

假设你已经将权重文件配置妥当，运行一个简单的自我对弈或测试命令（具体命令参数请参考官方文档或 --help）：

# 查看可用命令和参数帮助
./target/release/mortal --help

# 示例：运行一个基于当前权重的评估或对战进程
# 注意：具体的子命令（如 play, eval, train）需根据实际二进制文件暴露的接口调整
./target/release/mortal play --config config.toml

重要提示：Mortal 的功能高度依赖于配置文件和权重文件的正确路径。请务必阅读 官方文档 以了解详细的配置项（如 config.toml 的编写）以及不同模式下的具体命令行参数。

下一步

• 查阅 Documentation 了解高级功能、训练流程和 API 细节。
• 遵循 AGPL-3.0 协议使用代码。