Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iamgroot42 authored Jan 10, 2024
1 parent 6e43885 commit 78d00f9
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@

MIMIR - Python package for measuring memorization in LLMs.

[![Tests](https://github.com/iamgroot42/mimir/actions/workflows/test.yml/badge.svg)](https://github.com/iamgroot42/mimir/actions/workflows/test.yml)
[![Documentation](https://github.com/iamgroot42/mimir/actions/workflows/documentation.yml/badge.svg)](https://github.com/iamgroot42/mimir/actions/workflows/documentation.yml)

## Instructions

First install the python dependencies
Expand Down Expand Up @@ -55,4 +58,4 @@ We include and implement the following attacks, as described in our paper.
To add an attack, create a file for your attack (e.g. `attacks/my_attack.py`) and implement the interface described in `attacks/blackbox_attack.py`.
Then, add a name for your attack to the dictionary in `attacks/blackbox_attack.py`.

If you would like to submit your attack to the repository, please open a pull request describing your attack and the paper it is based on.
If you would like to submit your attack to the repository, please open a pull request describing your attack and the paper it is based on.

0 comments on commit 78d00f9

Please sign in to comment.