Skip to content

Commit dcf8843

Browse files
committed
update doc
1 parent a118b96 commit dcf8843

File tree

1 file changed

+3
-3
lines changed
  • docs/source/search_methods_index/Constraint-based causal discovery methods

1 file changed

+3
-3
lines changed

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

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,15 +14,15 @@ Usage
1414
.. code-block:: python
1515
1616
from causallearn.search.ConstraintBased.FCI import fci
17-
graph, edges = fci(data, independence_test_method, alpha, depth, max_path_length,
17+
G, edges = fci(data, independence_test_method, alpha, depth, max_path_length,
1818
verbose, background_knowledge, cache_variables_map)
1919
2020
# visualization
2121
from causallearn.utils.GraphUtils import GraphUtils
2222
pdy = GraphUtils.to_pydot(graph)
2323
pdy.write_png('simple_test.png')
2424
25-
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>`_ (e.g., 'cg.draw_pydot_graph(labels=["A", "B", "C"])' or 'GraphUtils.to_pydot(cg.G, labels=["A", "B", "C"])').
25+
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>`_.
2626

2727

2828
Parameters
@@ -53,7 +53,7 @@ For detailed usage, please kindly refer to its `usage example <https://github.co
5353

5454
Returns
5555
-------------------
56-
**graph**: a CausalGraph object, where graph.graph[j,i]=1 and graph.graph[i,j]=-1 indicates i --> j; graph.graph[i,j] = graph.graph[j,i] = -1 indicates i --- j; graph.graph[i,j] = graph.graph[j,i] = 1 indicates i <-> j; graph.graph[j,i]=1 and graph.graph[i,j]=2 indicates i o-> j.
56+
**G**: a CausalGraph object, where G.graph[j,i]=1 and G.graph[i,j]=-1 indicates i --> j; G.graph[i,j] = G.graph[j,i] = -1 indicates i --- j; G.graph[i,j] = G.graph[j,i] = 1 indicates i <-> j; G.graph[j,i]=1 and G.graph[i,j]=2 indicates i o-> j.
5757

5858
**edges**: list. Contains graph's edges properties. If edge.properties have the Property 'dd', then there is no latent confounder. Otherwise, there might be latent confounders. If edge.properties have the Property 'nl', then it is definitely direct. Otherwise, it is possibly direct.
5959

0 commit comments

Comments
 (0)