Skip to content

Commit

Permalink
fix: updated wiki based on new type hinting
Browse files Browse the repository at this point in the history
  • Loading branch information
Braden Dubois committed Mar 19, 2021
1 parent 8e57056 commit 88fc80c
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 2 deletions.
2 changes: 1 addition & 1 deletion wiki/Causal Models.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
This document outlines the structure of how to create a causal model for use in the package, such as in the [[API|Do API]].

Models are inherently **DAGs**, where each variable in a model is also represented as a vertex in the DAG.
Models are inherently **DAGs** (Directed Acyclic Graph), where each variable in a model is also represented as a vertex in the DAG.

## Model Structure

Expand Down
3 changes: 2 additions & 1 deletion wiki/Probability Queries.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ print(f"The probability of P(X=x, Y=y) = {x_and_y:5}")
- The creation of an Outcome object is to supply the *name* of the variable, and *some outcome of this variable*.
- The Outcome class is located at ``do.structures.VariableStructures``.
- The API function provided in **Do** to query a probability is the ``p`` function.
- **Do.p** takes *two* arguments, a *set of outcome outcomes*, and a *set of "given" outcomes*.
- **Do.p** takes *two* arguments, a *Collection of outcome outcomes*, and a *Collection of "given" outcomes*.
- **Do.p** requires an empty set as its "given" outcomes even if there are none.
- **Do.p** returns a *float*, between [0, 1].

Expand Down Expand Up @@ -86,3 +86,4 @@ if x_y != x_do_y:
- The Intervention class is located at ``do.structures.VariableStructures``, the same as the Outcome class.
- The Intervention class takes the same arguments as the Outcome class.
- Queries involving interventions use **Do.p** just as standard queries do.
- The "given" / body of a query is a *Collection* of Outcomes and Interventions.

0 comments on commit 88fc80c

Please sign in to comment.