Skip to content

Commit 08fabb2

Browse files
committed
rename optional dependency group to 'embeddings'
- Updated pyproject.toml to use [embeddings] instead of [sentence-transformers] for the optional dependency group - Replaced all install instructions using 'cocoindex[sentence-transformers]' with 'cocoindex[embeddings]' across docs and examples -
1 parent 4b535e9 commit 08fabb2

File tree

11 files changed

+12
-12
lines changed

11 files changed

+12
-12
lines changed

docs/docs/getting_started/quickstart.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ We'll need to install a bunch of dependencies for this project.
2121
1. Install CocoIndex:
2222

2323
```bash
24-
pip install -U 'cocoindex[sentence-transformers]'
24+
pip install -U 'cocoindex[embeddings]'
2525
```
2626

2727
2. You can skip this step if you already have a Postgres database with pgvector extension installed.

docs/docs/ops/functions.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -82,7 +82,7 @@ Return: [*KTable*](/docs/core/data_types#ktable), each row represents a chunk, w
8282
This function requires the 'sentence-transformers' library, which is an optional dependency. Install CocoIndex with:
8383

8484
```bash
85-
pip install 'cocoindex[sentence-transformers]'
85+
pip install 'cocoindex[embeddings]'
8686
```
8787
:::
8888

examples/amazon_s3_embedding/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "amazon-s3-text-embedding"
33
version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on Amazon S3 files."
55
requires-python = ">=3.11"
6-
dependencies = ["cocoindex[sentence-transformers]>=0.1.52", "python-dotenv>=1.0.1"]
6+
dependencies = ["cocoindex[embeddings]>=0.1.52", "python-dotenv>=1.0.1"]
77

88
[tool.setuptools]
99
packages = []

examples/code_embedding/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "code-embedding"
33
version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on source code."
55
requires-python = ">=3.11"
6-
dependencies = ["cocoindex[sentence-transformers]>=0.1.56", "python-dotenv>=1.0.1"]
6+
dependencies = ["cocoindex[embeddings]>=0.1.56", "python-dotenv>=1.0.1"]
77

88
[tool.setuptools]
99
packages = []

examples/fastapi_server_docker/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
cocoindex[sentence-transformers]>=0.1.52
1+
cocoindex[embeddings]>=0.1.52
22
python-dotenv>=1.0.1
33
fastapi==0.115.12
44
fastapi-cli==0.0.7

examples/gdrive_text_embedding/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ name = "gdrive-text-embedding"
33
version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on Google Drive files."
55
requires-python = ">=3.11"
6-
dependencies = ["cocoindex[sentence-transformers]>=0.1.52", "python-dotenv>=1.0.1"]
6+
dependencies = ["cocoindex[embeddings]>=0.1.52", "python-dotenv>=1.0.1"]
77

88
[tool.setuptools]
99
packages = []

examples/pdf_embedding/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on local PDF files."
55
requires-python = ">=3.11"
66
dependencies = [
7-
"cocoindex[sentence-transformers]>=0.1.52",
7+
"cocoindex[embeddings]>=0.1.52",
88
"python-dotenv>=1.0.1",
99
"marker-pdf>=1.5.2",
1010
]

examples/text_embedding/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on local text files."
55
requires-python = ">=3.11"
66
dependencies = [
7-
"cocoindex[sentence-transformers]>=0.1.52",
7+
"cocoindex[embeddings]>=0.1.52",
88
"python-dotenv>=1.0.1",
99
"pgvector>=0.4.1",
1010
"psycopg[binary,pool]",

examples/text_embedding_qdrant/pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ version = "0.1.0"
44
description = "Simple example for cocoindex: build embedding index based on local text files."
55
requires-python = ">=3.11"
66
dependencies = [
7-
"cocoindex[sentence-transformers]>=0.1.52",
7+
"cocoindex[embeddings]>=0.1.52",
88
"python-dotenv>=1.0.1",
99
"qdrant-client>=1.6.0",
1010
]

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ features = ["pyo3/extension-module"]
3030
[project.optional-dependencies]
3131
test = ["pytest"]
3232
dev = ["ruff", "pre-commit"]
33-
sentence-transformers = ["sentence-transformers>=3.3.1"]
33+
embeddings = ["sentence-transformers>=3.3.1"]
3434

3535
[tool.mypy]
3636
python_version = "3.11"

0 commit comments

Comments
 (0)