Skip to content

Commit 16e8f39

Browse files
SilasMarvinSilasMarvin
authored
Cleaned up some documentation (#937)
1 parent a3fcb35 commit 16e8f39

File tree

7 files changed

+112
-451
lines changed

7 files changed

+112
-451
lines changed

‎pgml-sdks/rust/pgml/Cargo.lock

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pgml-sdks/rust/pgml/build.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use std::fs::OpenOptions;
33
use std::io::Write;
44

55
const ADDITIONAL_DEFAULTS_FOR_PYTHON: &[u8] = br#"
6-
def py_init_logger(level: Optional[str] = "Default set in Rust. Please see documentation.", format: Optional[str] = "Default set in Rust. Please see documentation.") -> None
6+
def py_init_logger(level: Optional[str] = "", format: Optional[str] = "") -> None
77
88
Json = Any
99
DateTime = int

‎pgml-sdks/rust/pgml/javascript/README.md

Lines changed: 106 additions & 427 deletions
Large diffs are not rendered by default.

‎pgml-sdks/rust/pgml/javascript/examples/getting-started/index.js

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ const main = async () => {
2727
// Perform vector search
2828
const queryResults = await collection
2929
.query()
30-
.vector_recall("What are the contents of document one?", pipeline)
30+
.vector_recall("Some user query that will match document one first", pipeline)
3131
.limit(2)
3232
.fetch_all();
3333

@@ -46,5 +46,5 @@ const main = async () => {
4646
};
4747

4848
main().then((results) => {
49-
console.log("Vector search Results: ", results);
49+
console.log("Vector search Results: \n", results);
5050
});

‎pgml-sdks/rust/pgml/javascript/examples/getting-started/package-lock.json

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

‎pgml-sdks/rust/pgml/python/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Follow the steps below to quickly get started with the Python SDK for building s
5656

5757
Before you begin, make sure you have the following:
5858

59-
- PostgresML Database: Ensure you have a PostgresML database version >`2.3.1`. You can spin up a database using [Docker](https://github.com/postgresml/postgresml#installation) or [sign up for a free GPU-powered database](https://postgresml.org/signup).
59+
- PostgresML Database: Ensure you have a PostgresML database version >= `2.7.7` You can spin up a database using [Docker](https://github.com/postgresml/postgresml#installation) or [sign up for a free GPU-powered database](https://postgresml.org/signup).
6060

6161
- Set the `DATABASE_URL` environment variable to the connection string of your PostgresML database.
6262

‎pgml-sdks/rust/pgml/python/pgml/pgml.pyi

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11

2-
def py_init_logger(level: Optional[str] = "Default set in Rust. Please see documentation.", format: Optional[str] = "Default set in Rust. Please see documentation.") -> None
2+
def py_init_logger(level: Optional[str] = "", format: Optional[str] = "") -> None
33

44
Json = Any
55
DateTime = int

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