Skip to content

Commit

Permalink
Minor updates in package
Browse files Browse the repository at this point in the history
  • Loading branch information
fazlulkarimweb authored and blythed committed Aug 15, 2024
1 parent 3f3420d commit 890d4ba
Show file tree
Hide file tree
Showing 5 changed files with 10 additions and 10 deletions.
10 changes: 5 additions & 5 deletions docs/content/core_api/apply.md
Original file line number Diff line number Diff line change
@@ -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)
Expand Down Expand Up @@ -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).

Expand All @@ -41,17 +41,17 @@ 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).

## 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).
Expand Down
2 changes: 1 addition & 1 deletion docs/content/core_api/connect.md
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down
2 changes: 1 addition & 1 deletion docs/content/core_api/execute.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/content/core_api/intro.md
Original file line number Diff line number Diff line change
@@ -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***
Expand Down
2 changes: 1 addition & 1 deletion docs/content/execute_api/native_vector_search.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down

0 comments on commit 890d4ba

Please sign in to comment.