Skip to content

Commit 65971fe

Browse files
committed
Add deprecation notices to docs
1 parent 0e66e45 commit 65971fe

File tree

2 files changed

+35
-1
lines changed

2 files changed

+35
-1
lines changed

docs/api/vectorizer.rst

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,19 @@
22
Vectorizers
33
***********
44

5+
.. note::
6+
**Backwards Compatibility:** Several vectorizers have deprecated aliases
7+
available in the ``redisvl.utils.vectorize.text`` module for backwards
8+
compatibility:
9+
10+
- ``VoyageAITextVectorizer`` → Use ``VoyageAIVectorizer`` instead
11+
- ``VertexAITextVectorizer`` → Use ``VertexAIVectorizer`` instead
12+
- ``BedrockTextVectorizer`` → Use ``BedrockVectorizer`` instead
13+
- ``CustomTextVectorizer`` → Use ``CustomVectorizer`` instead
14+
15+
These aliases are deprecated as of version 0.13.0 and will be removed
16+
in a future major release.
17+
518
HFTextVectorizer
619
================
720

@@ -45,6 +58,11 @@ VertexAIVectorizer
4558

4659
.. currentmodule:: redisvl.utils.vectorize.vertexai
4760

61+
.. note::
62+
For backwards compatibility, an alias ``VertexAITextVectorizer`` is available
63+
in the ``redisvl.utils.vectorize.text`` module. This alias is deprecated
64+
as of version 0.13.0 and will be removed in a future major release.
65+
4866
.. autoclass:: VertexAIVectorizer
4967
:show-inheritance:
5068
:members:
@@ -69,6 +87,11 @@ BedrockVectorizer
6987

7088
.. currentmodule:: redisvl.utils.vectorize.bedrock
7189

90+
.. note::
91+
For backwards compatibility, an alias ``BedrockTextVectorizer`` is available
92+
in the ``redisvl.utils.vectorize.text`` module. This alias is deprecated
93+
as of version 0.13.0 and will be removed in a future major release.
94+
7295
.. autoclass:: BedrockVectorizer
7396
:show-inheritance:
7497
:members:
@@ -81,6 +104,11 @@ CustomVectorizer
81104

82105
.. currentmodule:: redisvl.utils.vectorize.custom
83106

107+
.. note::
108+
For backwards compatibility, an alias ``CustomTextVectorizer`` is available
109+
in the ``redisvl.utils.vectorize.text`` module. This alias is deprecated
110+
as of version 0.13.0 and will be removed in a future major release.
111+
84112
.. autoclass:: CustomVectorizer
85113
:show-inheritance:
86114
:members:
@@ -93,6 +121,11 @@ VoyageAIVectorizer
93121

94122
.. currentmodule:: redisvl.utils.vectorize.voyageai
95123

124+
.. note::
125+
For backwards compatibility, an alias ``VoyageAITextVectorizer`` is available
126+
in the ``redisvl.utils.vectorize.text`` module. This alias is deprecated
127+
as of version 0.13.0 and will be removed in a future major release.
128+
96129
.. autoclass:: VoyageAIVectorizer
97130
:show-inheritance:
98131
:members:

redisvl/utils/vectorize/text/huggingface.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,8 @@ class HFTextVectorizer(BaseVectorizer):
2525
trained on a variety of datasets and tasks, ensuring versatility and
2626
robust performance across different embedding needs.
2727
28-
Note: Some multimodal models can make use of sentence-transformers by passing
28+
Note:
29+
Some multimodal models can make use of sentence-transformers by passing
2930
PIL Image objects in place of strings (e.g. CLIP). To enable those use
3031
cases, this class follows the SentenceTransformer convention of hinting
3132
that it expects string inputs, but never enforcing it.

0 commit comments

Comments
 (0)