@@ -5,7 +5,7 @@ to upload the framework onto [DAFNI](https://www.dafni.ac.uk).
5
5
- It is ** not** recommended to install the causal testing framework using Docker, and should only be installed
6
6
using [ PyPI] ( https://pypi.org/project/causal-testing-framework/ ) .
7
7
8
- ### Folders
8
+ ### Directory Hierarchy
9
9
10
10
- ` data ` contains two sub-folders (the structure is important for DAFNI).
11
11
- ` 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).
15
15
` node [datatype="int", typestring="input"] ` . The ` datatype ` key specifies the datatype of the causal variable
16
16
as a string (e.g. ` "int" ` , ` "str" ` ) and the ` typestring ` key specifies its typestring, which is also a string
17
17
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.
19
19
20
20
- ` outputs ` is a folder where the ` causal_tests_results.json ` output file is created.
21
21
22
22
### Docker files
23
- - ` main_dafni.py ` is the entry-point to the causal testing framework that is used by Docker.
24
23
- ` 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.
29
27
- ` docker-compose.yaml ` is another method of building the image and running the container in one line.
30
28
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.
31
32
32
33
0 commit comments