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.

Sign up for GitHub

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

Jump to bottom

DOCS-#7255: Update docs as to from_* functions #7256

Merged
merged 2 commits into from
May 13, 2024
Merged

DOCS-#7255: Update docs as to from_* functions #7256

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
712b100
DOCS-#7255: Update docs as to from_* functions
YarShev May 13, 2024
1222d93
Fix links
YarShev May 13, 2024
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
32 changes: 19 additions & 13 deletions docs/usage_guide/advanced_usage/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,25 @@ Additional APIs

Modin also supports these additional APIs on top of pandas to improve user experience.

- :py:meth:`~modin.pandas.DataFrame.modin.to_pandas` -- convert Modin DataFrame/Series to Pandas DataFrame/Series.
- :py:meth:`~modin.pandas.DataFrame.modin.to_ray` -- convert Modin DataFrame/Series to Ray Dataset.
- :py:func:`~modin.experimental.pandas.read_csv_glob` -- read multiple files in a directory
- :py:func:`~modin.experimental.pandas.read_sql` -- add optional parameters for the database connection
- :py:func:`~modin.experimental.pandas.read_custom_text` -- read custom text data from file
- :py:func:`~modin.experimental.pandas.read_pickle_glob` -- read multiple pickle files in a directory
- :py:func:`~modin.experimental.pandas.read_parquet_glob` -- read multiple parquet files in a directory
- :py:func:`~modin.experimental.pandas.read_json_glob` -- read multiple json files in a directory
- :py:func:`~modin.experimental.pandas.read_xml_glob` -- read multiple xml files in a directory
- :py:meth:`~modin.pandas.DataFrame.modin.to_pickle_glob` -- write to multiple pickle files in a directory
- :py:meth:`~modin.pandas.DataFrame.modin.to_parquet_glob` -- write to multiple parquet files in a directory
- :py:meth:`~modin.pandas.DataFrame.modin.to_json_glob` -- write to multiple json files in a directory
- :py:meth:`~modin.pandas.DataFrame.modin.to_xml_glob` -- write to multiple xml files in a directory
- :py:meth:`~modin.pandas.DataFrame.modin.to_pandas` -- convert a Modin DataFrame/Series to a pandas DataFrame/Series.
- :py:func:`~modin.pandas.io.from_pandas` -- convert a pandas DataFrame to a Modin DataFrame.
- :py:meth:`~modin.pandas.DataFrame.modin.to_ray` -- convert a Modin DataFrame/Series to a Ray Dataset.
- :py:func:`~modin.pandas.io.from_ray` -- convert a Ray Dataset to a Modin DataFrame.
- :py:meth:`~modin.pandas.DataFrame.modin.to_dask` -- convert a Modin DataFrame/Series to a Ray Dataset.
- :py:func:`~modin.pandas.io.from_dask` -- convert a Modin DataFrame/Series to a Dask DataFrame/Series.
- :py:func:`~modin.pandas.io.from_map` -- create a Modin DataFrame from map function applied to an iterable object.
- :py:func:`~modin.pandas.io.from_arrow` -- convert an Arrow Table to a Modin DataFrame.
- :py:func:`~modin.experimental.pandas.read_csv_glob` -- read multiple files in a directory.
- :py:func:`~modin.experimental.pandas.read_sql` -- add optional parameters for the database connection.
- :py:func:`~modin.experimental.pandas.read_custom_text` -- read custom text data from file.
- :py:func:`~modin.experimental.pandas.read_pickle_glob` -- read multiple pickle files in a directory.
- :py:func:`~modin.experimental.pandas.read_parquet_glob` -- read multiple parquet files in a directory.
- :py:func:`~modin.experimental.pandas.read_json_glob` -- read multiple json files in a directory.
- :py:func:`~modin.experimental.pandas.read_xml_glob` -- read multiple xml files in a directory.
- :py:meth:`~modin.pandas.DataFrame.modin.to_pickle_glob` -- write to multiple pickle files in a directory.
- :py:meth:`~modin.pandas.DataFrame.modin.to_parquet_glob` -- write to multiple parquet files in a directory.
- :py:meth:`~modin.pandas.DataFrame.modin.to_json_glob` -- write to multiple json files in a directory.
- :py:meth:`~modin.pandas.DataFrame.modin.to_xml_glob` -- write to multiple xml files in a directory.

DataFrame partitioning API
--------------------------
Expand Down
Loading