Skip to content

Commit

Permalink
update docs 'batch' parameter (#552)
Browse files Browse the repository at this point in the history
Co-authored-by: jeffrey <[email protected]>
Co-authored-by: Bwook (Byoungwook) Kim <[email protected]>
  • Loading branch information
3 people authored Jul 2, 2024
1 parent 79ff4c7 commit 3dc8672
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 1 deletion.
6 changes: 5 additions & 1 deletion docs/source/nodes/passage_reranker/koreranker.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ More details can be found [here](https://huggingface.co/Dongjin-kr/ko-reranker).


## **Module Parameters**
- **Not Applicable (N/A):** There are no direct module parameters specified for the `ko-reranker` module.

(Optional) `batch`

- Specify batch size of the query to the Ko-reranker model.
- default is 64.

## **Example config.yaml**
```yaml
Expand Down
4 changes: 4 additions & 0 deletions docs/source/nodes/passage_reranker/monot5.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ given query.
allowing for flexible integration of different monoT5 variants.
- default is `castorini/monot5-3b-msmarco-10k`

- (Optional) `batch`
- Specify batch size of the query to the TART model.
- default is 64.

## **Example config.yaml**

```yaml
Expand Down
5 changes: 5 additions & 0 deletions docs/source/nodes/passage_reranker/tart.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,11 @@ The `TART` module is a reranker based on [TART](https://arxiv.org/pdf/2211.09260
- Specifies instructions for the reranking process.
- default is `Find passage to answer given question`

(Optional) `batch`

- Specify batch size of the query to the TART model.
- default is 64.

## **Example config.yaml**
```yaml
modules:
Expand Down

0 comments on commit 3dc8672

Please sign in to comment.