From 890d4baa68e6e6a73d31a73677576e09d7060937 Mon Sep 17 00:00:00 2001 From: Md Fazlul Karim Date: Thu, 15 Aug 2024 01:22:33 +0600 Subject: [PATCH] Minor updates in package --- docs/content/core_api/apply.md | 10 +++++----- docs/content/core_api/connect.md | 2 +- docs/content/core_api/execute.md | 2 +- docs/content/core_api/intro.md | 4 ++-- docs/content/execute_api/native_vector_search.md | 2 +- 5 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/content/core_api/apply.md b/docs/content/core_api/apply.md index 978e40f3c..c28c85c2f 100644 --- a/docs/content/core_api/apply.md +++ b/docs/content/core_api/apply.md @@ -1,6 +1,6 @@ # Apply -In Superduper there are three fundamental base components which you'll use for almost all functionality: +In superduper there are three fundamental base components which you'll use for almost all functionality: - [`Model`](../apply_api/model) - [`Listener`](../apply_api/listener) @@ -29,7 +29,7 @@ pre- and post-processing, and encoding/ decoding data into/ from the correct typ `db.apply(model)` tells `superduper` to store the model and its metadata in the system. If additional configurations, such as training parameters, are added to the `Model` then the `db.apply` command -will also train the component on data in Superduper. +will also train the component on data in superduper. Read more about `Model` [here](../apply_api/model). @@ -41,7 +41,7 @@ Read more about `Listener` [here](../apply_api/listener). ### `VectorIndex` -A `VectorIndex` wraps one or two `Listener` components, and tells Superduper that the outputs computed, should +A `VectorIndex` wraps one or two `Listener` components, and tells `superduper` that the outputs computed, should be made searchable via vector-search queries. Read more about `VectorIndex` [here](../apply_api/vector_index). @@ -49,9 +49,9 @@ Read more about `VectorIndex` [here](../apply_api/vector_index). ## Connecting component: `Stack` A `Stack` of AI functionality is a combination of multiple `Model`, `Listener`, and `VectorIndex` components which may be "applied" in -one pass to your data via Superduper. +one pass to your data via superduper. -On `db.add(stack)` Superduper performs the heavy lifting of deciding which components need to be applied +On `db.add(stack)` superduper performs the heavy lifting of deciding which components need to be applied first, which need to be modified on incoming data, and which outputs need to be made searchable. Read more about `Stack` [here](../apply_api/stack). diff --git a/docs/content/core_api/connect.md b/docs/content/core_api/connect.md index 5d503532b..0f6aaa3ce 100644 --- a/docs/content/core_api/connect.md +++ b/docs/content/core_api/connect.md @@ -23,7 +23,7 @@ For a semi-exhaustive list of possible connections see [here](../reusable_snippe ### Fine grained configuration -Superduper chooses default `artifact_store` (file blob storage) and `metadata_store` (AI metadata) values for your connection. These defaults may be overridden directly: +`superduper` chooses default `artifact_store` (file blob storage) and `metadata_store` (AI metadata) values for your connection. These defaults may be overridden directly: ```python db = superduper( diff --git a/docs/content/core_api/execute.md b/docs/content/core_api/execute.md index 83d218197..40ec0e5b7 100644 --- a/docs/content/core_api/execute.md +++ b/docs/content/core_api/execute.md @@ -1,6 +1,6 @@ # Execute -`db.execute` is Superduper's wrapper around standard database queries: +`db.execute` is superduper's wrapper around standard database queries: - Inserts - Selects diff --git a/docs/content/core_api/intro.md b/docs/content/core_api/intro.md index f1da3a38a..6da8600ec 100644 --- a/docs/content/core_api/intro.md +++ b/docs/content/core_api/intro.md @@ -1,6 +1,6 @@ -# Core Superduper usage +# Core superduper usage -In this section we walk through how to perform the key operations with Superduper. +In this section we walk through how to perform the key operations with superduper. There are three key patterns C-A-E: ***Connect*** diff --git a/docs/content/execute_api/native_vector_search.md b/docs/content/execute_api/native_vector_search.md index d571d1356..b665ab020 100644 --- a/docs/content/execute_api/native_vector_search.md +++ b/docs/content/execute_api/native_vector_search.md @@ -16,7 +16,7 @@ cluster: export SUPERDUPER_CLUSTER_VECTOR_SEARCH_TYPE=native ``` -If Superduper detects this configuration, it uses the inbuilt mechanism +If `superduper` detects this configuration, it uses the inbuilt mechanism of your `db.databackend` to perform the vector-comparison. Currently Superduper supports the native implementation of these databases: