Skip to content

Commit 96ea04f

Browse files
committed
Docs: Add authors info
Polish phrasing and typos.
1 parent 2eea061 commit 96ea04f

File tree

1 file changed

+11
-17
lines changed

1 file changed

+11
-17
lines changed

README.md

Lines changed: 11 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -25,23 +25,20 @@ treatment assignment, treatment effect, and censoring.
2525
The evaluation script is not bounded to the provided data,
2626
and can be used on other data as
2727
long as some basic requirements are kept regarding the formats.
28-
The evaluation metrics that are provided include the RMSE, the
29-
effect-normalized RMSE, and several metrics regarding the confidence
30-
intervals.
31-
More technical details regarding the calculated metrics and the formats of the
28+
Full technical details regarding the calculated metrics and the formats of the
3229
labeled and unlabeled data will be published soon through a related manuscript.
33-
Most of the details can be found in the
34-
[Casual Inference Cahllenge 2018](https://www.synapse.org/#!Synapse:syn11294478)
30+
Meanwhile, most of the details can be found in the
31+
[2018 Casual Inference Challenge](https://www.synapse.org/ACIC2018Challenge)
3532
website.
3633

3734
Please note that due to GitHub limitation, only a sample of the data is
3835
available in this repository. However, you can manually access and download
3936
the entire dataset from the
4037
[Synapse sharing platform](https://www.synapse.org/#!Synapse:syn11294478/files/).
4138
Furthermore, since the benchmarking tool is used in the
42-
[Casual Inference Cahllenge 2018](https://www.synapse.org/#!Synapse:syn11294478),
43-
the dataset currently includes a handful of example data with labeles.
44-
The full set will be available when the challenge ends.
39+
[Casual Inference Challenge 2018](https://www.synapse.org/#!Synapse:syn11294478),
40+
the dataset currently includes a handful of example data with labels.
41+
The full set of labeled data will be available when the challenge ends.
4542

4643
## Getting Started
4744
### Prerequisites
@@ -100,7 +97,7 @@ scores = evaluate(PATH_TO_PREDICTION_OUTPUT, PATH_TO_COUNTERFACTUAL_FILES_DIRECT
10097
individual_prediction=True)
10198
```
10299
##### Expected Files
103-
* The counterfactual files (holding $y^1$, $y^0$ for each individual), are expected to be a
100+
* The counterfactual outcomes files (holding $y^1$, $y^0$ for each individual), are expected to be a
104101
directory with different comma-separated-files and their file names corresponding to the
105102
data-instance but having some suffix (e.g. `"_cf.csv"`).
106103
* The predictions for population effect size are expected to be one comma-delimited-file with
@@ -109,7 +106,7 @@ scores = evaluate(PATH_TO_PREDICTION_OUTPUT, PATH_TO_COUNTERFACTUAL_FILES_DIRECT
109106
comma-delimited-files, each corresponding to a data-instance and each containing the
110107
estimated outcome under no-treatment and under positive treatment.
111108

112-
For full explanation, please refer to the menuscript **TODO: link to menuscript**
109+
For full explanation, please refer to the menuscript.
113110

114111
#### Estimation
115112
To avoid inflating file sizes for nothing,
@@ -146,10 +143,7 @@ The current content is open source under Apache License 2.0. For full specificat
146143
[License.txt](License.txt)
147144

148145
## Authors
149-
* bullets (link to personal github profile)
150-
* of
151-
* authors' (link to personal site)
152-
* names
153-
154-
146+
* Yishai Shimoni ([Homepage](http://researcher.watson.ibm.com/researcher/view.php?person=il-YISHAIS))
147+
* Chen Yanover ([Homepage](http://researcher.watson.ibm.com/researcher/view.php?person=il-CHENY))
148+
* Ehud Karavani ([Github](https://github.com/ehudkr))
155149

0 commit comments

Comments
 (0)