Skip to content

Commit 7d5ac36

Browse files
authored
Update README.md
1 parent 87c0a84 commit 7d5ac36

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

README.md

+11
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,13 @@
11
# a_dcf
22
a-DCF: an architecture agnostic metric
3+
4+
## Installation
5+
- We support package installation via PyPi. For Python users, `pip install a_dcf` will install the package.
6+
- Alternatively, installation of this repo is also available via `python -m pip install -e .`
7+
8+
## Usage
9+
- With default a-DCF configuration (a-DCF1 in the paper)
10+
```
11+
from a_dcf import calculate_a_dcf
12+
results = calculate_a_dcf(YOUR_SCORE_FILE_DIR)
13+
```

0 commit comments

Comments
 (0)