Skip to content

Commit 3645301

Browse files
authored
Revert "SDK documentation (#657)"
This reverts commit 1d513fd.
1 parent 9949cde commit 3645301

File tree

8 files changed

+24
-483
lines changed

8 files changed

+24
-483
lines changed

pgml-sdks/python/pgml/README.md

Lines changed: 16 additions & 255 deletions
Large diffs are not rendered by default.

pgml-sdks/python/pgml/docs/pgml/collection.md

Lines changed: 0 additions & 128 deletions
This file was deleted.

pgml-sdks/python/pgml/docs/pgml/database.md

Lines changed: 0 additions & 34 deletions
This file was deleted.

pgml-sdks/python/pgml/docs/pgml/dbutils.md

Lines changed: 0 additions & 48 deletions
This file was deleted.

pgml-sdks/python/pgml/docs/pgml/index.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

pgml-sdks/python/pgml/examples/vector_search.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,6 @@
2929

3030
start = time()
3131
results = collection.vector_search("Who won 20 grammy awards?", top_k=2)
32-
rprint("Query time %0.3f"%(time()-start))
3332
rprint(json.dumps(results, indent=2))
33+
rprint("Query time %0.3f"%(time()-start))
3434
db.archive_collection(collection_name)

pgml-sdks/python/pgml/pgml/collection.py

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -264,9 +264,10 @@ def _create_chunks_table(self):
264264

265265
def upsert_documents(
266266
self,
267-
documents: List[Dict[str, Any]],
267+
documents: List[Dict[str, str]],
268268
text_key: Optional[str] = "text",
269269
id_key: Optional[str] = "id",
270+
verbose: bool = False,
270271
) -> None:
271272
"""
272273
The function `upsert_documents` inserts or updates documents in a database table based on their ID,
@@ -275,7 +276,7 @@ def upsert_documents(
275276
:param documents: A list of dictionaries, where each dictionary represents a document to be upserted
276277
into a database table. Each dictionary should contain metadata about the document, as well as the
277278
actual text of the document
278-
:type documents: List[Dict[str, Any]]
279+
:type documents: List[Dict[str, str]]
279280
:param text_key: The key in the dictionary that corresponds to the text of the document, defaults to
280281
text
281282
:type text_key: Optional[str] (optional)
@@ -287,6 +288,7 @@ def upsert_documents(
287288
:param verbose: A boolean parameter that determines whether or not to print verbose output during
288289
the upsert process. If set to True, additional information will be printed to the console during the
289290
upsert process. If set to False, only essential information will be printed, defaults to False
291+
:type verbose: bool (optional)
290292
"""
291293
conn = self.pool.getconn()
292294
for document in track(documents, description="Upserting documents"):

pgml-sdks/python/pgml/pyproject.toml

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,10 @@
11
[tool.poetry]
22
name = "pgml"
3-
version = "0.6.0"
4-
description = "Python SDK is designed to facilitate the development of scalable vector search applications on PostgreSQL databases."
5-
authors = ["PostgresML <team@postgresml.org>"]
6-
homepage = "https://postgresml.org"
7-
repository = "https://github.com/postgresml/postgresml"
8-
documentation = "https://github.com/postgresml/postgresml/tree/master/pgml-sdks/python/pgml"
3+
version = "0.1.0"
4+
description = ""
5+
authors = ["Santi Adavani <santi@hyperparam.ai>"]
96
readme = "README.md"
107
packages = [{include = "pgml"}]
11-
keywords = ["postgres","machine learning","vector databases","embeddings"]
128

139
[tool.poetry.dependencies]
1410
python = ">=3.8.1,<4.0"

0 commit comments

Comments
 (0)
pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.


Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy