Skip to content

Commit 64e58b1

Browse files
committed
update docs
1 parent 65d94cf commit 64e58b1

File tree

5 files changed

+16
-2
lines changed

5 files changed

+16
-2
lines changed

docs/source/independence_tests_index/chisq.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,14 @@ Chi-Square test
55

66
Perform an independence test on discrete variables using Chi-Square test.
77

8+
(We have updated the independence test class and the usage example hasn't been updated yet. For new class, please refer to `TestCIT.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT.py>`_ or `TestCIT_KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT_KCI.py>`_.)
9+
810
Usage
911
--------
1012
.. code-block:: python
1113
12-
from causallearn.utils.cit import cit
13-
p = cit.CIT(data, 'chisq')
14+
from causallearn.utils.cit import chisq
15+
p = chisq(data, X, Y, conditioning_set)
1416
1517
1618
Parameters

docs/source/independence_tests_index/fisherz.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ Fisher-z test
55

66
Perform an independence test using Fisher-z's test [1]_. This test is optimal for linear-Gaussian data.
77

8+
(We have updated the independence test class and the usage example hasn't been updated yet. For new class, please refer to `TestCIT.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT.py>`_ or `TestCIT_KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT_KCI.py>`_.)
9+
10+
811
Usage
912
--------
1013
.. code-block:: python

docs/source/independence_tests_index/gsq.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,9 @@ G-Square test
55

66
Perform an independence test using G-Square test [1]_. This test is based on the log likelihood ratio test.
77

8+
(We have updated the independence test class and the usage example hasn't been updated yet. For new class, please refer to `TestCIT.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT.py>`_ or `TestCIT_KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT_KCI.py>`_.)
9+
10+
811
Usage
912
--------
1013
.. code-block:: python

docs/source/independence_tests_index/kci.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Kernel-based conditional independence (KCI) test and independence test [1]_.
77
To test if x and y are conditionally or unconditionally independent on Z. For unconditional independence tests,
88
Z is set to the empty set.
99

10+
(We have updated the independence test class and the usage example hasn't been updated yet. For new class, please refer to `TestCIT.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT.py>`_ or `TestCIT_KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT_KCI.py>`_.)
11+
12+
1013
Usage
1114
--------
1215
.. code-block:: python

docs/source/independence_tests_index/mvfisherz.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,9 @@ Missing-value Fisher-z test
66
Perform a testwise-deletion Fisher-z independence test to data sets with missing values.
77
With testwise-deletion, the test makes use of all data points that do not have missing values for the variables involved in the test.
88

9+
(We have updated the independence test class and the usage example hasn't been updated yet. For new class, please refer to `TestCIT.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT.py>`_ or `TestCIT_KCI.py <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestCIT_KCI.py>`_.)
10+
11+
912
Usage
1013
--------
1114
.. code-block:: python

0 commit comments

Comments
 (0)