EDUCAT

KO | EN

gitlite — search

#python #hacktoberfest #ai #llm #android #machine-learning #rust #deep-learning #docker #java #windows #awesome #cli #pytorch

(★ 13)

Resources for our AAAI 2022 paper: "Unsupervised Editing for Counterfactual Stories".

EDUCAT Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# EDUCAT

Code for our AAAI 2022 paper: "[Unsupervised Editing for Counterfactual Stories](https://ojs.aaai.org/index.php/AAAI/article/view/21290)".

## Dependencies

- Prepare requirements: `pip3 install -r requirements.txt`.
- *Set environment variable* `$PJ_HOME`: `export PJ_HOME=/YOUR_PATH/EDUCAT/`.

## Dataset and Models

- We use the [TimeTravel](https://github.com/qkaren/Counterfactual-StoryRW) dataset, as seen in the repo (`$PJ_HOME/data/TimeTravel`). Since EDUCAT is an unsupervised editing method for this task, we do not need training set. 
- Download pre-trained GPT-2 and RoBERTa checkpoints from HuggingFace and put them in `$PJ_HOME/models/`.

## Running EDUCAT

The MCMC sampling part in the code is modified from  [TSMH](https://github.com/Milozms/TSMH) and [CGMH](https://github.com/NingMiao/CGMH). 
See `src/config.py` for parameter details.

- Single-processing version:
```shell
cd $PJ_HOME/src/config.py
python3 counterfactual_rewrite.py \
  --data_path $PJ_HOME/data/TimeTravel/test_data.json \
  --output_file PATH_TO_RESULTS.txt \
  --mlm_path PATH_TO_MODELS/roberta-base/ \
  --gpt2_path PATH_TO_MODELS/gpt2-medium/ \
  --causal_token_finding \
  --coherence_type lm
```

Note that it could be a little time-consuming to directly run EDUCAT (`counterfactual_rewriting.py`). You can use a *pseudo* multi-processing script (`multi_educat.py`) to speed up the editing at the cost of more memory usage.

- Multi-processing version:
```shell
cd $PJ_HOME/src/config.py
python3 multi_educat.py \
  --data_path $PJ_HOME/data/TimeTravel/test_data.json \
  --output_file PATH_TO_RESULTS.txt \
  --mlm_path PATH_TO_MODELS/roberta-base/ \
  --gpt2_path PATH_TO_MODELS/gpt2-medium/ \
  --causal_token_finding \
  --coherence_type lm \
  -p 8   # 8x speedup
```

## Training EntScore

EntScore is a regular text classifier. Download the dataset from [TimeTravel](https://github.com/qkaren/Counterfactual-StoryRW), follow the instructions in the script at `src/eval_client/nli_metrics/scripts/`, then you are ready to go:
```shell
cd $PJ_HOME/src/eval_client/nli_metrics/
bash script/base.train.sh 
```

### Pre-trained EntScore

We also provide pre-trained models for EntScore based on the base and large versions of RoBERTa at [Google Drive](https://drive.google.com/file/d/1xGs4C2TPuDK72FoIqmoU-XO0WYAoR4IQ/view?usp=sharing), which are the checkpoints used in the paper. You can download them and put them in `$PJ_HOME/models/nli_metrics/`.

## Evaluation

For evaluating the output using BLEU, BERTScore, EntScore (base and large), go to `src/eval_client` and run:
```shell
cd $PJ_HOME/src/eval_client/
python3 metrics.py \
  --pred_text PATH_TO_PREDICTION \
  --input_json PATH_TO_INPUT \
  --metrics bleu bertscore entailscore 
```

## Citation

If you find our work useful to yours, please kindly cite our paper.
```latex
@article{Chen_Gan_Cheng_Zhou_Xiao_Li_2022, 
  title={Unsupervised Editing for Counterfactual Stories}, 
  volume={36}, 
  url={https://ojs.aaai.org/index.php/AAAI/article/view/21290}, 
  DOI={10.1609/aaai.v36i10.21290}, 
  abstractNote={Creating what-if stories requires reasoning about prior statements and possible outcomes of the changed conditions. One can easily generate coherent endings under new conditions, but it would be challenging for current systems to do it with minimal changes to the original story. Therefore, one major challenge is the trade-off between generating a logical story and rewriting with minimal-edits. In this paper, we propose EDUCAT, an editing-based unsupervised approach for counterfactual story rewriting. EDUCAT includes a target position detection strategy based on estimating causal effects of the what-if conditions, which keeps the causal invariant parts of the story. EDUCAT then generates the stories under fluency, coherence and minimal-edits constraints. We also propose a new metric to alleviate the shortcomings of current automatic metrics and better evaluate the trade-off. We evaluate EDUCAT on a public counterfactual story rewriting benchmark. Experiments show that EDUCAT achieves the best trade-off over unsupervised SOTA methods according to both automatic and human evaluation. The resources of EDUCAT are available at: https://github.com/jiangjiechen/EDUCAT.}, 
  number={10}, 
  journal={Proceedings of the AAAI Conference on Artificial Intelligence}, 
  author={Chen, Jiangjie and Gan, Chun and Cheng, Sijie and Zhou, Hao and Xiao, Yanghua and Li, Lei}, 
  year={2022}, 
  month={Jun.}, 
  pages={10473-10481} 
}
```

EDUCAT

EDUCAT Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

EDUCAT

EDUCAT Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README