Add-sizing-tool

docs/deploy/tools/index.md

@@ -0,0 +1,3 @@
+---
+title: Weaviate Tooling
+---

docs/deploy/tools/sizing-calculator-tool.md

@@ -0,0 +1,58 @@
+---
+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. 
+
+[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
+
+#### 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
+
+
+## Questions and feedback
+
+import DocsFeedback from '/_includes/docs-feedback.mdx';
+
+<DocsFeedback/>

docs/deploy/tutorials/index.mdx

@@ -29,6 +29,7 @@ export const advancedFeaturesData = [
 <br />
 <CardsSection items={advancedFeaturesData} />
 <br />
+
 ## Questions and feedback
 
 import DocsFeedback from '/_includes/docs-feedback.mdx';

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"},*/

sidebars.js

@@ -1008,6 +1008,13 @@ const sidebars = {
       label: "RBAC",
       id: "deploy/tutorials/rbac",
     },
+  ],
+    deployToolsSidebar: [
+    {
+      type: "doc",
+      label: "Resource Sizing Tool",
+      id: "deploy/tools/sizing-calculator-tool",
+    },
   ],
   deployFaqsSidebar: [
     {