[chore] Update README and bump version to 0.1.6#67
Conversation
Signed-off-by: 0oshowero0 <o0shower0o@outlook.com>
CLA Signature Pass0oshowero0, thanks for your pull request. All authors of the commits have signed the CLA. 👍 |
0oshowero0
changed the title
Signed-off-by: 0oshowero0 <o0shower0o@outlook.com>
CLA Signature Pass0oshowero0, thanks for your pull request. All authors of the commits have signed the CLA. 👍 |
| @@ -1 +1 @@ | |||
| 0.1.6.dev0 | |||
| 0.1.6 | |||
There was a problem hiding this comment.
| 0.1.6 | |
| 0.1.7.dev |
We recommend creating the release/v0.1.6 branch and advancing the version on the main branch to 0.1.7.dev.
There was a problem hiding this comment.
The 0.1.6 is not published yet. I plan to change it to 0.1.6 first, make release branch, then create a new PR that changes the main branch to 0.1.7.dev
There was a problem hiding this comment.
Pull request overview
This PR prepares the repository for the 0.1.6 release by updating the package version and refreshing user-facing documentation (main README + performance test guide), including clarifying performance test scenarios and tightening the Mooncake optional dependency.
Changes:
- Bump package version from
0.1.6.dev0to0.1.6. - Expand
scripts/performance_test/README_PERFTEST.mdwith backend YAML examples and document the--use_complex_casescenario. - Update
README.mdcontent (MooncakeStore maturity, verl integration section, performance/stress-test links) and pinmooncake-transfer-engineinpyproject.toml.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| transfer_queue/version/version | Updates the dynamically-loaded package version to 0.1.6. |
| scripts/performance_test/README_PERFTEST.md | Adds backend config examples and documents the new complex-case perf test mode. |
| README.md | Refreshes backend maturity labels, updates verl integration documentation, and updates benchmark/stress-test references. |
| pyproject.toml | Pins the Mooncake optional dependency version. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| - Preserving verl's original Dispatch/Collect logic via BatchMeta (maintaining single-controller debuggability) | ||
| - Accelerating data transfer by TransferQueue's distributed storage units | ||
| <p align="center"> | ||
| <img src="https://raw.githubusercontent.com/wuxibin89/verl/refs/heads/wuxibin/doc_images/docs/_static/transfer_queue.png" width="100%"> |
There was a problem hiding this comment.
The image URL uses raw.githubusercontent.com/.../refs/heads/..., which typically does not resolve because the raw URL expects a git ref/branch name (e.g. .../main/... or .../<branch>/...), not the full refs/heads/... path. This will likely render as a broken image in the README; consider switching to a standard raw URL (with the actual branch name) or using a github.com/.../blob/...?...raw=true link (preferably in an official/stable repo).
| <img src="https://raw.githubusercontent.com/wuxibin89/verl/refs/heads/wuxibin/doc_images/docs/_static/transfer_queue.png" width="100%"> | |
| <img src="https://raw.githubusercontent.com/wuxibin89/verl/wuxibin/doc_images/docs/_static/transfer_queue.png" width="100%"> |
| ] | ||
| mooncake = [ | ||
| "mooncake-transfer-engine" | ||
| "mooncake-transfer-engine==0.3.10.post1" |
There was a problem hiding this comment.
Pinning mooncake-transfer-engine to an exact version in an optional extra can make dependency resolution brittle for downstream users (e.g., if they already depend on a compatible patch release). Unless you specifically require only 0.3.10.post1, consider using a compatible range (e.g. >=0.3.10.post1,<0.4) or ~=0.3.10 to allow patch-level upgrades while still enforcing a minimum version.
| "mooncake-transfer-engine==0.3.10.post1" | |
| "mooncake-transfer-engine>=0.3.10.post1,<0.4" |
As title