ReAgent 项目使用教程

ReAgent 项目使用教程

ReAgent A platform for Reasoning systems (Reinforcement Learning, Contextual Bandits, etc.) 项目地址: https://gitcode.com/gh_mirrors/rea/ReAgent

1. 项目的目录结构及介绍

ReAgent 项目的目录结构如下：

ReAgent/
├── circleci/
├── docs/
├── logo/
├── preprocessing/
├── reagent/
├── scripts/
├── serving/
├── .codecov.yml
├── .gitignore
├── .gitmodules
├── .isort.cfg
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── LICENSE
├── README.md
├── pyproject.toml
├── rasp_requirements.txt
├── setup.cfg
├── setup.py
└── tox.ini

目录介绍

• circleci/: 包含 CircleCI 配置文件，用于持续集成。
• docs/: 包含项目的文档文件。
• logo/: 包含项目的 Logo 文件。
• preprocessing/: 包含数据预处理的代码。
• reagent/: 核心代码目录，包含 Reinforcement Learning 和 Contextual Bandits 的实现。
• scripts/: 包含一些辅助脚本。
• serving/: 包含模型服务的代码。
• .codecov.yml: Codecov 配置文件，用于代码覆盖率测试。
• .gitignore: Git 忽略文件配置。
• .gitmodules: Git 子模块配置。
• .isort.cfg: isort 配置文件，用于代码格式化。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍文件。
• pyproject.toml: Python 项目配置文件。
• rasp_requirements.txt: 项目依赖文件。
• setup.cfg: 项目配置文件。
• setup.py: 项目安装脚本。
• tox.ini: tox 配置文件，用于自动化测试。

2. 项目的启动文件介绍

ReAgent 项目的启动文件主要集中在 reagent/ 目录下。以下是一些关键的启动文件：

• reagent/workflows/training.py: 该文件包含了训练模型的主要逻辑，是项目启动的核心文件之一。
• reagent/serving/serving.py: 该文件包含了模型服务的启动逻辑，用于部署训练好的模型。

启动步骤

1. 训练模型:

   python reagent/workflows/training.py
   

2. 启动服务:

   python reagent/serving/serving.py
   

3. 项目的配置文件介绍

ReAgent 项目的配置文件主要集中在项目的根目录下。以下是一些关键的配置文件：

• setup.cfg: 包含了项目的配置信息，如安装选项、测试配置等。
• pyproject.toml: 包含了项目的构建系统和依赖管理信息。
• .isort.cfg: 用于配置代码格式化工具 isort。
• tox.ini: 用于配置自动化测试工具 tox。

配置文件示例

setup.cfg

[metadata]
name = ReAgent
version = 0.1.0
description = A platform for Reasoning systems (Reinforcement Learning, Contextual Bandits, etc.)
author = Facebook Research
author_email = reagent@fb.com
license = BSD-3-Clause

[options]
packages = find:
install_requires =
    torch
    numpy
    pandas

pyproject.toml

[build-system]
requires = ["setuptools>=42", "wheel"]
build-backend = "setuptools.build_meta"

[tool.isort]
profile = "black"

tox.ini

[tox]
envlist = py37,py38

[testenv]
deps =
    pytest
commands =
    pytest

通过这些配置文件，可以方便地管理和配置 ReAgent 项目。

ReAgent A platform for Reasoning systems (Reinforcement Learning, Contextual Bandits, etc.) 项目地址: https://gitcode.com/gh_mirrors/rea/ReAgent