From 93ef1c2ea63a1bd42ed778d58f12b3e5475635a0 Mon Sep 17 00:00:00 2001 From: DanielleWashington Date: Fri, 5 Sep 2025 13:07:02 -0400 Subject: [PATCH 1/2] adding sizing tool and tools section --- docs/deploy/tools/index.md | 0 docs/deploy/tools/sizing-calculator-tool.md | 18 ++++++++++++++++++ secondaryNavbar.js | 1 + sidebars.js | 6 ++++++ 4 files changed, 25 insertions(+) create mode 100644 docs/deploy/tools/index.md create mode 100644 docs/deploy/tools/sizing-calculator-tool.md diff --git a/docs/deploy/tools/index.md b/docs/deploy/tools/index.md new file mode 100644 index 00000000..e69de29b diff --git a/docs/deploy/tools/sizing-calculator-tool.md b/docs/deploy/tools/sizing-calculator-tool.md new file mode 100644 index 00000000..3d986b65 --- /dev/null +++ b/docs/deploy/tools/sizing-calculator-tool.md @@ -0,0 +1,18 @@ +--- +title: Weaviate Resource Sizing Calculator +--- + +## Overview + +The Weaviate Resource Sizing tool is a **community-created** calculator designed to help estimate memory, CPU, and storage requirements for your Weaviate deployments. The guidance is based on official Weaviate documentation and benchmarks to assist with capacity and resource planning and allocation. + +## :rotating_light: Important disclaimers + +### Features + +#### Memory planning + +#### CPU planning + +#### Storage planning + diff --git a/secondaryNavbar.js b/secondaryNavbar.js index 621571d6..ee43bdda 100644 --- a/secondaryNavbar.js +++ b/secondaryNavbar.js @@ -68,6 +68,7 @@ const secondaryNavbarItems = { /*{ label: "Kubernetes", link: "/deploy/k8s", sidebar: "deployK8sSidebar" },*/ { label: "Production Guides", link: "/deploy/production", sidebar: "deployProductionSidebar"}, { label: "Tutorials", link: "/deploy/tutorials/rbac", sidebar: "deployTutorialSidebar"}, + { label: "Tools", link: "/deploy/tools", sidebar: "deployToolsSidebar"}, /*{ label: "AWS", link: "/deploy/aws", sidebar: "deployAwsSidebar" },*/ /*{ label: "Scaling Strategies", link: "/deploy/scaling-strategies", sidebar: "deployScalingSidebar"},*/ /*{ label: "Monitoring and Observability", link: "/deploy/monitoring-obs", sidebar: "deployObservabilitySidebar"},*/ diff --git a/sidebars.js b/sidebars.js index 30203c35..3f4fda81 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1008,6 +1008,12 @@ const sidebars = { label: "RBAC", id: "deploy/tutorials/rbac", }, + ], + deployToolsSidebar: [ + { + type: "autogenerated", + dirName: "deploy/tools", + }, ], deployFaqsSidebar: [ { From 5c029f70d5351f0af41e4ec8624a299ba6bf84ff Mon Sep 17 00:00:00 2001 From: DanielleWashington Date: Mon, 8 Sep 2025 15:39:55 -0400 Subject: [PATCH 2/2] added landing page and initial info about tool and updated sidebar --- docs/deploy/tools/index.md | 3 ++ docs/deploy/tools/sizing-calculator-tool.md | 46 +++++++++++++++++++-- docs/deploy/tutorials/index.mdx | 1 + sidebars.js | 5 ++- 4 files changed, 50 insertions(+), 5 deletions(-) diff --git a/docs/deploy/tools/index.md b/docs/deploy/tools/index.md index e69de29b..33fa6a0d 100644 --- a/docs/deploy/tools/index.md +++ b/docs/deploy/tools/index.md @@ -0,0 +1,3 @@ +--- +title: Weaviate Tooling +--- \ No newline at end of file diff --git a/docs/deploy/tools/sizing-calculator-tool.md b/docs/deploy/tools/sizing-calculator-tool.md index 3d986b65..efd35420 100644 --- a/docs/deploy/tools/sizing-calculator-tool.md +++ b/docs/deploy/tools/sizing-calculator-tool.md @@ -6,13 +6,53 @@ title: Weaviate Resource Sizing Calculator The Weaviate Resource Sizing tool is a **community-created** calculator designed to help estimate memory, CPU, and storage requirements for your Weaviate deployments. The guidance is based on official Weaviate documentation and benchmarks to assist with capacity and resource planning and allocation. +[Resource Sizing Calculator](https://weaviate-memory-cpu-calculator.streamlit.app/) + + ## :rotating_light: Important disclaimers +:::warning Community tool + +This sizing tool is **community-created and maintained** and based on Weaviate's official documentation. This should be used as a **guidance tool only.** + +- This tool is subject to change and may not reflect the latest Weaviate features or optimizations. +- Calculations may vary from actual production requirements. +- For capacity planning, the results should be used as a starting point. +- Additional configuration may be required based on your specific use case. +::: + +:::tip Best practice +Before deploying to your production environment, validate these estimates against your actual workloads and perform thorough testing. +::: + ### Features -#### Memory planning +#### Calculations + +- Memory formula with 2x garbage collection overhead +- HNSW calculation +- CPU formula +- All compression methods supported + +#### Comprehensive resource planning + +- Memory requirements with and without compression +- CPU calculations based on target QPS and latency +- Disk storage estimates +- Deployment recommendations + +#### Compression methods + +- Product quantization (PQ): 85% memory reduction for the **best balance** +- Binary quantization (BQ): 97% memory reduction for **maximum savings** +- Scalar quantization (SQ): 75% memory reduction for **fast compression** +- Rotational quantization (RQ): 75% memory reduction with **no training required** + +### Sizing tool demo + -#### CPU planning +## Questions and feedback -#### Storage planning +import DocsFeedback from '/_includes/docs-feedback.mdx'; + diff --git a/docs/deploy/tutorials/index.mdx b/docs/deploy/tutorials/index.mdx index a41d1894..ae92e56d 100644 --- a/docs/deploy/tutorials/index.mdx +++ b/docs/deploy/tutorials/index.mdx @@ -29,6 +29,7 @@ export const advancedFeaturesData = [

+ ## Questions and feedback import DocsFeedback from '/_includes/docs-feedback.mdx'; diff --git a/sidebars.js b/sidebars.js index 3f4fda81..f874f947 100644 --- a/sidebars.js +++ b/sidebars.js @@ -1011,8 +1011,9 @@ const sidebars = { ], deployToolsSidebar: [ { - type: "autogenerated", - dirName: "deploy/tools", + type: "doc", + label: "Resource Sizing Tool", + id: "deploy/tools/sizing-calculator-tool", }, ], deployFaqsSidebar: [