Skip to content

Commit 494fd62

Browse files
committed
updated documentation about lingam-based methods
1 parent 50fad1d commit 494fd62

File tree

1 file changed

+14
-2
lines changed
  • docs/source/search_methods_index/Causal discovery methods based on constrained functional causal models

1 file changed

+14
-2
lines changed

docs/source/search_methods_index/Causal discovery methods based on constrained functional causal models/lingam.rst

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,11 +30,13 @@ ICA-based LiNGAM
3030
Parameters
3131
""""""""""""""""""""""""""""""""""""
3232

33-
3433
**random_state**: int, optional (default=None). The seed used by the random number generator.
3534

3635
**max_iter**: int, optional (default=1000). The maximum number of iterations of FastICA.
3736

37+
**X**: array-like, shape (n_samples, n_features). Training data, where n_samples is the number of samples
38+
and n_features is the number of features.
39+
3840
Returns
3941
""""""""""""""""""""""""""""""""""""
4042

@@ -74,6 +76,9 @@ The elements of prior knowledge matrix are defined as follows:
7476

7577
**measure**: {'pwling', 'kernel'}, optional (default='pwling'). Measure to evaluate independence: 'pwling' or 'kernel'.
7678

79+
**X**: array-like, shape (n_samples, n_features). Training data, where n_samples is the number of samples
80+
and n_features is the number of features.
81+
7782
Returns
7883
""""""""""""""""""""""""""""""""""""
7984

@@ -114,6 +119,9 @@ Parameters
114119

115120
**random_state**: int, optional (default=None). 'random_state' is the seed used by the random number generator.
116121

122+
**X**: array-like, shape (n_samples, n_features). Training data, where n_samples is the number of samples
123+
and n_features is the number of features.
124+
117125
Returns
118126
""""""""""""""""""""""""""""""""""""
119127

@@ -157,6 +165,9 @@ Parameters
157165
- 'scott': Scott's Rule of Thumb.
158166
- 'silverman': Silverman's Rule of Thumb.
159167

168+
**X**: array-like, shape (n_samples, n_features). Training data, where n_samples is the number of samples
169+
and n_features is the number of features.
170+
160171
Returns
161172
""""""""""""""""""""""""""""""""""""
162173

@@ -185,7 +196,8 @@ CAM-UV
185196
Parameters
186197
""""""""""""""""""""""""""""""""""""
187198

188-
**X**: matrixs.
199+
**data**: array-like, shape (n_samples, n_features). Training data, where n_samples is the number of samples
200+
and n_features is the number of features.
189201

190202
**alpha**: the alpha level for independence testing.
191203

0 commit comments

Comments
 (0)