Skip to content

Commit

Permalink
Merge remote-tracking branch 'origin/main' into main
Browse files Browse the repository at this point in the history
  • Loading branch information
Riccorl committed May 24, 2024
2 parents a0d6bcc + 1d5ff8a commit a8ad16b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,10 @@

</p>

# WIP: distributed-compatible codebase

A distributed-compatible codebase is under development. Check the `distributed` [branch](https://github.com/Riccorl/golden-retriever/tree/distributed) for the latest updates.

# How to use

Install the library from [PyPI](https://pypi.org/project/goldenretriever-core/):
Expand All @@ -37,7 +41,7 @@ pip install -e .
### Training

Here a simple example on how to train a DPR-like Retriever on the NQ dataset.
First download the dataset from (DPR)[]. The run the following code:
First download the dataset from [DPR](https://github.com/facebookresearch/DPR?tab=readme-ov-file#retriever-input-data-format). The run the following code:

```python
from goldenretriever.trainer import Trainer
Expand Down

0 comments on commit a8ad16b

Please sign in to comment.