Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rename 'Sentence Transformers' to 'sentence-transformers' in docstrings #342

Merged
merged 1 commit into from
Jul 15, 2024
Merged

Rename 'Sentence Transformers' to 'sentence-transformers' in docstrings #342

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -214,7 +214,7 @@ Options:
--default-prompt-name <DEFAULT_PROMPT_NAME>
The name of the prompt that should be used by default for encoding. If not set, no prompt will be applied.

Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
Must be a key in the `sentence-transformers` configuration `prompts` dictionary.

For example if ``default_prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...}, then the
sentence "What is the capital of France?" will be encoded as "query: What is the capital of France?" because
Expand Down
10 changes: 5 additions & 5 deletions docs/openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -851,7 +851,7 @@
},
"prompt_name": {
"type": "string",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"default": "null",
"example": "null",
"nullable": true
Expand Down Expand Up @@ -910,7 +910,7 @@
},
"prompt_name": {
"type": "string",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"default": "null",
"example": "null",
"nullable": true
Expand Down Expand Up @@ -959,7 +959,7 @@
},
"prompt_name": {
"type": "string",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"default": "null",
"example": "null",
"nullable": true
Expand Down Expand Up @@ -1560,7 +1560,7 @@
"properties": {
"prompt_name": {
"type": "string",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"default": "null",
"example": "null",
"nullable": true
Expand Down Expand Up @@ -1695,7 +1695,7 @@
},
"prompt_name": {
"type": "string",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
"default": "null",
"example": "null",
"nullable": true
Expand Down
2 changes: 1 addition & 1 deletion docs/source/en/cli_arguments.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Options:
--default-prompt-name <DEFAULT_PROMPT_NAME>
The name of the prompt that should be used by default for encoding. If not set, no prompt will be applied.

Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
Must be a key in the `sentence-transformers` configuration `prompts` dictionary.

For example if ``default_prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...}, then the
sentence "What is the capital of France?" will be encoded as "query: What is the capital of France?" because
Expand Down
10 changes: 5 additions & 5 deletions router/src/http/types.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -380,7 +380,7 @@ pub(crate) struct SimilarityParameters {
/// The name of the prompt that should be used by for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down Expand Up @@ -414,7 +414,7 @@ pub(crate) struct EmbedRequest {
/// The name of the prompt that should be used by for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down Expand Up @@ -447,7 +447,7 @@ pub(crate) struct EmbedSparseRequest {
/// The name of the prompt that should be used by for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down Expand Up @@ -478,7 +478,7 @@ pub(crate) struct EmbedAllRequest {
/// The name of the prompt that should be used by for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down Expand Up @@ -516,7 +516,7 @@ pub(crate) struct TokenizeRequest {
/// The name of the prompt that should be used by for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down
2 changes: 1 addition & 1 deletion router/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ struct Args {
/// The name of the prompt that should be used by default for encoding. If not set, no prompt
/// will be applied.
///
/// Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
/// Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
///
/// For example if ``default_prompt_name`` is "query" and the ``prompts`` is {"query": "query: ", ...},
/// then the sentence "What is the capital of France?" will be encoded as
Expand Down
Loading