Skip to content

Commit

Permalink
Merge pull request #25 from Optum/jstremme-patch-1
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
jstremme authored Jan 22, 2024
2 parents 842e2f5 + fc63601 commit 3048f77
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand All @@ -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:
Expand Down

0 comments on commit 3048f77

Please sign in to comment.