Added docs/dataframe_supported.rst

This commit is contained in:
Stephen Dodson 2019-07-04 19:38:26 +00:00
parent d0ea715c31
commit 245def48e9

View File

@ -0,0 +1,459 @@
pandas.DataFrame supported APIs
===============================
The following table lists both implemented and not implemented methods. If you have need
of an operation that is listed as not implemented, feel free to open an issue on the
`GitHub repository`_, or give a thumbs up to already created issues. Contributions are
also welcome!
The following table is structured as follows: The first column contains the method name.
The second column is a flag for whether or not there is an implementation in Modin for
the method in the left column. ``Y`` stands for yes, ``N`` stands for no, ``P`` stands
for partial (meaning some parameters may not be supported yet), and ``D`` stands for
default to pandas.
+---------------------------+---------------------------------+----------------------------------------------------+
| DataFrame method | Eland Implementation? (Y/N/P/D) | Notes for Current implementation |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``T`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``abs`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``add`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``add_prefix`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``add_suffix`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``agg`` | N | |
| ``aggregate`` | | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``align`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``all`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``any`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``append`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``apply`` | N | See ``agg`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``applymap`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``as_blocks`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``as_matrix`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``asfreq`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``asof`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``assign`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``astype`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``at`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``at_time`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``axes`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``between_time`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``bfill`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``blocks`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``bool`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``boxplot`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``clip`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``clip_lower`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``clip_upper`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``combine`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``combine_first`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``compound`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``consolidate`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``convert_objects`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``copy`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``corr`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``corrwith`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``count`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``cov`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``cummax`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``cummin`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``cumprod`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``cumsum`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``describe`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``diff`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``div`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``divide`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``dot`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``drop`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``drop_duplicates`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``dropna`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``dtypes`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``duplicated`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``empty`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``eq`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``equals`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``eval`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ewm`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``expanding`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ffill`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``fillna`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``filter`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``first`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``first_valid_index`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``floordiv`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``from_csv`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``from_dict`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``from_items`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``from_records`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ftypes`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ge`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``get`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``get_dtype_counts`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``get_ftype_counts`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``get_value`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``get_values`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``groupby`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``gt`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``head`` | Y | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``hist`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``iat`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``idxmax`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``idxmin`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``iloc`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``infer_objects`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``info`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``insert`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``interpolate`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``is_copy`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``isin`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``isna`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``isnull`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``items`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``iteritems`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``iterrows`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``itertuples`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ix`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``join`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``keys`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``kurt`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``kurtosis`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``last`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``last_valid_index`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``le`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``loc`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``lookup`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``lt`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mad`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mask`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``max`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mean`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``median`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``melt`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``memory_usage`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``merge`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``min`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mod`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mode`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``mul`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``multiply`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ndim`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``ne`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``nlargest`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``notna`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``notnull`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``nsmallest`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``nunique`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pct_change`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pipe`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pivot`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pivot_table`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``plot`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pop`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``pow`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``prod`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``product`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``quantile`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``query`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``radd`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rank`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rdiv`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``reindex`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``reindex_axis`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``reindex_like`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rename`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rename_axis`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``reorder_levels`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``replace`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``resample`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``reset_index`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rfloordiv`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rmod`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rmul`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rolling`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``round`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rpow`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rsub`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``rtruediv`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sample`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``select`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``select_dtypes`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sem`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``set_axis`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``set_index`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``set_value`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``shape`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``shift`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``size`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``skew`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``slice_shift`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sort_index`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sort_values`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sortlevel`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``squeeze`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``stack`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``std`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``style`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sub`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``subtract`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``sum`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``swapaxes`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``swaplevel`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``tail`` | Y | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``take`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_clipboard`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_csv`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_dense`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_dict`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_excel`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_feather`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_gbq`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_hdf`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_html`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_json`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_latex`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_msgpack`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_panel`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_parquet`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_period`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_pickle`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_records`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_sparse`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_sql`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_stata`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_string`` | Y | Default sets `max_rows=60` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_timestamp`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``to_xarray`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``transform`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``transpose`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``truediv`` | N | See ``add`` |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``truncate`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``tshift`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``tz_convert`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``tz_localize`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``unstack`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``update`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``values`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``var`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``where`` | N | |
+---------------------------+---------------------------------+----------------------------------------------------+
| ``xs`` | N | Deprecated in pandas |
+---------------------------+---------------------------------+----------------------------------------------------+