Skip to content

Commit e88630a

Browse files
committed
updated docs
1 parent c12d540 commit e88630a

File tree

8 files changed

+16
-5
lines changed

8 files changed

+16
-5
lines changed

docs/source/getting_started.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,11 +75,11 @@ Contributors
7575
- Wai-Yin Lam: :ref:`PC <pc>`.
7676
- Biwei Huang: :ref:`CD-NOD <cdnod>`.
7777
- Ignavier Ng, Yujia Zheng: :ref:`Exact search <exactsearch>`.
78-
- Bryan Andrews, Joseph Ramsey: :ref:`GRaSP <GRaSP>`.
78+
- Bryan Andrews, Joseph Ramsey: :ref:`GRaSP <GRaSP>`, :ref:`BOSS <BOSS>`.
7979
- Joseph Ramsey, Wei Chen, Zhiyi Huang: :ref:`Evaluations <evaluation>`.
8080

8181

82-
**Quality control**: Yewen Fan, Haoyue Dai, Yujia Zheng, Ignavier Ng, Xiangchen Song
82+
**Quality control**: Yewen Fan, Zhiyi Huang, Haoyue Dai, Yujia Zheng, Ignavier Ng, Xiangchen Song
8383

8484
Citation
8585
^^^^^^^^^^^^

docs/source/independence_tests_index/index.rst

+2
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@ In this section, we would like to introduce (conditional) independence tests in
44
Missing-value Fisher-z test, Chi-Square test, Kernel-based conditional independence (KCI) test and independence test [2]_,
55
and G-Square test [3]_.
66

7+
(For more efficient nonparametric test, you may try `FastKCI and RCIT <https://github.com./py-why/causal-learn/pull/202>`_. Both implementations are still preliminary and there might be some issues.)
8+
79

810
Contents:
911

docs/source/search_methods_index/Constraint-based causal discovery methods/CDNOD.rst

+3
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ and n_features is the number of features.
5151
- ":ref:`kci <Kernel-based conditional independence (KCI) test and independence test>`": kernel-based conditional independence test. (As a kernel method, its complexity is cubic in the sample size, so it might be slow if the same size is not small.)
5252
- ":ref:`mv_fisherz <Missing-value Fisher-z test>`": Missing-value Fisher's Z conditional independence test.
5353

54+
(For more efficient nonparametric test, you may try `FastKCI and RCIT <https://github.com./py-why/causal-learn/pull/202>`_. Both implementations are still preliminary and there might be some issues.)
55+
56+
5457
**stable**: run stabilized skeleton discovery [3]_ if True. Default: True.
5558

5659
**uc_rule**: how unshielded colliders are oriented. Default: 0.

docs/source/search_methods_index/Constraint-based causal discovery methods/FCI.rst

+3
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,9 @@ and n_features is the number of features.
4343
- ":ref:`kci <Kernel-based conditional independence (KCI) test and independence test>`": kernel-based conditional independence test. (As a kernel method, its complexity is cubic in the sample size, so it might be slow if the same size is not small.)
4444
- ":ref:`mv_fisherz <Missing-value Fisher-z test>`": Missing-value Fisher's Z conditional independence test.
4545

46+
(For more efficient nonparametric test, you may try `FastKCI and RCIT <https://github.com./py-why/causal-learn/pull/202>`_. Both implementations are still preliminary and there might be some issues.)
47+
48+
4649
**alpha**: Significance level of individual partial correlation tests. Default: 0.05.
4750

4851
**depth**: The depth for the fast adjacency search, or -1 if unlimited. Default: -1.

docs/source/search_methods_index/Constraint-based causal discovery methods/PC.rst

+3
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,9 @@ and n_features is the number of features.
8181
- ":ref:`kci <Kernel-based conditional independence (KCI) test and independence test>`": kernel-based conditional independence test. (As a kernel method, its complexity is cubic in the sample size, so it might be slow if the same size is not small.)
8282
- ":ref:`mv_fisherz <Missing-value Fisher-z test>`": Missing-value Fisher's Z conditional independence test.
8383

84+
(For more efficient nonparametric test, you may try `FastKCI and RCIT <https://github.com./py-why/causal-learn/pull/202>`_. Both implementations are still preliminary and there might be some issues.)
85+
86+
8487
**stable**: run stabilized skeleton discovery [4]_ if True. Default: True.
8588

8689
**uc_rule**: how unshielded colliders are oriented. Default: 0.

docs/source/search_methods_index/Permutation-based causal discovery methods/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@ Contents:
99
:maxdepth: 2
1010

1111
GRaSP
12-
boss
12+
BOSS
1313

1414
.. [1] Lam, W. Y., Andrews, B., & Ramsey, J. (2022, February). Greedy Relaxations of the Sparsest Permutation Algorithm. In The 38th Conference on Uncertainty in Artificial Intelligence.

docs/source/search_methods_index/Score-based causal discovery methods/GES.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -49,9 +49,9 @@ and n_features is the number of features.
4949
**score_func**: The score function you would like to use, including (see :ref:`score_functions`.). Default: 'local_score_BIC'.
5050
- ":ref:`local_score_BIC <BIC score>`": BIC score [3]_.
5151
- ":ref:`local_score_BDeu <BDeu score>`": BDeu score [4]_.
52-
- ":ref:`local_score_cv_general <Generalized score with cross validation>`": Generalized score with cross validation for data with single-dimensional variables [2]_.
52+
- ":ref:`local_score_CV_general <Generalized score with cross validation>`": Generalized score with cross validation for data with single-dimensional variables [2]_.
5353
- ":ref:`local_score_marginal_general <Generalized score with marginal likelihood>`": Generalized score with marginal likelihood for data with single-dimensional variables [2]_.
54-
- ":ref:`local_score_cv_multi <Generalized score with cross validation>`": Generalized score with cross validation for data with multi-dimensional variables [2]_.
54+
- ":ref:`local_score_CV_multi <Generalized score with cross validation>`": Generalized score with cross validation for data with multi-dimensional variables [2]_.
5555
- ":ref:`local_score_marginal_multi <Generalized score with marginal likelihood>`": Generalized score with marginal likelihood for data with multi-dimensional variables [2]_.
5656

5757
**maxP**: Allowed maximum number of parents when searching the graph. Default: None.

0 commit comments

Comments
 (0)