Skip to content

Commit e531b5a

Browse files
committed
Updated the parameters for CITs docs
1 parent 97a1091 commit e531b5a

File tree

5 files changed

+24
-19
lines changed

5 files changed

+24
-19
lines changed

docs/source/independence_tests_index/chisq.rst

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -35,10 +35,9 @@ Parameters
3535
**data**: numpy.ndarray, shape (n_samples, n_features). Data, where n_samples is the number of samples
3636
and n_features is the number of features.
3737

38-
**X, Y and condition_set**: column indices of data.
38+
**method**: string, "chisq".
3939

40-
**G_sq**: True means using G-Square test;
41-
False means using Chi-Square test.
40+
**kwargs**: e.g., :code:`cache_path`. See :ref:`Advanced Usages <Advanced Usages>`.
4241

4342
Returns
4443
-------------

docs/source/independence_tests_index/fisherz.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,9 @@ Parameters
3636
**data**: numpy.ndarray, shape (n_samples, n_features). Data, where n_samples is the number of samples
3737
and n_features is the number of features.
3838

39-
**X, Y and condition_set**: column indices of data.
39+
**method**: string, "fisherz".
4040

41-
**correlation_matrix**: correlation matrix; None means without the parameter of correlation matrix.
41+
**kwargs**: e.g., :code:`cache_path`. See :ref:`Advanced Usages <Advanced Usages>`.
4242

4343
Returns
4444
-------------

docs/source/independence_tests_index/gsq.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ Parameters
3434
**data**: numpy.ndarray, shape (n_samples, n_features). Data, where n_samples is the number of samples
3535
and n_features is the number of features.
3636

37-
**X, Y and condition_set**: column indices of data.
37+
**method**: string, "gsq".
3838

39-
**G_sq**: True means using G-Square test; False means using Chi-Square test.
39+
**kwargs**: e.g., :code:`cache_path`. See :ref:`Advanced Usages <Advanced Usages>`.
4040

4141
Returns
4242
---------------

docs/source/independence_tests_index/kci.rst

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -42,26 +42,30 @@ Please see `CIT.py <https://github.com/cmu-phil/causal-learn/blob/main/causallea
4242
for more details on the implementation of the (conditional) independent tests.
4343

4444
Parameters
45-
-------------
45+
------------
4646
**data**: numpy.ndarray, shape (n_samples, n_features). Data, where n_samples is the number of samples
4747
and n_features is the number of features.
4848

49-
**X, Y, and condition_set**: column indices of data. condition_set could be None.
49+
**method**: string, "kci".
5050

51-
**KernelX/Y/Z (condition_set)**: ['GaussianKernel', 'LinearKernel', 'PolynomialKernel'].
52-
(For 'PolynomialKernel', the default degree is 2. Currently, users can change it by setting the 'degree' of 'class PolynomialKernel()'.
51+
**kwargs**:
5352

54-
**est_width**: set kernel width for Gaussian kernels.
53+
+ Either for specifying parameters of KCI, including:
54+
55+
**KernelX/Y/Z (condition_set)**: ['GaussianKernel', 'LinearKernel', 'PolynomialKernel']. (For 'PolynomialKernel', the default degree is 2. Currently, users can change it by setting the 'degree' of 'class PolynomialKernel()'.
56+
57+
**est_width**: set kernel width for Gaussian kernels.
5558
- 'empirical': set kernel width using empirical rules (default).
5659
- 'median': set kernel width using the median trick.
5760

58-
**polyd**: polynomial kernel degrees (default=2).
61+
**polyd**: polynomial kernel degrees (default=2).
62+
63+
**kwidthx/y/z**: kernel width for data x/y/z (standard deviation sigma).
5964

60-
**kwidthx**: kernel width for data x (standard deviation sigma).
65+
**and more**: aee `KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/causallearn/utils/KCI/KCI.py>`_ for details.
6166

62-
**kwidthy**: kernel width for data y (standard deviation sigma).
67+
+ Or for advanced usages of CIT, e.g., :code:`cache_path`. See :ref:`Advanced Usages <Advanced Usages>`.
6368

64-
**kwidthz**: kernel width for data z (standard deviation sigma).
6569

6670
Returns
6771
-----------

docs/source/independence_tests_index/mvfisherz.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,11 +32,13 @@ for more details on the implementation of the (conditional) independent tests.
3232

3333

3434
Parameters
35-
---------------
36-
**mvdata**: numpy.ndarray, shape (n_samples, n_features). Data with missing value, where n_samples is the number of samples
35+
------------
36+
**data**: numpy.ndarray, shape (n_samples, n_features). Data, where n_samples is the number of samples
3737
and n_features is the number of features.
3838

39-
**X, Y and condition_set**: column indices of data.
39+
**method**: string, "mv_fisherz".
40+
41+
**kwargs**: e.g., :code:`cache_path`. See :ref:`Advanced Usages <Advanced Usages>`.
4042

4143
Returns
4244
----------------

0 commit comments

Comments
 (0)