Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
JAVI897 authored Dec 9, 2024
1 parent 3cca697 commit 035fa3d
Showing 1 changed file with 23 additions and 1 deletion.
24 changes: 23 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,28 @@ cd mt-evaluation
pip install -e .
```

### Usage Notes

#### Handling Unbabel Models

When using the `Unbabel/wmt22-cometkiwi-da` or `Unbabel/XCOMET-XL` models, the code will automatically attempt to download them from HuggingFace. However, if no access token is configured, the download will fail, and you will encounter an error.

To avoid this, you need to first request access to the model from HuggingFace. Once access is granted, you can log in to HuggingFace with your token:

```bash
huggingface-cli login
```

Alternatively, you can log in using an environment variable:

```bash
huggingface-cli login --token $HUGGINGFACE_TOKEN
```

#### Configuring Models in YAML

If you plan to use these models, ensure that their corresponding entries are set to `compute: True` in the YAML configuration file.

---

## Getting started
Expand Down Expand Up @@ -651,4 +673,4 @@ To start the Streamlit app and access the visual interface, follow these steps:

## Citation

Paper coming soon.
Paper coming soon.

0 comments on commit 035fa3d

Please sign in to comment.