diff --git a/README.md b/README.md index a7ca3e5..49128b2 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ Train and explain language models that extract information from long medical doc ### Contents - [About](#about) +- [Quick Start](#quick-start) - [Environment](#environment) - [LM Training](#lm-training) - [Generating Explanations](#generating-explanations) @@ -17,6 +18,10 @@ Train and explain language models that extract information from long medical doc - [Maintainers](#maintainers) - [Citation](#citation) +### Quick Start + +To run the Masked Sampling Procedure (MSP) to generate sentence-level explanations of a document-level classifier, `cd` to `explain`, then run `python explain_with_msp.py`. Adjust `explain/params.yml` to provide your data and model as input, or test MSP using the default options (requires access to [HuggingFace](https://huggingface.co/models)). To learn more about this repository, the recommended environment to run MSP, the option to train your own models with this repository, and how MSP was evaluated, check out the following sections of this README. + ### About This codebase contains scripts to: