Skip to content

Commit

Permalink
Add missing APIs to documentation.
Browse files Browse the repository at this point in the history
  • Loading branch information
bdice committed Apr 12, 2022
1 parent 9e8e92c commit dd0cae8
Show file tree
Hide file tree
Showing 4 changed files with 18 additions and 47 deletions.
30 changes: 11 additions & 19 deletions docs/cudf/source/api_docs/dataframe.rst
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ Indexing, iteration
DataFrame.iloc
DataFrame.insert
DataFrame.__iter__
DataFrame.iteritems
DataFrame.items
DataFrame.keys
DataFrame.iterrows
DataFrame.itertuples
Expand All @@ -65,9 +65,6 @@ Indexing, iteration
DataFrame.mask
DataFrame.query

For more information on ``.at``, ``.iat``, ``.loc``, and
``.iloc``, see the :ref:`indexing documentation <indexing>`.

Binary operator functions
~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
Expand All @@ -84,6 +81,7 @@ Binary operator functions
DataFrame.floordiv
DataFrame.mod
DataFrame.pow
DataFrame.dot
DataFrame.radd
DataFrame.rsub
DataFrame.rmul
Expand Down Expand Up @@ -121,6 +119,7 @@ Computations / descriptive stats
.. autosummary::
:toctree: api/

DataFrame.abs
DataFrame.all
DataFrame.any
DataFrame.clip
Expand All @@ -132,12 +131,15 @@ Computations / descriptive stats
DataFrame.cumprod
DataFrame.cumsum
DataFrame.describe
DataFrame.diff
DataFrame.kurt
DataFrame.kurtosis
DataFrame.max
DataFrame.mean
DataFrame.median
DataFrame.min
DataFrame.mode
DataFrame.pct_change
DataFrame.prod
DataFrame.product
DataFrame.quantile
Expand All @@ -148,6 +150,7 @@ Computations / descriptive stats
DataFrame.sum
DataFrame.std
DataFrame.var
DataFrame.nunique

Reindexing / selection / label manipulation
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -159,7 +162,9 @@ Reindexing / selection / label manipulation
DataFrame.drop
DataFrame.drop_duplicates
DataFrame.equals
DataFrame.first
DataFrame.head
DataFrame.last
DataFrame.reindex
DataFrame.rename
DataFrame.reset_index
Expand All @@ -180,6 +185,7 @@ Missing data handling

DataFrame.dropna
DataFrame.fillna
DataFrame.interpolate
DataFrame.isna
DataFrame.isnull
DataFrame.nans_to_nulls
Expand Down Expand Up @@ -220,27 +226,13 @@ Combining / comparing / joining / merging
DataFrame.merge
DataFrame.update

Numerical operations
~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

DataFrame.acos
DataFrame.asin
DataFrame.atan
DataFrame.cos
DataFrame.exp
DataFrame.log
DataFrame.sin
DataFrame.sqrt
DataFrame.tan

Time Series-related
~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

DataFrame.shift
DataFrame.resample

Serialization / IO / conversion
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
5 changes: 0 additions & 5 deletions docs/cudf/source/api_docs/index_objects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@ Properties
Index.size
Index.values


Modifying and computations
~~~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -151,7 +150,6 @@ Numeric Index
UInt64Index
Float64Index


.. _api.categoricalindex:

CategoricalIndex
Expand Down Expand Up @@ -205,7 +203,6 @@ MultiIndex

MultiIndex


MultiIndex constructors
~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -271,7 +268,6 @@ Time/date components
DatetimeIndex.quarter
DatetimeIndex.isocalendar


Time-specific operations
~~~~~~~~~~~~~~~~~~~~~~~~
.. autosummary::
Expand Down Expand Up @@ -315,5 +311,4 @@ Conversion
:toctree: api/

TimedeltaIndex.to_series
TimedeltaIndex.round
TimedeltaIndex.to_frame
26 changes: 6 additions & 20 deletions docs/cudf/source/api_docs/series.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,7 @@ Attributes
Series.nullmask
Series.null_count
Series.size
Series.T
Series.memory_usage
Series.has_nulls
Series.empty
Expand Down Expand Up @@ -59,9 +60,6 @@ Indexing, iteration
Series.iteritems
Series.keys

For more information on ``.at``, ``.iat``, ``.loc``, and
``.iloc``, see the :ref:`indexing documentation <indexing>`.

Binary operator functions
-------------------------
.. autosummary::
Expand Down Expand Up @@ -94,6 +92,7 @@ Binary operator functions
Series.ne
Series.eq
Series.product
Series.dot

Function application, GroupBy & window
--------------------------------------
Expand All @@ -118,7 +117,6 @@ Computations / descriptive stats
Series.all
Series.any
Series.autocorr
Series.ceil
Series.clip
Series.corr
Series.count
Expand All @@ -131,7 +129,6 @@ Computations / descriptive stats
Series.diff
Series.digitize
Series.factorize
Series.floor
Series.kurt
Series.max
Series.mean
Expand All @@ -140,6 +137,7 @@ Computations / descriptive stats
Series.mode
Series.nlargest
Series.nsmallest
Series.pct_change
Series.prod
Series.quantile
Series.rank
Expand All @@ -166,8 +164,10 @@ Reindexing / selection / label manipulation
Series.drop
Series.drop_duplicates
Series.equals
Series.first
Series.head
Series.isin
Series.last
Series.reindex
Series.rename
Series.reset_index
Expand Down Expand Up @@ -215,27 +215,13 @@ Combining / comparing / joining / merging
Series.append
Series.update

Numerical operations
~~~~~~~~~~~~~~~~~~~~
.. autosummary::
:toctree: api/

Series.acos
Series.asin
Series.atan
Series.cos
Series.exp
Series.log
Series.sin
Series.sqrt
Series.tan

Time Series-related
-------------------
.. autosummary::
:toctree: api/

Series.shift
Series.resample

Accessors
---------
Expand Down
4 changes: 1 addition & 3 deletions python/cudf/cudf/utils/ioutils.py
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,6 @@
See Also
--------
cudf.read_parquet
cudf.read_orc
"""
doc_to_parquet = docfmt_partial(docstring=_docstring_to_parquet)

Expand Down Expand Up @@ -413,8 +412,7 @@
See Also
--------
cudf.read_parquet
cudf.DataFrame.to_parquet
cudf.DataFrame.to_orc
""".format(
remote_data_sources=_docstring_remote_sources
)
Expand Down

0 comments on commit dd0cae8

Please sign in to comment.