Skip to content

Commit 1f8fe3c

Browse files
authored
Update README with repo re-organization notice (#1146)
Added important notice about repository re-organization and upcoming changes. <!-- devin-review-badge-begin --> --- <a href="https://app.devin.ai/review/novasky-ai/skyrl/pull/1146" target="_blank"> <picture> <source media="(prefers-color-scheme: dark)" srcset="https://static.devin.ai/assets/gh-open-in-devin-review-dark.svg?v=1"> <img src="https://static.devin.ai/assets/gh-open-in-devin-review-light.svg?v=1" alt="Open with Devin"> </picture> </a> <!-- devin-review-badge-end -->
1 parent 665fdc9 commit 1f8fe3c

File tree

2 files changed

+7
-0
lines changed

2 files changed

+7
-0
lines changed

README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,10 @@ SkyRL is a full-stack RL library that provides the following components:
2121
- [`skyrl-gym`](./skyrl-gym): Our gymnasium of tool-use tasks, including a library of math, coding, search and SQL environments implemented in the Gymnasium API.
2222
- [`skyrl-tx`](./skyrl-tx): A cross-platform library to enable users to expose a local [Tinker](https://thinkingmachines.ai/tinker/)-like REST API for model post-training.
2323

24+
> [!IMPORTANT]
25+
> The SkyRL repo is currently under re-organization. We will soon move everything to `SkyRL/skyrl`, merging `skyrl-train` and `skyrl-tx` into a single folder. We expect to finish by end of February, and in the meantime, please try to develop on top of the new `SkyRL/skyrl` folder. See issue: https://github.com/NovaSky-AI/SkyRL/issues/1145
26+
27+
2428
# Getting Started
2529

2630
For a guide on developing with SkyRL, take at look at our [Development Guide](https://docs.skyrl.ai/docs/getting-started/development) docs.

skyrl-train/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@
55

66
</div>
77

8+
> [!IMPORTANT]
9+
> The SkyRL repo is currently under re-organization. We will soon move everything to `SkyRL/skyrl`, merging `skyrl-train` and `skyrl-tx` into a single folder. We expect to finish by end of February, and in the meantime, please try to develop on top of the new `SkyRL/skyrl` folder. See issue: https://github.com/NovaSky-AI/SkyRL/issues/1145
10+
811
# Overview
912

1013
With a focus on modularity, `skyrl-train` makes it easy to prototype new training algorithms, environments, and execution plans—without compromising usability or speed.

0 commit comments

Comments
 (0)