Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #25

Merged
merged 3 commits into from
Jan 22, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
Loading