Skip to content

Commit 44262c1

Browse files
committed
uupdate minor descriptions
1 parent fd3a93e commit 44262c1

File tree

2 files changed

+5
-5
lines changed
  • causallearn/search/ConstraintBased
  • docs/source/search_methods_index/Constraint-based causal discovery methods

2 files changed

+5
-5
lines changed

causallearn/search/ConstraintBased/FCI.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -716,7 +716,7 @@ def fci(dataset: ndarray, independence_test_method: str=fisherz, alpha: float =
716716
717717
Returns
718718
-------
719-
graph : a CausalGraph object, where graph.graph[j,i]=1 and graph.graph[i,j]=-1 indicates i --> j ,
719+
graph : a GeneralGraph object, where graph.graph[j,i]=1 and graph.graph[i,j]=-1 indicates i --> j ,
720720
graph.graph[i,j] = graph.graph[j,i] = -1 indicates i --- j,
721721
graph.graph[i,j] = graph.graph[j,i] = 1 indicates i <-> j,
722722
graph.graph[j,i]=1 and graph.graph[i,j]=2 indicates i o-> j.

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

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,16 +16,16 @@ Usage
1616
from causallearn.search.ConstraintBased.FCI import fci
1717
1818
# default parameters
19-
G, edges = fci(data)
19+
g, edges = fci(data)
2020
2121
# or customized parameters
22-
G, edges = fci(data, independence_test_method, alpha, depth, max_path_length,
22+
g, edges = fci(data, independence_test_method, alpha, depth, max_path_length,
2323
verbose, background_knowledge, cache_variables_map)
2424
2525
# visualization
2626
from causallearn.utils.GraphUtils import GraphUtils
2727
28-
pdy = GraphUtils.to_pydot(G)
28+
pdy = GraphUtils.to_pydot(g)
2929
pdy.write_png('simple_test.png')
3030
3131
Visualization using pydot is recommended. If specific label names are needed, please refer to this `usage example <https://github.com/cmu-phil/causal-learn/blob/main/tests/TestGraphVisualization.py>`_.
@@ -60,7 +60,7 @@ For detailed usage, please kindly refer to its `usage example <https://github.co
6060

6161
Returns
6262
-------------------
63-
**G**: a CausalGraph object, where G is a PAG and the illustration of its end nodes is as follows:
63+
**g**: a GeneralGraph object, where g.graph is a PAG and the illustration of its end nodes is as follows (denotes G = g.graph):
6464

6565
.. image:: pag.png
6666
:width: 500

0 commit comments

Comments
 (0)