Back to Modin

``pd.Series`` supported APIs

docs/supported_apis/series_supported.rst

0.37.153.6 KB
Original Source

pd.Series 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. To learn more about the implementations that default to pandas, see the related section on :doc:Defaulting to pandas </supported_apis/index>.

+-----------------------------+---------------------------------+----------------------------------------------------+ | Series method | Modin Implementation? (Y/N/P/D) | Notes for Current implementation | +-----------------------------+---------------------------------+----------------------------------------------------+ | abs | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | add | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | add_prefix | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | add_suffix | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | agg | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | aggregate | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | align | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | all | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | any | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | apply | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | argmax | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | argmin | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | argsort | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | array | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | asfreq | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | asobject | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | asof | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | astype | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | at | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | at_time | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | autocorr | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | axes | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | base | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | between | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | between_time | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | bfill | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | bool | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | cat | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | clip | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | combine | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | combine_first | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | compare | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | compress | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | copy | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | corr | Y | Correlation floating point precision may slightly | | | | differ from pandas. For now pearson method is | | | | available only. For other methods defaults to | | | | pandas. | +-----------------------------+---------------------------------+----------------------------------------------------+ | count | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | cov | Y | Covariance floating point precision may slightly | | | | differ from pandas. | +-----------------------------+---------------------------------+----------------------------------------------------+ | cummax | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | cummin | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | cumprod | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | cumsum | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | data | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | describe | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | diff | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | div | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | divide | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | divmod | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | dot | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | drop | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | drop_duplicates | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | droplevel | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | dropna | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | dt | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | dtype | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | dtypes | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | duplicated | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | empty | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | eq | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | equals | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ewm | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | expanding | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | explode | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | factorize | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ffill | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | fillna | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | filter | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | first | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | first_valid_index | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | flags | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | floordiv | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | from_array | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ftype | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ge | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | get | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | get_dtype_counts | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | get_ftype_counts | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | get_value | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | get_values | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | groupby | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | gt | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | hasnans | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | head | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | hist | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | iat | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | idxmax | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | idxmin | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | iloc | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | imag | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | index | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | infer_objects | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | interpolate | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | is_monotonic_decreasing | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | is_monotonic_increasing | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | is_unique | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | isin | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | isna | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | isnull | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | item | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | items | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | itemsize | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | keys | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | kurt | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | kurtosis | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | last | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | last_valid_index | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | le | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | loc | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | lt | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | map | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | mask | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | max | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | mean | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | median | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | memory_usage | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | min | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | mod | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | mode | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | mul | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | multiply | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | name | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | nbytes | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ndim | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ne | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | nlargest | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | nonzero | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | notna | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | notnull | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | nsmallest | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | nunique | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | pct_change | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | pipe | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | plot | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | pop | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | pow | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | prod | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | product | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ptp | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | put | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | quantile | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | radd | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rank | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | ravel | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | rdiv | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rdivmod | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | real | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | reindex | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | reindex_like | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | rename | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | rename_axis | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | reorder_levels | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | repeat | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | replace | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | resample | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | reset_index | P | Ray and Dask: D when names or | | | | allow_duplicates is non-default | +-----------------------------+---------------------------------+----------------------------------------------------+ | rfloordiv | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rmod | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rmul | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rolling | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | round | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | rpow | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rsub | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | rtruediv | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | sample | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | searchsorted | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | sem | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | set_axis | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | set_value | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | shape | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | shift | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | size | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | skew | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | sort_index | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | sort_values | Y | Order of indexes that have the same sort key | | | | is not guaranteed to be the same across sorts; | +-----------------------------+---------------------------------+----------------------------------------------------+ | sparse | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | squeeze | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | std | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | str | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | strides | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | sub | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | subtract | Y | See add; | +-----------------------------+---------------------------------+----------------------------------------------------+ | sum | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | swapaxes | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | swaplevel | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | tail | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | take | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_clipboard | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_csv | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_dict | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_excel | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_frame | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_hdf | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_json | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_latex | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_list | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_numpy | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_period | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_pickle | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_sql | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_string | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_timestamp | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | to_xarray | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | tolist | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | transform | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | transpose | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | truediv | Y | See add | +-----------------------------+---------------------------------+----------------------------------------------------+ | truncate | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | tz_convert | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | tz_localize | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | unique | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | unstack | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | update | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | valid | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | value_counts | Y | The indices order of resulting object may differ | | | | from pandas. | +-----------------------------+---------------------------------+----------------------------------------------------+ | values | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+ | var | P | Modin defaults to pandas if given the level | | | | param. | +-----------------------------+---------------------------------+----------------------------------------------------+ | view | D | | +-----------------------------+---------------------------------+----------------------------------------------------+ | where | Y | | +-----------------------------+---------------------------------+----------------------------------------------------+

.. _GitHub repository: https://github.com/modin-project/modin/issues