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

Jump to bottom

Propose further wording change #1156

Merged
merged 3 commits into from
Jul 4, 2024
Merged

Propose further wording change #1156

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
906d03b
Propose further wording change
databyjp Jul 3, 2024
90a5a1b
Merge branch 'dev/1.26' into 20240703-further-nit-picking-sweat-smile
databyjp Jul 3, 2024
cbe0fda
Run black 23.9.1
databyjp Jul 3, 2024
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
12 changes: 6 additions & 6 deletions weaviate/collections/classes/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -572,13 +572,13 @@ def custom(
module_name: str,
module_config: Dict[str, Any],
) -> _GenerativeConfigCreate:
"""Create a `_GenerativeCustom` object for use when generating using a custom module.
"""Create a `_GenerativeCustom` object for use when generating using a custom specification.
Arguments:
`module_name`
The name of the custom module to use, REQUIRED.
The name of the module to use, REQUIRED.
`module_config`
The configuration to use for the custom module. Defaults to `None`, which uses the server-defined default.
The configuration to use for the module. Defaults to `None`, which uses the server-defined default.
"""
return _GenerativeCustom(generative=_EnumLikeStr(module_name), module_config=module_config)

Expand Down Expand Up @@ -871,13 +871,13 @@ def transformers() -> _RerankerConfigCreate:

@staticmethod
def custom(module_name: str, module_config: Dict[str, Any]) -> _RerankerConfigCreate:
"""Create a `_RerankerCustomConfig` object for use when reranking using a custom module.
"""Create a `_RerankerCustomConfig` object for use when reranking using a custom specification.
Arguments:
`module_name`
The name of the custom module to use, REQUIRED.
The name of the module to use, REQUIRED.
`module_config`
The configuration to use for the custom module. Defaults to `None`, which uses the server-defined default.
The configuration to use for the module. Defaults to `None`, which uses the server-defined default.
"""
return _RerankerCustomConfig(
reranker=_EnumLikeStr(module_name), module_config=module_config
Expand Down
6 changes: 3 additions & 3 deletions weaviate/collections/classes/config_vectorizers.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -693,13 +693,13 @@ def text2vec_contextionary(vectorize_collection_name: bool = True) -> _Vectorize
def custom(
module_name: str, module_config: Optional[Dict[str, Any]] = None
) -> _VectorizerConfigCreate:
"""Create a `_VectorizerCustomConfig` object for use when vectorizing using a custom module.
"""Create a `_VectorizerCustomConfig` object for use when vectorizing using a custom specification.
Arguments:
`module_name`
The name of the custom module to use, REQUIRED.
The name of the module to use, REQUIRED.
`module_config`
The configuration to use for the custom module. Defaults to `None`, which uses the server-defined default.
The configuration to use for the module. Defaults to `None`, which uses the server-defined default.
"""
return _VectorizerCustomConfig(
vectorizer=_EnumLikeStr(module_name), module_config=module_config
Expand Down
Loading