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
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Apply suggestions from code review
Co-authored-by: angelinalg <[email protected]>
Signed-off-by: Amog Kamsetty <[email protected]>
  • Loading branch information
amogkam and angelinalg committed Jul 6, 2023
commit 895cb6c731cb4e1a76bcf2760eec7c74ebf621f6
24 changes: 12 additions & 12 deletions python/ray/data/dataset.py
Original file line number Diff line number Diff line change
Expand Up @@ -2450,7 +2450,7 @@ def write_parquet(
filesystem. By default, the filesystem is automatically selected based
on the scheme of the paths. For example, if the path begins with
``s3:https://``, the ``S3FileSystem`` is used.
try_create_dir: Try to create all directories in
try_create_dir: If True, attempts to create all directories in the
destination path if ``True``. Does nothing if all directories already
exist. Defaults to ``True``.
arrow_open_stream_args: kwargs passed to
Expand All @@ -2469,7 +2469,7 @@ def write_parquet(
/arrow.apache.org/docs/python/generated/\
pyarrow.parquet.write_table.html#pyarrow.parquet.write_table>`_
when writing each block to a file. Overrides
any duplicate keys from ``arrow_parquet_args``. This should be used
any duplicate keys from ``arrow_parquet_args``. Use this parameter
instead of ``arrow_parquet_args`` if any of your write arguments
can't pickled, or if you'd like to lazily resolve the write
arguments for each dataset block.
Expand Down Expand Up @@ -2541,7 +2541,7 @@ def write_json(
filesystem. By default, the filesystem is automatically selected based
on the scheme of the paths. For example, if the path begins with
``s3:https://``, the ``S3FileSystem`` is used.
try_create_dir: Try to create all directories in
try_create_dir: If True, attempts to create all directories in
destination path if ``True``. Does nothing if all directories already
exist. Defaults to ``True``.
arrow_open_stream_args: kwargs passed to
Expand All @@ -2560,7 +2560,7 @@ def write_json(
`pandas.DataFrame.to_json() <https://pandas.pydata.org/docs/reference/\
api/pandas.DataFrame.to_json.html>`_
when writing each block to a file. Overrides
any duplicate keys from ``pandas_json_args``. This should be used
any duplicate keys from ``pandas_json_args``. Use this parameter
instead of ``pandas_json_args`` if any of your write arguments
can't be pickled, or if you'd like to lazily resolve the write
arguments for each dataset block.
Expand Down Expand Up @@ -2639,7 +2639,7 @@ def write_csv(
filesystem. By default, the filesystem is automatically selected based
on the scheme of the paths. For example, if the path begins with
``s3:https://``, the ``S3FileSystem`` is used.
try_create_dir: Try to create all directories in
try_create_dir: If true, attempts to create all directories in the
destination path if ``True``. Does nothing if all directories already
exist. Defaults to ``True``.
arrow_open_stream_args: kwargs passed to
Expand All @@ -2658,7 +2658,7 @@ def write_csv(
arrow.apache.org/docs/python/generated/\
pyarrow.csv.write_csv.html#pyarrow.csv.write_csv>`_ when writing each
block to a file. Overrides any duplicate keys from ``arrow_csv_args``.
This should be used instead of ``arrow_csv_args`` if any of your write
This parameter should be used instead of ``arrow_csv_args`` if any of your write
arguments cannot be pickled, or if you'd like to lazily resolve the
write arguments for each dataset block.
ray_remote_args: kwargs passed to :meth:`~ray.remote` in the write tasks.
Expand Down Expand Up @@ -2695,7 +2695,7 @@ def write_tfrecords(
"""Write the :class:`~ray.data.Dataset` to TFRecord files.

The `TFRecord <https://www.tensorflow.org/tutorials/load_data/tfrecord>`_
files will contain
files contain
`tf.train.Example <https://www.tensorflow.org/api_docs/python/tf/train/\
Example>`_
records, with one Example record for each row in the dataset.
Expand Down Expand Up @@ -2736,7 +2736,7 @@ def write_tfrecords(
filesystem. By default, the filesystem is automatically selected based
on the scheme of the paths. For example, if the path begins with
``s3:https://``, the ``S3FileSystem`` is used.
try_create_dir: Try to create all directories in
try_create_dir: If true, attempts to create all directories in
destination path if ``True``. Does nothing if all directories already
exist. Defaults to ``True``.
arrow_open_stream_args: kwargs passed to
Expand Down Expand Up @@ -2885,8 +2885,8 @@ def write_numpy(
filesystem. By default, the filesystem is automatically selected based
on the scheme of the paths. For example, if the path begins with
``s3:https://``, the ``S3FileSystem`` is used.
try_create_dir: Try to create all directories in
destination path if True. Does nothing if all directories already
try_create_dir: If True, attempts to create all directories in
destination path. Does nothing if all directories already
exist. Defaults to True.
arrow_open_stream_args: kwargs passed to
`pyarrow.fs.FileSystem.open_output_stream <https://arrow.apache.org\
Expand Down Expand Up @@ -2931,9 +2931,9 @@ def write_mongo(
:meth:`~ray.data.Dataset.repartition`.

.. warning::
Currently, this supports only a subset of the pyarrow's types, due to the
This method supports only a subset of the PyArrow's types, due to the
limitation of pymongoarrow which is used underneath. Writing unsupported
types will fail on type checking. See all the supported types at:
types fails on type checking. See all the supported types at:
https://mongo-arrow.readthedocs.io/en/latest/data_types.html.

.. note::
Expand Down
Loading