Skip to content

PERF: cythonize kendall correlation #39132

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.

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

Merged
merged 8 commits into from
Jan 20, 2021
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
71 changes: 71 additions & 0 deletions pandas/_libs/algos.pyx
Original file line number Diff line number Diff line change
Expand Up @@ -393,6 +393,77 @@ def nancorr_spearman(ndarray[float64_t, ndim=2] mat, Py_ssize_t minp=1) -> ndarr
return result


# ----------------------------------------------------------------------
# Kendall correlation


@cython.boundscheck(False)
@cython.wraparound(False)
def nancorr_kendall(ndarray[float64_t, ndim=2] mat, Py_ssize_t minp=1) -> ndarray:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we usually dont mix-and-match cython-vs-python style annotations. i know this is tough bc the python-style won't allow ndarray[float64_t, ndim=2]. not sure if there's a better alternative

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Right now, the function signature for this function is the same as the one for nancorr_spearman. However, I notice that other functions have left out the -> ndarray part(including nancorr_pearson). Should I remove that from this function?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

right but we are currently not checking the .pyx right so this is moot for now?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

yah its not a big deal

cdef:
Py_ssize_t i, j, xi, yi, N, K
ndarray[float64_t, ndim=2] result
ndarray[float64_t, ndim=2] ranked_mat
ndarray[uint8_t, ndim=2] mask
float64_t currj
ndarray[uint8_t, ndim=1] valid
ndarray[float64_t, ndim=2] valid_cols
ndarray[float64_t, ndim=1] col
int64_t n_concordant
int64_t total_concordant = 0
int64_t total_discordant = 0
float64_t kendall_tau
int64_t n_obs
const int64_t[:] labels_n

N, K = (<object>mat).shape

result = np.empty((K, K), dtype=np.float64)
mask = np.isfinite(mat).view(np.uint8)

ranked_mat = np.empty((N, K), dtype=np.float64)
# For compatibility when calling rank_1d
labels_n = np.zeros(N, dtype=np.int64)

for i in range(K):
ranked_mat[:, i] = rank_1d(mat[:, i], labels_n)

for xi in range(K):
for yi in range(xi + 1, K):
valid = mask[:, xi] & mask[:, yi]
if valid.sum() < minp:
result[xi, yi] = NaN
result[yi, xi] = NaN
else:
# Get columns and order second column using 1st column ranks
if not valid.all():
valid_cols = ranked_mat[valid.nonzero()][:, [xi, yi]]
else:
valid_cols = ranked_mat[:, [xi, yi]]
# Unfortunately we have to sort here, since we can have tied indices
col = valid_cols[:, 1][valid_cols[:, 0].argsort()]
n_obs = valid_cols.shape[0]
total_concordant = 0
total_discordant = 0
for j in range(n_obs - 1):
currj = col[j]
# Count num concordant and discordant pairs
n_concordant = np.sum(col[j+1:]>=currj)
total_concordant += n_concordant
total_discordant += (n_obs-1-j-n_concordant)
kendall_tau = (total_concordant - total_discordant) / \
(total_concordant + total_discordant)
result[xi, yi] = kendall_tau
result[yi, xi] = kendall_tau

if mask[:, xi].sum() > minp:
result[xi, xi] = 1
else:
result[xi, xi] = NaN

return result


# ----------------------------------------------------------------------

ctypedef fused algos_t:
Expand Down
4 changes: 3 additions & 1 deletion pandas/core/frame.py
Original file line number Diff line number Diff line change
Expand Up @@ -8458,7 +8458,9 @@ def corr(self, method="pearson", min_periods=1) -> DataFrame:
correl = libalgos.nancorr(mat, minp=min_periods)
elif method == "spearman":
correl = libalgos.nancorr_spearman(mat, minp=min_periods)
elif method == "kendall" or callable(method):
elif method == "kendall":
correl = libalgos.nancorr_kendall(mat, minp=min_periods)
elif callable(method):
if min_periods is None:
min_periods = 1
mat = mat.T
Expand Down