Spaces:
Build error
Build error
Update installation instructions
Browse files
README.md
CHANGED
@@ -31,8 +31,12 @@ That is, the Vendi Score is equal to the exponential of the von Neumann entropy
|
|
31 |
## How to Use
|
32 |
The Vendi Score is available as a Python package or in HuggingFace `evaluate`.
|
33 |
To use the Python package, see the instructions at https://github.com/vertaix/Vendi-Score.
|
34 |
-
To use the `evaluate` module,
|
35 |
-
|
|
|
|
|
|
|
|
|
36 |
```
|
37 |
>>> vendiscore = evaluate.load("danf0/vendiscore")
|
38 |
>>> samples = ["Look, Jane.",
|
|
|
31 |
## How to Use
|
32 |
The Vendi Score is available as a Python package or in HuggingFace `evaluate`.
|
33 |
To use the Python package, see the instructions at https://github.com/vertaix/Vendi-Score.
|
34 |
+
To use the `evaluate` module, first install the requirements:
|
35 |
+
```
|
36 |
+
pip install evaluate
|
37 |
+
pip install vendi_score[all]
|
38 |
+
```
|
39 |
+
To calculate the score, pass a list of samples and a similarity function or a string identifying a predefined class of similarity functions (see below).
|
40 |
```
|
41 |
>>> vendiscore = evaluate.load("danf0/vendiscore")
|
42 |
>>> samples = ["Look, Jane.",
|