Skip to content

Commit 427ff22

Browse files
committed
Update text-embeddings-router --help output
1 parent 4c855bc commit 427ff22

File tree

2 files changed

+24
-4
lines changed

2 files changed

+24
-4
lines changed

README.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -231,6 +231,16 @@ Options:
231231

232232
[env: DEFAULT_PROMPT=]
233233

234+
--dense-path <DENSE_PATH>
235+
Optionally, define the path to the Dense module required for some embedding models.
236+
237+
Some embedding models require an extra `Dense` module which contains a single Linear layer and an activation function. By default, those `Dense` modules are stored under the `2_Dense` directory, but there might be cases where different `Dense` modules are provided, to convert the pooled embeddings into different dimensions, available as `2_Dense_<dims>` e.g. https://huggingface.co/NovaSearch/stella_en_400M_v5.
238+
239+
Note that this argument is optional, only required to be set if the path to the `Dense` module is other than `2_Dense`. And it also applies when leveraging the `candle` backend.
240+
241+
[env: DENSE_PATH=]
242+
[default: 2_Dense]
243+
234244
--hf-token <HF_TOKEN>
235245
Your Hugging Face Hub token
236246

@@ -304,10 +314,10 @@ Options:
304314

305315
[env: CORS_ALLOW_ORIGIN=]
306316

307-
-h, --help
317+
-h, --help
308318
Print help (see a summary with '-h')
309319

310-
-V, --version
320+
-V, --version
311321
Print version
312322
```
313323

docs/source/en/cli_arguments.md

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,16 @@ Options:
118118

119119
[env: DEFAULT_PROMPT=]
120120

121+
--dense-path <DENSE_PATH>
122+
Optionally, define the path to the Dense module required for some embedding models.
123+
124+
Some embedding models require an extra `Dense` module which contains a single Linear layer and an activation function. By default, those `Dense` modules are stored under the `2_Dense` directory, but there might be cases where different `Dense` modules are provided, to convert the pooled embeddings into different dimensions, available as `2_Dense_<dims>` e.g. https://huggingface.co/NovaSearch/stella_en_400M_v5.
125+
126+
Note that this argument is optional, only required to be set if the path to the `Dense` module is other than `2_Dense`. And it also applies when leveraging the `candle` backend.
127+
128+
[env: DENSE_PATH=]
129+
[default: 2_Dense]
130+
121131
--hf-token <HF_TOKEN>
122132
Your Hugging Face Hub token
123133

@@ -191,9 +201,9 @@ Options:
191201

192202
[env: CORS_ALLOW_ORIGIN=]
193203

194-
-h, --help
204+
-h, --help
195205
Print help (see a summary with '-h')
196206

197-
-V, --version
207+
-V, --version
198208
Print version
199209
```

0 commit comments

Comments
 (0)