Skip to content

Commit 60b3c7f

Browse files
committed
update: README.md
1 parent 5742985 commit 60b3c7f

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

dafni/README.md

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ to upload the framework onto [DAFNI](https://www.dafni.ac.uk).
55
- It is **not** recommended to install the causal testing framework using Docker, and should only be installed
66
using [PyPI](https://pypi.org/project/causal-testing-framework/).
77

8-
### Folders
8+
### Directory Hierarchy
99

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.
@@ -15,18 +15,19 @@ to upload the framework onto [DAFNI](https://www.dafni.ac.uk).
1515
`node [datatype="int", typestring="input"]`. The `datatype` key specifies the datatype of the causal variable
1616
as a string (e.g. `"int"`, `"str"`) and the `typestring` key specifies its typestring, which is also a string
1717
representing the variable type (e.g. `"input"` or `"output"`).
18-
- `runtime_data.csv` is a csv file that contains the runtime data.
18+
- `runtime_data.csv` is the `.csv` file that contains the runtime data.
1919

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

2222
### Docker files
23-
- `main_dafni.py` is the entry-point to the causal testing framework that is used by Docker.
2423
- `model_definition.yaml` is the model metadata that is required to be uploaded to DAFNI.
25-
- `.env` is an example of a configuration file containing the environment variables. This is only required
26-
if using `docker-compose` to build the image.
27-
- `Dockerfile` is the main blueprint that builds the image.
28-
- `.dockerignore` tells the Dockerfile which files to not include in the image.
24+
- `Dockerfile` is the main blueprint that builds the image. The main command calls the `causal_testing` module,
25+
with specified paths for the DAG, input runtime data, test configurations, and the output filename as defined above.
26+
This command is identical to that referenced in the main [README.md](../README.md) file.
2927
- `docker-compose.yaml` is another method of building the image and running the container in one line.
3028
Note: the `.env` file that contains the environment variables for `main_dafni.py` is only used here.
29+
- `.dockerignore` tells the Dockerfile which files to not include in the image.
30+
- `.env` is an example of a configuration file containing the environment variables. This is only required
31+
if using `docker-compose` to build the image.
3132

3233

0 commit comments

Comments
 (0)