8000 📝 Try & fix doc · huggingface/huggingface.js@9e7aef6 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9e7aef6

Browse files
coyotte508coyotte508
committed
📝 Try & fix doc
1 parent 2e648dc commit 9e7aef6

File tree

4 files changed

+9
-11
lines changed

4 files changed

+9
-11
lines changed

‎docs/inference/classes/HfInference.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -366,7 +366,7 @@ ___
366366
| Name | Type | Description |
367367
| :------ | :------ | :------ |
368368
| `args` | `Object` | - |
369-
| `args.inputs` | `Record`<`string`, `unknown`\> \| `Record`<`string`, `unknown`\>[] | The inputs vary based on the model. For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will look like this: inputs: &#123; "source_sentence": "That is a happy person", "sentences": ["That is a happy dog", "That is a very happy person", "Today is a sunny day"] &#125; |
369+
| `args.inputs` | `Record`<`string`, `unknown`\> \| `Record`<`string`, `unknown`\>[] | The inputs vary based on the model. For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will have a `source_sentence` string and a `sentences` array of strings |
370370
| `args.model` | `string` | The model to use. Can be a full URL for HF inference endpoints. |
371371
| `options?` | [`Options`](../interfaces/Options) | - |
372372

@@ -376,7 +376,7 @@ ___
376376

377377
#### Defined in
378378

379-
[tasks/nlp/sentenceSimilarity.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L25)
379+
[tasks/nlp/sentenceSimilarity.ts:23](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L23)
380380

381381
___
382382

‎docs/inference/classes/HfInferenceEndpoint.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -337,7 +337,7 @@ ___
337337
| Name | Type | Description |
338338
| :------ | :------ | :------ |
339339
| `args` | `Object` | - |
340-
| `args.inputs` | `Record`<`string`, `unknown`\> \| `Record`<`string`, `unknown`\>[] | The inputs vary based on the model. For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will look like this: inputs: &#123; "source_sentence": "That is a happy person", "sentences": ["That is a happy dog", "That is a very happy person", "Today is a sunny day"] &#125; |
340+
| `args.inputs` | `Record`<`string`, `unknown`\> \| `Record`<`string`, `unknown`\>[] | The inputs vary based on the model. For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will have a `source_sentence` string and a `sentences` array of strings |
341341
| `options?` | [`Options`](../interfaces/Options) | - |
342342

343343
##### Returns
@@ -346,7 +346,7 @@ ___
346346

347347
#### Defined in
348348

349-
[tasks/nlp/sentenceSimilarity.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L25)
349+
[tasks/nlp/sentenceSimilarity.ts:23](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L23)
350350

351351
___
352352

‎docs/inference/modules.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ Returned values are a list of floats
221221

222222
#### Defined in
223223

224-
[tasks/nlp/sentenceSimilarity.ts:20](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L20)
224+
[tasks/nlp/sentenceSimilarity.ts:18](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L18)
225225

226226
___
227227

@@ -638,7 +638,7 @@ Calculate the semantic similarity between one text and a list of other sentences
638638

639639
#### Defined in
640640

641-
[tasks/nlp/sentenceSimilarity.ts:25](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L25)
641+
[tasks/nlp/sentenceSimilarity.ts:23](https://github.com/huggingface/huggingface.js/blob/main/packages/inference/src/tasks/nlp/sentenceSimilarity.ts#L23)
642642

643643
___
644644

‎packages/inference/src/tasks/nlp/sentenceSimilarity.ts

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,10 @@ import { request } from "../custom/request";
44

55
export type SentenceSimilarityArgs = BaseArgs & {
66
/**
7-
* The inputs vary based on the model. For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will look like this:
7+
* The inputs vary based on the model.
88
*
9-
* inputs: &#123;
10-
* "source_sentence": "That is a happy person",
11-
* "sentences": ["That is a happy dog", "That is a very happy person", "Today is a sunny day"]
12-
* &#125;
9+
* For example when using sentence-transformers/paraphrase-xlm-r-multilingual-v1 the inputs will have a `source_sentence` string and
10+
* a `sentences` array of strings
1311
*/
1412
inputs: Record<string, unknown> | Record<string, unknown>[];
1513
};

0 commit comments

Comments
 (0)
0