Skip to content
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.

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

[Data] [Docs] Standardize API Refs for Input/Output #37017

Merged
merged 21 commits into from
Jul 7, 2023
Merged
Prev Previous commit
Next Next commit
more fixes
Signed-off-by: amogkam <[email protected]>
  • Loading branch information
amogkam committed Jul 6, 2023
commit c4bd84c59dae9b06cfc908e8c528c4f8318a0430
3 changes: 2 additions & 1 deletion python/ray/data/read_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -935,7 +935,7 @@ def read_json(
Examples:
>>> import ray
>>> # Read a file in remote storage.
>>> ray.data.read_json("s3:https://anonymous@ray-example-data/logs.json")
>>> ds = ray.data.read_json("s3:https://anonymous@ray-example-data/logs.json")
>>> ds.schema()
Column Type
------ ----
Expand Down Expand Up @@ -1100,6 +1100,7 @@ def read_csv(
>>> from ray.data.datasource import FileExtensionFilter
>>> ray.data.read_csv("example:https://different-extensions/",
... partition_filter=FileExtensionFilter("csv"))
Dataset(num_blocks=..., num_rows=1, schema={a: int64, b: int64})

Args:
paths: A single file or directory, or a list of file or directory paths.
Expand Down