Skip to content

Commit e402859

Browse files
committed
doc update
1 parent 89bae1a commit e402859

1 file changed

Lines changed: 5 additions & 0 deletions

File tree

dca/cov_util.py

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -348,9 +348,14 @@ def calc_pi_from_data(X, T, proj=None):
348348
349349
Parameters
350350
----------
351+
X : ndarray or torch tensor (time, features) or (batches, time, features)
352+
Data used to calculate the PI.
351353
T : int
352354
This T should be 2 * T_pi. This T sets the joint window length not the
353355
past or future window length.
356+
proj : ndarray or torch tensor
357+
Projection matrix for data (optional). If `proj` is not given, the PI of
358+
the dataset is given.
354359
355360
Returns
356361
-------

0 commit comments

Comments
 (0)