From 1a8c3daa8694920c8d1225cb979bd64c6922ee32 Mon Sep 17 00:00:00 2001 From: TheDude Date: Tue, 6 Aug 2024 16:49:32 +0530 Subject: [PATCH 1/2] Fix some links in docs --- docs/content/apply_api/component.md | 4 ++-- docs/content/fundamentals/datalayer_overview.md | 4 ++-- docs/content/fundamentals/vector_search_algorithm.md | 2 +- docs/content/get_started/configuration.md | 4 ++-- docs/content/production/development_vs_cluster_mode.md | 4 ++-- docs/content/tutorials/rag.md | 2 +- docs/content/tutorials/vector_search.md | 2 +- 7 files changed, 11 insertions(+), 11 deletions(-) diff --git a/docs/content/apply_api/component.md b/docs/content/apply_api/component.md index 2c51cceb8..2f97cedaa 100644 --- a/docs/content/apply_api/component.md +++ b/docs/content/apply_api/component.md @@ -69,7 +69,7 @@ my_component |_982378978978978798 ``` -You can read about the serialization mechanism [here](../production/yaml_formalism.md). +You can read about the serialization mechanism [here](../production/superduper_protocol.md.md). ## Read more @@ -77,4 +77,4 @@ You can read about the serialization mechanism [here](../production/yaml_formali import DocCardList from '@theme/DocCardList'; -``` \ No newline at end of file +``` diff --git a/docs/content/fundamentals/datalayer_overview.md b/docs/content/fundamentals/datalayer_overview.md index 8c18de3d6..b9d92f5ab 100644 --- a/docs/content/fundamentals/datalayer_overview.md +++ b/docs/content/fundamentals/datalayer_overview.md @@ -46,7 +46,7 @@ specific to `superduper`. Read more [here](../data_integrations/supported_query_APIs.md). -The databackend is configured by setting the URI `CFG.databackend` in the [configuration system](../setup/configuration.md). +The databackend is configured by setting the URI `CFG.databackend` in the [configuration system](../get_started/configuration.md). We support the same databackends as supported by the [`ibis` project](https://ibis-project.org/): @@ -196,4 +196,4 @@ Validate your components (mostly models) ### `db.predict` -Infer predictions from models hosted by `superduper`. Read more about this and about models [here](../walkthrough/apply_models.md). +Infer predictions from models hosted by `superduper`. Read more about this and about models [here](../apply_api/model.md). diff --git a/docs/content/fundamentals/vector_search_algorithm.md b/docs/content/fundamentals/vector_search_algorithm.md index 3c90d0352..b6d4b03e2 100644 --- a/docs/content/fundamentals/vector_search_algorithm.md +++ b/docs/content/fundamentals/vector_search_algorithm.md @@ -50,4 +50,4 @@ The most similar `ids` are retrieved. The `select` part of the query is then tra a similar query which searches within the retrieved `ids`. The full set of results are returned to the client. -Read [here](../walkthrough/vector_search.md) about setting up and detailed usage of vector-search. +Read [here](../tutorials/vector_search.md) about setting up and detailed usage of vector-search. diff --git a/docs/content/get_started/configuration.md b/docs/content/get_started/configuration.md index aa075fc57..209d2f8f5 100644 --- a/docs/content/get_started/configuration.md +++ b/docs/content/get_started/configuration.md @@ -13,7 +13,7 @@ Configurations can either be injected: - in a YAML file specified by the `SUPERDUPER_CONFIG_FILE` environment variable or - through environment variables starting with `SUPERDUPER_`: -- as `**kwargs` when calling the [`superduper.superduper`](./connecting.md) function (note this is only for development purposes). +- as `**kwargs` when calling the [`superduper.superduper`](../core_api/connect.md) function (note this is only for development purposes). Here are the configurable settings and their project defaults (remaining configurations can be viewed in [`superduper.base.config`](https://github.com/superduper/superduper/blob/main/superduper/base/config.py)). Note that as much or as little of this configuration can be specified. The remaining @@ -115,4 +115,4 @@ You may view the configuration used by the system with: ```bash python -m superduper config -``` \ No newline at end of file +``` diff --git a/docs/content/production/development_vs_cluster_mode.md b/docs/content/production/development_vs_cluster_mode.md index c6737b0ed..360a18833 100644 --- a/docs/content/production/development_vs_cluster_mode.md +++ b/docs/content/production/development_vs_cluster_mode.md @@ -1,6 +1,6 @@ # Developer vs. production mode -Please refer to the [architecture](../fundamentals/architecture.md) page for a detailed description of the `superduper` architecture. +Please refer to the [architecture](../fundamentals/design.md) page for a detailed description of the `superduper` architecture. There are several important services in a `superduper` setup which may be run in-process, or in their own micro-services and containers: @@ -35,4 +35,4 @@ In the most distributed case we have: - A [**vector-search** service](vector_comparison_service), which finds similar vectors, given an input vector - A [**REST** server](./rest_api) -In the remainder of this section we describe the use of each of these services \ No newline at end of file +In the remainder of this section we describe the use of each of these services diff --git a/docs/content/tutorials/rag.md b/docs/content/tutorials/rag.md index 2a0518725..7c520efe5 100644 --- a/docs/content/tutorials/rag.md +++ b/docs/content/tutorials/rag.md @@ -112,7 +112,7 @@ This gives users great flexibility with regard to how they fetch the context for their downstream models. We're using OpenAI, but you can use any type of LLm with `superduper`. We have several -native integrations (see [here](../ai_integraitons/)) but you can also [bring your own model](../models/bring_your_own_model.md). +native integrations (see [here](../ai_integraitons/)) but you can also [bring your own model](../models/bring_your_own_models.md). ```python from superduper.ext.llm.prompter import * diff --git a/docs/content/tutorials/vector_search.md b/docs/content/tutorials/vector_search.md index 05fd68341..f10101478 100644 --- a/docs/content/tutorials/vector_search.md +++ b/docs/content/tutorials/vector_search.md @@ -1246,7 +1246,7 @@ for r in cursor: a similar query which searches within the retrieved `ids`. The full set of results are returned to the client. - Read [here](../walkthrough/vector_search.md) about setting up and detailed usage of vector-search. + Read [here](../execute_api/vector_search.md) about setting up and detailed usage of vector-search. ==================================================================================================== ==================================================================================================== From df4e9d38d4d28a7a7cc211a4d9a73a647a0846f7 Mon Sep 17 00:00:00 2001 From: TheDude Date: Tue, 6 Aug 2024 16:50:36 +0530 Subject: [PATCH 2/2] Update changelog --- CHANGELOG.md | 1 + docs/content/apply_api/component.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index aaac913fe..51d240aa2 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -48,6 +48,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Fix vector_index function job. - Fix verbosity in component info - Change default encoding to sqlvector +- Fix some links in documentation ## [0.3.0](https://github.com/superduper-io/superduper/compare/0.3.0...0.2.0]) (2024-Jun-21) diff --git a/docs/content/apply_api/component.md b/docs/content/apply_api/component.md index 2f97cedaa..ba4263f99 100644 --- a/docs/content/apply_api/component.md +++ b/docs/content/apply_api/component.md @@ -69,7 +69,7 @@ my_component |_982378978978978798 ``` -You can read about the serialization mechanism [here](../production/superduper_protocol.md.md). +You can read about the serialization mechanism [here](../production/superduper_protocol.md). ## Read more