Skip to content

[Data][Docs] Add read kafka user guide#58881

Merged
bveeramani merged 5 commits intoray-project:masterfrom
owenowenisme:data/add-read-kafka-docs
Nov 24, 2025
Merged

[Data][Docs] Add read kafka user guide#58881
bveeramani merged 5 commits intoray-project:masterfrom
owenowenisme:data/add-read-kafka-docs

Conversation

@owenowenisme
Copy link
Member

@owenowenisme owenowenisme commented Nov 21, 2025

Description

  • Add kafka user guide in loading data

@owenowenisme owenowenisme requested a review from a team as a code owner November 21, 2025 07:53
Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request introduces a user guide for reading data from Kafka, which is a valuable addition to the documentation. The examples provided are clear and cover the main use cases. Additionally, the change to remove KafkaAuthConfig from the top-level ray.data namespace is a good step towards improving namespace hygiene, and the documentation correctly reflects the new import path from ray.data.read_api. I've included one suggestion to improve the clarity of the code examples in the new documentation.

Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
@owenowenisme owenowenisme force-pushed the data/add-read-kafka-docs branch from 14bc635 to 43bb71f Compare November 21, 2025 09:55
@owenowenisme owenowenisme added go add ONLY when ready to merge, run all tests data Ray Data-related issues labels Nov 21, 2025
Copy link
Member

@bveeramani bveeramani left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall LGTM. Just one question about the KafkaAuthConfig

from ray.data.iterator import DataIterator, DatasetIterator
from ray.data.preprocessor import Preprocessor
from ray.data.read_api import ( # noqa: F401
KafkaAuthConfig,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What's the motivation for removing these?

I don't think we require importing from ray.data.read_api anywhere else

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added back, I thought we shouldn't add Kafka-specific stuff in ray.data

owenowenisme and others added 4 commits November 22, 2025 08:55
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: You-Cheng Lin <106612301+owenowenisme@users.noreply.github.com>
Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
@bveeramani bveeramani merged commit 05a6fa8 into ray-project:master Nov 24, 2025
6 checks passed
@owenowenisme owenowenisme deleted the data/add-read-kafka-docs branch November 24, 2025 23:10
ykdojo pushed a commit to ykdojo/ray that referenced this pull request Nov 27, 2025
## Description
- Add kafka user guide in loading data

---------

Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
Signed-off-by: You-Cheng Lin <106612301+owenowenisme@users.noreply.github.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: YK <1811651+ykdojo@users.noreply.github.com>
SheldonTsen pushed a commit to SheldonTsen/ray that referenced this pull request Dec 1, 2025
## Description
- Add kafka user guide in loading data

---------

Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
Signed-off-by: You-Cheng Lin <106612301+owenowenisme@users.noreply.github.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
peterxcli pushed a commit to peterxcli/ray that referenced this pull request Feb 25, 2026
## Description
- Add kafka user guide in loading data

---------

Signed-off-by: You-Cheng Lin <mses010108@gmail.com>
Signed-off-by: You-Cheng Lin <106612301+owenowenisme@users.noreply.github.com>
Co-authored-by: Richard Liaw <rliaw@berkeley.edu>
Signed-off-by: peterxcli <peterxcli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

data Ray Data-related issues go add ONLY when ready to merge, run all tests

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants