spark-instrumented-optimizer/python/docs/source/reference/ps_extensions.rst
Hyukjin Kwon 3d158f9c91 [SPARK-35587][PYTHON][DOCS] Initial porting of Koalas documentation
### What changes were proposed in this pull request?

This PR proposes to port Koalas documentation to PySpark documentation as its initial step.
It ports almost as is except these differences:

- Renamed import from `databricks.koalas` to `pyspark.pandas`.
- Renamed `to_koalas` -> `to_pandas_on_spark`
- Renamed `(Series|DataFrame).koalas` -> `(Series|DataFrame).pandas_on_spark`
- Added a `ps_` prefix in the RST file names of Koalas documentation

Other then that,

- Excluded `python/docs/build/html` in linter
- Fixed GA dependency installataion

### Why are the changes needed?

To document pandas APIs on Spark.

### Does this PR introduce _any_ user-facing change?

Yes, it adds new documentations.

### How was this patch tested?

Manually built the docs and checked the output.

Closes #32726 from HyukjinKwon/SPARK-35587.

Authored-by: Hyukjin Kwon <gurwls223@apache.org>
Signed-off-by: Hyukjin Kwon <gurwls223@apache.org>
2021-06-04 11:11:09 +09:00

21 lines
518 B
ReStructuredText

.. _api.extensions:
==========
Extensions
==========
.. currentmodule:: pyspark.pandas.extensions
Accessors
---------
Accessors can be written and registered with Koalas Dataframes, Series, and
Index objects. Accessors allow developers to extend the functionality of
Koalas objects seamlessly by writing arbitrary classes and methods which are
then wrapped in one of the following decorators.
.. autosummary::
:toctree: api/
register_dataframe_accessor
register_series_accessor
register_index_accessor