Skip to content

docs: the quickstart on the home page could not be run #11

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tactino merged 1 commit into from
Sep 18, 2026
Merged

docs: the quickstart on the home page could not be run #11

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 24 additions & 1 deletion docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,37 @@

PlugRL is an RL infrastructure for distributed experiments with a clean split between training and environment execution.

> Note: PlugRL is a suite of Python packages. You can keep envs, policies, and algorithms in your own packages and import them on the side that uses them.
!!! note

PlugRL is a suite of Python packages. You can keep envs, policies and
algorithms in your own packages and import them on the side that uses
them.

A full-size pi0.5 has run end to end across that split on LIBERO, and the
reinforcement learning result is negative:
[A real VLA, end to end](#a-real-vla-end-to-end).

## Quickstart

Two processes: a training server that holds the policy, and an env client
that runs environments and asks it for actions. This pair actually learns -
FPO on HalfCheetah-v5, CPU only, no GPU and no assets to download.

Neither package is on PyPI, so install both from source first:

```bash
git clone https://github.com/PlugRL/plugrl-server.git
git clone https://github.com/PlugRL/plugrl-env-client.git

cd plugrl-server && uv sync && cd ..
cd plugrl-env-client && uv sync --extra mujoco && cd ..
```

The env client has one extra per environment family, and `mujoco` is the one
this run needs. Full steps: [Get Started](user_guide/get_started.md).

Then, in two terminals:

```bash
# Terminal 1 - the training server
plugrl-run-server fpo-policy default fpo default \
Expand Down
23 changes: 22 additions & 1 deletion docs/index.zh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,34 @@

PlugRL 是一套面向分布式强化学习实验的基础设施。训练端与环境端通过统一协议解耦。

> Note: PlugRL 是一组可插拔的 Python 包。你的 env、policy、algorithm 可以放在自己的包里，只要在使用侧 import 并完成注册。
!!! note

PlugRL 是一组可插拔的 Python 包。你的 env、policy、algorithm 可以放在自己的
包里，只要在使用侧 import 并完成注册。

一个完整尺寸的 pi0.5 已经通过这条边界在 LIBERO 上端到端跑通，而强化学习的结果是
负面的：见[真实 VLA，端到端](#vla)。

## 快速开始

两个进程：训练端持有策略，环境端跑环境并向它请求动作。下面这一对**真的会学** ——
FPO + HalfCheetah-v5，纯 CPU，不需要 GPU，也不需要下载任何资源文件。

两个包都不在 PyPI 上，先从源码安装：

```bash
git clone https://github.com/PlugRL/plugrl-server.git
git clone https://github.com/PlugRL/plugrl-env-client.git

cd plugrl-server && uv sync && cd ..
cd plugrl-env-client && uv sync --extra mujoco && cd ..
```

env client 按环境家族划分 extra，这次要用的是 `mujoco`。完整步骤见
[快速开始](user_guide/get_started.zh.md)。

然后开两个终端：

```bash
# 终端 1 —— 训练端
plugrl-run-server fpo-policy default fpo default \
Expand Down
Loading