Skip to content

Commit 05a85fd

Browse files
committed
update: README.md metadata
1 parent 802e274 commit 05a85fd

File tree

1 file changed

+5
-2
lines changed

1 file changed

+5
-2
lines changed

dafni/README.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,11 @@ to upload the framework onto [DAFNI](https://www.dafni.ac.uk).
1010
- `data` contains two sub-folders (the structure is important for DAFNI).
1111
- `inputs` is a folder that contains the input files that are (separately) uploaded to DAFNI.
1212
- `causal_tests.json` is a JSON file that contains the causal tests.
13-
- `dag.dot` is a dot file that contains the directed acyclc graph (dag) file,
14-
including the variables (and constraints if necessary) as node attributes.
13+
- `dag.dot` is a dot file that contains the directed acyclic graph (dag). Causal variables are defined as
14+
node metadata attributes in this file as key-value pairs using the following syntax:
15+
`node [datatype="int", typestring="input"]`. The `datatype` key specifies the datatype of the causal variable
16+
as a string (e.g. `"int"`, `"str"`) and the `typestring` key specifies its typestring, which is also a string
17+
representing the variable type (e.g. `"input"` or `"output"`).
1518
- `runtime_data.csv` is a csv file that contains the runtime data.
1619

1720
- `outputs` is a folder where the `causal_tests_results.json` output file is created.

0 commit comments

Comments
 (0)