[GH-ISSUE #1376] [Documentation]: Add BatchTransfer API docs for transfer engine #443

New issue

Closed

opened 2026-10-29 21:14:35 +00:00 by bsakaguchi · 2 comments

bsakaguchi commented

2026-10-29 21:14:35 +00:00

Owner

Originally created by @chestnut-Q on GitHub (Jan 14, 2026).
Original GitHub issue: https://github.com/kvcache-ai/Mooncake/issues/1376

Originally assigned to: @chestnut-Q on GitHub.

Documentation Feedback

We added batch transfer interfaces to transfer_engine_py in #499 and #564. However, these APIs are not documented at Transfer Engine Python API, which may be confusing for newcomers. It would be helpful to add the corresponding API documentation along with an example to explain usage.

BTW, the error return value for TransferEnginePy::batchTransferAsync (0) differs from other transfer APIs (-1). Should we align this for consistency? The concern here is that it would be a breaking change.

Before submitting a new issue...

Make sure you already searched for relevant issues and read the documentation

Originally created by @chestnut-Q on GitHub (Jan 14, 2026). Original GitHub issue: https://github.com/kvcache-ai/Mooncake/issues/1376 Originally assigned to: @chestnut-Q on GitHub. ### Documentation Feedback We added batch transfer interfaces to transfer_engine_py in #499 and #564. However, these APIs are not documented at [Transfer Engine Python API](https://kvcache-ai.github.io/Mooncake/python-api-reference/transfer-engine.html), which may be confusing for newcomers. It would be helpful to add the corresponding API documentation along with an example to explain usage. BTW, the error return value for [TransferEnginePy::batchTransferAsync](https://github.com/kvcache-ai/Mooncake/blob/30ca0868d5657f8eb8e925daa3c762f71de2a1e1/mooncake-integration/transfer_engine/transfer_engine_py.cpp#L469C1-L469C46) (0) differs from other transfer APIs (-1). Should we align this for consistency? The concern here is that it would be a breaking change. ### Before submitting a new issue... - [x] Make sure you already searched for relevant issues and read the [documentation](https://kvcache-ai.github.io/Mooncake/)

bsakaguchi

2026-10-29 21:14:35 +00:00

closed this issue
added the
documentation
label

bsakaguchi commented

2026-10-29 21:14:36 +00:00

Author

Owner

@stmatengss commented on GitHub (Jan 14, 2026):

@chestnut-Q Could you help to solve this issue? THX

@stmatengss commented on GitHub (Jan 14, 2026): @chestnut-Q Could you help to solve this issue? THX

bsakaguchi commented

2026-10-29 21:14:36 +00:00

Author

Owner

@chestnut-Q commented on GitHub (Jan 15, 2026):

@chestnut-Q Could you help to solve this issue? THX

Happy to take it. For the return-value mismatch, I'd leave it unchanged for now to avoid breaking existing apis.

@chestnut-Q commented on GitHub (Jan 15, 2026): > [@chestnut-Q](https://github.com/chestnut-Q) Could you help to solve this issue? THX Happy to take it. For the return-value mismatch, I'd leave it unchanged for now to avoid breaking existing apis.

bsakaguchi referenced this issue

2026-10-29 21:28:31 +00:00

[PR #443] [MERGED] ci: fix sccache #1569