From ec11f1ddb8549f7eda345525c0382fe60282b571 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Thu, 30 Jan 2025 12:04:28 +0530 Subject: [PATCH 01/17] summary.md ia mapping --- docs-gb/SUMMARY.md | 86 +++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 85 insertions(+), 1 deletion(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 8aaca430a2..95f009e884 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -1,6 +1,90 @@ # Table of contents +* [About](README.md) -* [Overview](README.md) +## Installation +* [Installing Seldon Core 2](installation/README.md) + * [Learning Environment](installation/learning-environment/README.md) + * [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md) + * [Production Environment](installation/production-environment/README.md) + * [Kafka Integration](installation/production-environment/kafka/README.md) + * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) + * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) + * [Test the Installation](installation/test-installation.md) +## User Guide +* [Getting Started] + * Deploy Model (OIP+MLServer Link) + * Pipeline + * Inference Server + * Run Inference + * Kubernetes Resources +* [Servers](kubernetes/resources/server.md) + * [Server Config](kubernetes/resources/serverconfig.md) + * [Resource allocation](resource-allocation/README.md) + * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) +* Models + * CRD + * Registration + * Versioning + * LLM + * Parameterized Models + * Links to Secret Management +* Inference + * [Inference Server](https://docs.seldon.io/projects/seldon-core/en/v2/contents/about/index.html#inference-servers) + * [Run Inference](https://docs.seldon.io/projects/seldon-core/en/v2/contents/inference/index.html) + * [OIP](apis/inference/v2.md) + * [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md) +* Pipelines + * [Scaling](kubernetes/scaling.md) + * Server Scaling + * Component Scaling + * [Autoscaling](kubernetes/autoscaling.md) + * Multi-Component Serving and Overcommit + * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) +* Data Science Monitoring + * Dataflow with Kafka + * Request & Response Logging + * [Model Performance Metrics](performance-tests.md) + * [Drift Detection](drift.md) + * [Outlier Detection](outlier.md) + * [Explainability](explainers.md) +* Operational Monitoring + * [Operational Metrics](metrics/operational.md) + * Kubernetes Metrics + * [Usage Metrics](metrics/usage.md) + * [Tracing](kubernetes/tracing.md) + * Performance Tests + * Performance Tuning +* Rollouts & Experiments + * Rollout Strategies + * Progressive Rollouts + * Rollbacks + * Experiments + * A/B Testing + * Traffic Splitting + * Canary + * Shadow + * CI/CD + * Link to Component Versioning +## Resources +* Troubleshooting +* Tutorials +* [Security](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/kubernetes-installation/security/index.html) + * [Secure Model Endpoints](models/securing-endpoints.md) + * Authentication + * Authorization + * Secrets Management +* Integrations + * Audit Trails + * Alerts + * Data Management + * Modules +* APIs + * API Reference + * Internal APIs + * [CLI](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/cli.html) +* Reference + * Glossary +* FAQs * [Getting Started](getting-started/README.md) * [Docker Installation](getting-started/docker-installation.md) * [Kubernetes Installation](getting-started/kubernetes-installation/README.md) From a03456b3f30b603fa0f1b1404b1e70c4f51277ce Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Wed, 19 Feb 2025 14:28:08 +0530 Subject: [PATCH 02/17] Update SUMMARY.md removed the orphaned topics - [Outlier Detection] - [Drift Detection] - [Explainers] Because they have a place in the new IA under: - Data Science Monitoring - Dataflow with Kafka - Request & Response Logging - Model Performance Metrics - Drift Detection - Outlier Detection - Explainability --- docs-gb/SUMMARY.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 95f009e884..d35ada202c 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -11,7 +11,7 @@ * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) * [Test the Installation](installation/test-installation.md) ## User Guide -* [Getting Started] +* Getting Started * Deploy Model (OIP+MLServer Link) * Pipeline * Inference Server @@ -204,9 +204,6 @@ * [Experiments](experiments.md) * [Servers](servers.md) * [Inference](inference.md) -* [Outlier Detection](outlier.md) -* [Drift Detection](drift.md) -* [Explainers](explainers.md) * [Performance Tests](performance-tests.md) * [Upgrading](upgrading.md) * [FAQ](faqs.md) From 42306f35bfd7f560a37c6680686dae39b7832885 Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Thu, 20 Feb 2025 16:05:12 +0530 Subject: [PATCH 03/17] Update SUMMARY.md - moved scaling one level up --- docs-gb/SUMMARY.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index d35ada202c..74819fe7d7 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -34,12 +34,12 @@ * [OIP](apis/inference/v2.md) * [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md) * Pipelines - * [Scaling](kubernetes/scaling.md) - * Server Scaling - * Component Scaling - * [Autoscaling](kubernetes/autoscaling.md) - * Multi-Component Serving and Overcommit - * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) +* [Scaling](kubernetes/scaling.md) + * Server Scaling + * Component Scaling + * [Autoscaling](kubernetes/autoscaling.md) + * Multi-Component Serving and Overcommit + * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) * Data Science Monitoring * Dataflow with Kafka * Request & Response Logging From 1f4e741954a5b62c51e02990e4b2ee85ac68c0bc Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Thu, 20 Feb 2025 17:53:15 +0530 Subject: [PATCH 04/17] Update SUMMARY.md incorporated the changes that Paul suggested. --- docs-gb/SUMMARY.md | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 74819fe7d7..64ea1bb635 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -10,6 +10,10 @@ * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) * [Test the Installation](installation/test-installation.md) + * Advanced Configurations + * [Server Config](kubernetes/resources/serverconfig.md) + * [Server Runtime](kubernetes/resources/seldonruntime.md) + * [Seldon Config](kubernetes/resources/seldonconfig.md) ## User Guide * Getting Started * Deploy Model (OIP+MLServer Link) @@ -18,10 +22,9 @@ * Run Inference * Kubernetes Resources * [Servers](kubernetes/resources/server.md) - * [Server Config](kubernetes/resources/serverconfig.md) * [Resource allocation](resource-allocation/README.md) * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) -* Models +* [Models](kubernetes/resources/model.md) * CRD * Registration * Versioning @@ -33,7 +36,7 @@ * [Run Inference](https://docs.seldon.io/projects/seldon-core/en/v2/contents/inference/index.html) * [OIP](apis/inference/v2.md) * [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md) -* Pipelines +* [Pipelines](kubernetes/resources/pipeline.md) * [Scaling](kubernetes/scaling.md) * Server Scaling * Component Scaling @@ -64,7 +67,13 @@ * Canary * Shadow * CI/CD - * Link to Component Versioning + * Link to Component Versioning +## Integrations + * [Service Meshes](kubernetes/service-meshes/README.md) + * [Ambassador](kubernetes/service-meshes/ambassador.md) + * [Istio](kubernetes/service-meshes/istio.md) + * [Traefik](kubernetes/service-meshes/traefik.md) + ## Resources * Troubleshooting * Tutorials @@ -146,14 +155,6 @@ * [Model](kubernetes/resources/model.md) * [Experiment](kubernetes/resources/experiment.md) * [Pipeline](kubernetes/resources/pipeline.md) - * [Server](kubernetes/resources/server.md) - * [Server Config](kubernetes/resources/serverconfig.md) - * [Server Runtime](kubernetes/resources/seldonruntime.md) - * [Seldon Config](kubernetes/resources/seldonconfig.md) - * [Service Meshes](kubernetes/service-meshes/README.md) - * [Ambassador](kubernetes/service-meshes/ambassador.md) - * [Istio](kubernetes/service-meshes/istio.md) - * [Traefik](kubernetes/service-meshes/traefik.md) * [Resource allocation](resource-allocation/README.md) * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) * [Models](models/README.md) From f08002c7dda59c777b619e050fa9345545036807 Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Thu, 20 Feb 2025 17:56:05 +0530 Subject: [PATCH 05/17] Update SUMMARY.md Found a place for experiments --- docs-gb/SUMMARY.md | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 64ea1bb635..7a9fd8884e 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -61,7 +61,7 @@ * Rollout Strategies * Progressive Rollouts * Rollbacks - * Experiments + * [Experiments](kubernetes/resources/experiment.md) * A/B Testing * Traffic Splitting * Canary @@ -152,9 +152,6 @@ * [Kafka](kubernetes/kafka.md) * [Metrics](kubernetes/metrics.md) * [Resources](kubernetes/resources/README.md) - * [Model](kubernetes/resources/model.md) - * [Experiment](kubernetes/resources/experiment.md) - * [Pipeline](kubernetes/resources/pipeline.md) * [Resource allocation](resource-allocation/README.md) * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) * [Models](models/README.md) From 5278153565602a526165d5385eef1c87fc2b8a3e Mon Sep 17 00:00:00 2001 From: Rajakavitha Kodhandapani Date: Thu, 20 Feb 2025 18:01:23 +0530 Subject: [PATCH 06/17] Update SUMMARY.md --- docs-gb/SUMMARY.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 7a9fd8884e..b69cfdfe43 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -94,22 +94,6 @@ * Reference * Glossary * FAQs -* [Getting Started](getting-started/README.md) - * [Docker Installation](getting-started/docker-installation.md) - * [Kubernetes Installation](getting-started/kubernetes-installation/README.md) - * [Ansible](getting-started/kubernetes-installation/ansible.md) - * [Helm](getting-started/kubernetes-installation/helm.md) - * [Security](getting-started/kubernetes-installation/security/README.md) - * [AWS MSK mTLS](getting-started/kubernetes-installation/security/aws-msk-mtls.md) - * [AWS MSK SASL](getting-started/kubernetes-installation/security/aws-msk-sasl.md) - * [Azure Event Hub SASL Example](getting-started/kubernetes-installation/security/azure-event-hub-sasl.md) - * [Confluent Cloud Oauth 2.0 Example](getting-started/kubernetes-installation/security/confluent-oauth.md) - * [Confluent Cloud SASL Example](getting-started/kubernetes-installation/security/confluent-sasl.md) - * [Strimzi mTLS Example](getting-started/kubernetes-installation/security/strimzi-mtls.md) - * [Strimzi SASL Example](getting-started/kubernetes-installation/security/strimzi-sasl.md) - * [Reference](getting-started/kubernetes-installation/security/reference.md) - * [Configuration](getting-started/configuration.md) - * [Managed Kafka](getting-started/managed-kafka.md) * [Seldon CLI](getting-started/cli.md) * [APIs](apis/README.md) * [Internal](apis/internal/README.md) @@ -144,9 +128,6 @@ * [Conditional pipeline with pandas query model](examples/pandasquery.md) * [Kubernetes Server with PVC](examples/k8s-pvc.md) * [Kubernetes](kubernetes/README.md) - * [Scaling](kubernetes/scaling.md) - * [Autoscaling](kubernetes/autoscaling.md) - * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) * [Tracing](kubernetes/tracing.md) * [Storage Secrets](kubernetes/storage-secrets.md) * [Kafka](kubernetes/kafka.md) From 73df9d3f6b7c67e216489cd9c72a3b906cf40fec Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Tue, 25 Feb 2025 13:35:35 +0530 Subject: [PATCH 07/17] incoporate pauls suggestions --- docs-gb/SUMMARY.md | 132 +++++++++++++++++++++++---------------------- 1 file changed, 68 insertions(+), 64 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index b69cfdfe43..b48f0f86fa 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -1,6 +1,14 @@ # Table of contents * [About](README.md) +## Concepts +* Data-Centric MLOps +* Servers +* OIP +* Components +* Pipelines +* [Experiments](experiments.md) + ## Installation * [Installing Seldon Core 2](installation/README.md) * [Learning Environment](installation/learning-environment/README.md) @@ -14,29 +22,35 @@ * [Server Config](kubernetes/resources/serverconfig.md) * [Server Runtime](kubernetes/resources/seldonruntime.md) * [Seldon Config](kubernetes/resources/seldonconfig.md) + * [Pipeline Config](kubernetes/resources/pipeline.md) ## User Guide * Getting Started * Deploy Model (OIP+MLServer Link) * Pipeline * Inference Server * Run Inference - * Kubernetes Resources -* [Servers](kubernetes/resources/server.md) + * [Kubernetes Resources](kubernetes/resources/README.md) +* [Servers](servers.md) * [Resource allocation](resource-allocation/README.md) * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) -* [Models](kubernetes/resources/model.md) +* [Models](models/README.md) * CRD * Registration * Versioning * LLM * Parameterized Models - * Links to Secret Management + * Links to Secret Management + * [Multi-Model Serving](models/mms.md) + * [Inference Artifacts](models/inference-artifacts.md) + * [rClone](models/rclone.md) + * [Parameterized Models](models/parameterized-models/README.md) + * [Pandas Query](models/parameterized-models/pandasquery.md) * Inference * [Inference Server](https://docs.seldon.io/projects/seldon-core/en/v2/contents/about/index.html#inference-servers) * [Run Inference](https://docs.seldon.io/projects/seldon-core/en/v2/contents/inference/index.html) * [OIP](apis/inference/v2.md) * [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md) -* [Pipelines](kubernetes/resources/pipeline.md) +* [Pipelines](pipelines.md) * [Scaling](kubernetes/scaling.md) * Server Scaling * Component Scaling @@ -44,7 +58,7 @@ * Multi-Component Serving and Overcommit * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) * Data Science Monitoring - * Dataflow with Kafka + * [Dataflow with Kafka](architecture/dataflow.md) * Request & Response Logging * [Model Performance Metrics](performance-tests.md) * [Drift Detection](drift.md) @@ -73,28 +87,19 @@ * [Ambassador](kubernetes/service-meshes/ambassador.md) * [Istio](kubernetes/service-meshes/istio.md) * [Traefik](kubernetes/service-meshes/traefik.md) + * Audit Trails + * Alerts + * Data Management + * Modules ## Resources * Troubleshooting * Tutorials -* [Security](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/kubernetes-installation/security/index.html) +* [Security](/getting-started/kubernetes-installation/security/index.html) * [Secure Model Endpoints](models/securing-endpoints.md) * Authentication * Authorization * Secrets Management -* Integrations - * Audit Trails - * Alerts - * Data Management - * Modules -* APIs - * API Reference - * Internal APIs - * [CLI](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/cli.html) -* Reference - * Glossary -* FAQs - * [Seldon CLI](getting-started/cli.md) * [APIs](apis/README.md) * [Internal](apis/internal/README.md) * [Chainer](apis/internal/chainer.md) @@ -103,7 +108,6 @@ * [Open Inference Protocol](apis/inference/v2.md) * [Scheduler](apis/scheduler.md) * [Architecture](architecture/README.md) - * [DataFlow](architecture/dataflow.md) * [Examples](examples/README.md) * [Local examples](examples/local-examples.md) * [Kubernetes examples](examples/k8s-examples.md) @@ -126,22 +130,54 @@ * [Production image classifier with drift and outlier monitoring](examples/cifar10.md) * [Production income classifier with drift, outlier and explanations](examples/income.md) * [Conditional pipeline with pandas query model](examples/pandasquery.md) - * [Kubernetes Server with PVC](examples/k8s-pvc.md) + * [Kubernetes Server with PVC](examples/k8s-pvc.md) + +* APIs + * API Reference + * Internal APIs + * [Seldon CLI](getting-started/cli.md) + * [CLI](cli/README.md) + * [Seldon](cli/seldon.md) + * [Config](cli/seldon\_config.md) + * [Config Activate](cli/seldon\_config\_activate.md) + * [Config Deactivate](cli/seldon\_config\_deactivate.md) + * [Config Add](cli/seldon\_config\_add.md) + * [Config List](cli/seldon\_config\_list.md) + * [Config Remove](cli/seldon\_config\_remove.md) + * [Experiment](cli/seldon\_experiment.md) + * [Experiment Start](cli/seldon\_experiment\_start.md) + * [Experiment Status](cli/seldon\_experiment\_status.md) + * [Experiment List](cli/seldon\_experiment\_list.md) + * [Experiment Stop](cli/seldon\_experiment\_stop.md) + * [Model](cli/seldon\_model.md) + * [Model Status](cli/seldon\_model\_status.md) + * [Model Load](cli/seldon\_model\_load.md) + * [Model List](cli/seldon\_model\_list.md) + * [Model Infer](cli/seldon\_model\_infer.md) + * [Model Metadata](cli/seldon\_model\_metadata.md) + * [Model Unload](cli/seldon\_model\_unload.md) + * [Pipeline](cli/seldon\_pipeline.md) + * [Pipeline Load](cli/seldon\_pipeline\_load.md) + * [Pipeline Status](cli/seldon\_pipeline\_status.md) + * [Pipeline List](cli/seldon\_pipeline\_list.md) + * [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md) + * [Pipeline Infer](cli/seldon\_pipeline\_infer.md) + * [Pipeline Unload](cli/seldon\_pipeline\_unload.md) + * [Server](cli/seldon\_server.md) + * [Server List](cli/seldon\_server\_list.md) + * [Server Status](cli/seldon\_server\_status.md) +* Reference + * Glossary +* FAQs + + * [Kubernetes](kubernetes/README.md) * [Tracing](kubernetes/tracing.md) * [Storage Secrets](kubernetes/storage-secrets.md) * [Kafka](kubernetes/kafka.md) * [Metrics](kubernetes/metrics.md) * [Resources](kubernetes/resources/README.md) -* [Resource allocation](resource-allocation/README.md) - * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) -* [Models](models/README.md) - * [Multi-Model Serving](models/mms.md) - * [Inference Artifacts](models/inference-artifacts.md) - * [rClone](models/rclone.md) - * [Parameterized Models](models/parameterized-models/README.md) - * [Pandas Query](models/parameterized-models/pandasquery.md) - * [Securing Endpoints](models/securing-endpoints.md) + * [Metrics](metrics/README.md) * [Usage](metrics/usage.md) * [Operational](metrics/operational.md) @@ -149,39 +185,7 @@ * [Development](development/README.md) * [License](development/licenses.md) * [Release](development/release.md) -* [CLI](cli/README.md) - * [Seldon](cli/seldon.md) - * [Config](cli/seldon\_config.md) - * [Config Activate](cli/seldon\_config\_activate.md) - * [Config Deactivate](cli/seldon\_config\_deactivate.md) - * [Config Add](cli/seldon\_config\_add.md) - * [Config List](cli/seldon\_config\_list.md) - * [Config Remove](cli/seldon\_config\_remove.md) - * [Experiment](cli/seldon\_experiment.md) - * [Experiment Start](cli/seldon\_experiment\_start.md) - * [Experiment Status](cli/seldon\_experiment\_status.md) - * [Experiment List](cli/seldon\_experiment\_list.md) - * [Experiment Stop](cli/seldon\_experiment\_stop.md) - * [Model](cli/seldon\_model.md) - * [Model Status](cli/seldon\_model\_status.md) - * [Model Load](cli/seldon\_model\_load.md) - * [Model List](cli/seldon\_model\_list.md) - * [Model Infer](cli/seldon\_model\_infer.md) - * [Model Metadata](cli/seldon\_model\_metadata.md) - * [Model Unload](cli/seldon\_model\_unload.md) - * [Pipeline](cli/seldon\_pipeline.md) - * [Pipeline Load](cli/seldon\_pipeline\_load.md) - * [Pipeline Status](cli/seldon\_pipeline\_status.md) - * [Pipeline List](cli/seldon\_pipeline\_list.md) - * [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md) - * [Pipeline Infer](cli/seldon\_pipeline\_infer.md) - * [Pipeline Unload](cli/seldon\_pipeline\_unload.md) - * [Server](cli/seldon\_server.md) - * [Server List](cli/seldon\_server\_list.md) - * [Server Status](cli/seldon\_server\_status.md) -* [Pipelines](pipelines.md) -* [Experiments](experiments.md) -* [Servers](servers.md) + * [Inference](inference.md) * [Performance Tests](performance-tests.md) * [Upgrading](upgrading.md) From 2e21fe6c3a53e72cf8f1ea1b199b4985b9c4fa01 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Tue, 25 Feb 2025 13:37:57 +0530 Subject: [PATCH 08/17] moved one level up for some topics under integrations --- docs-gb/SUMMARY.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index b48f0f86fa..9c5231dce0 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -87,10 +87,10 @@ * [Ambassador](kubernetes/service-meshes/ambassador.md) * [Istio](kubernetes/service-meshes/istio.md) * [Traefik](kubernetes/service-meshes/traefik.md) - * Audit Trails - * Alerts - * Data Management - * Modules + * Audit Trails + * Alerts + * Data Management + * Modules ## Resources * Troubleshooting From 7fdcd6c9bf06b83083ef29000860b2a37475bfac Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Wed, 5 Mar 2025 10:13:28 +0530 Subject: [PATCH 09/17] is changes paul suggestions --- docs-gb/SUMMARY.md | 20 +++++++------------- 1 file changed, 7 insertions(+), 13 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 9c5231dce0..fb385d97ed 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -22,7 +22,8 @@ * [Server Config](kubernetes/resources/serverconfig.md) * [Server Runtime](kubernetes/resources/seldonruntime.md) * [Seldon Config](kubernetes/resources/seldonconfig.md) - * [Pipeline Config](kubernetes/resources/pipeline.md) + * [Pipeline Config](kubernetes/resources/pipeline.md) + * [Upgrading](upgrading.md) ## User Guide * Getting Started * Deploy Model (OIP+MLServer Link) @@ -69,7 +70,8 @@ * Kubernetes Metrics * [Usage Metrics](metrics/usage.md) * [Tracing](kubernetes/tracing.md) - * Performance Tests + * [Local Metrics](metrics/local-metrics-test.md) + * [Performance Tests](performance-tests.md) * Performance Tuning * Rollouts & Experiments * Rollout Strategies @@ -168,25 +170,17 @@ * [Server Status](cli/seldon\_server\_status.md) * Reference * Glossary -* FAQs +* [FAQs](faqs.md) * [Kubernetes](kubernetes/README.md) - * [Tracing](kubernetes/tracing.md) * [Storage Secrets](kubernetes/storage-secrets.md) * [Kafka](kubernetes/kafka.md) - * [Metrics](kubernetes/metrics.md) - * [Resources](kubernetes/resources/README.md) * [Metrics](metrics/README.md) - * [Usage](metrics/usage.md) - * [Operational](metrics/operational.md) - * [Local Metrics](metrics/local-metrics-test.md) + * [Development](development/README.md) * [License](development/licenses.md) * [Release](development/release.md) -* [Inference](inference.md) -* [Performance Tests](performance-tests.md) -* [Upgrading](upgrading.md) -* [FAQ](faqs.md) + From b356b919812dd3233f0279c3b1fe053b7f969b31 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Thu, 6 Mar 2025 12:20:06 +0530 Subject: [PATCH 10/17] paul's changes --- docs-gb/SUMMARY.md | 67 ++++++++++++++++---------------------- docs-gb/concepts/README.md | 7 ++++ 2 files changed, 35 insertions(+), 39 deletions(-) create mode 100644 docs-gb/concepts/README.md diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index d7de456d43..1cbc901cce 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -1,13 +1,6 @@ # Table of contents * [About](README.md) - -## Concepts -* Data-Centric MLOps -* Servers -* OIP -* Components -* Pipelines -* [Experiments](experiments.md) +* [Concepts](/docs-gb/concepts/README.md) ## Installation * [Installing Seldon Core 2](installation/README.md) @@ -25,7 +18,6 @@ * [Seldon Config](kubernetes/resources/seldonconfig.md) * [Pipeline Config](kubernetes/resources/pipeline.md) * [Upgrading](upgrading.md) - ## User Guide * Getting Started * Deploy Model (OIP+MLServer Link) @@ -48,6 +40,7 @@ * [rClone](models/rclone.md) * [Parameterized Models](models/parameterized-models/README.md) * [Pandas Query](models/parameterized-models/pandasquery.md) + * [Storage Secrets](kubernetes/storage-secrets.md) * Inference * [Inference Server](https://docs.seldon.io/projects/seldon-core/en/v2/contents/about/index.html#inference-servers) * [Run Inference](https://docs.seldon.io/projects/seldon-core/en/v2/contents/inference/index.html) @@ -86,12 +79,37 @@ * Shadow * CI/CD * Link to Component Versioning - +* [Examples](examples/README.md) + * [Local examples](examples/local-examples.md) + * [Kubernetes examples](examples/k8s-examples.md) + * [Huggingface models](examples/huggingface.md) + * [Model zoo](examples/model-zoo.md) + * [Artifact versions](examples/multi-version.md) + * [Pipeline examples](examples/pipeline-examples.md) + * [Pipeline to pipeline examples](examples/pipeline-to-pipeline.md) + * [Explainer examples](examples/explainer-examples.md) + * [Custom Servers](examples/custom-servers.md) + * [Local experiments](examples/local-experiments.md) + * [Experiment version examples](examples/experiment-versions.md) + * [Inference examples](examples/inference.md) + * [Tritonclient examples](examples/tritonclient-examples.md) + * [Batch Inference examples (kubernetes)](examples/batch-examples-k8s.md) + * [Batch Inference examples (local)](examples/batch-examples-local.md) + * [Checking Pipeline readiness](examples/pipeline-ready-and-metadata.md) + * [Multi-Namespace Kubernetes](examples/k8s-clusterwide.md) + * [Huggingface speech to sentiment with explanations pipeline](examples/speech-to-sentiment.md) + * [Production image classifier with drift and outlier monitoring](examples/cifar10.md) + * [Production income classifier with drift, outlier and explanations](examples/income.md) + * [Conditional pipeline with pandas query model](examples/pandasquery.md) + * [Kubernetes Server with PVC](examples/k8s-pvc.md) + + ## Integrations * [Service Meshes](kubernetes/service-meshes/README.md) * [Ambassador](kubernetes/service-meshes/ambassador.md) * [Istio](kubernetes/service-meshes/istio.md) * [Traefik](kubernetes/service-meshes/traefik.md) + * [Secure Model Endpoints](models/securing-endpoints.md) * Audit Trails * Alerts * Data Management @@ -101,7 +119,6 @@ * Troubleshooting * Tutorials * [Security](/getting-started/kubernetes-installation/security/index.html) - * [Secure Model Endpoints](models/securing-endpoints.md) * Authentication * Authorization * Secrets Management @@ -113,29 +130,6 @@ * [Open Inference Protocol](apis/inference/v2.md) * [Scheduler](apis/scheduler.md) * [Architecture](architecture/README.md) -* [Examples](examples/README.md) - * [Local examples](examples/local-examples.md) - * [Kubernetes examples](examples/k8s-examples.md) - * [Huggingface models](examples/huggingface.md) - * [Model zoo](examples/model-zoo.md) - * [Artifact versions](examples/multi-version.md) - * [Pipeline examples](examples/pipeline-examples.md) - * [Pipeline to pipeline examples](examples/pipeline-to-pipeline.md) - * [Explainer examples](examples/explainer-examples.md) - * [Custom Servers](examples/custom-servers.md) - * [Local experiments](examples/local-experiments.md) - * [Experiment version examples](examples/experiment-versions.md) - * [Inference examples](examples/inference.md) - * [Tritonclient examples](examples/tritonclient-examples.md) - * [Batch Inference examples (kubernetes)](examples/batch-examples-k8s.md) - * [Batch Inference examples (local)](examples/batch-examples-local.md) - * [Checking Pipeline readiness](examples/pipeline-ready-and-metadata.md) - * [Multi-Namespace Kubernetes](examples/k8s-clusterwide.md) - * [Huggingface speech to sentiment with explanations pipeline](examples/speech-to-sentiment.md) - * [Production image classifier with drift and outlier monitoring](examples/cifar10.md) - * [Production income classifier with drift, outlier and explanations](examples/income.md) - * [Conditional pipeline with pandas query model](examples/pandasquery.md) - * [Kubernetes Server with PVC](examples/k8s-pvc.md) * APIs * API Reference @@ -177,11 +171,6 @@ -* [Kubernetes](kubernetes/README.md) - * [Storage Secrets](kubernetes/storage-secrets.md) - * [Kafka](kubernetes/kafka.md) -* [Metrics](metrics/README.md) - * [Development](development/README.md) * [License](development/licenses.md) * [Release](development/release.md) diff --git a/docs-gb/concepts/README.md b/docs-gb/concepts/README.md new file mode 100644 index 0000000000..1f01d0a2a7 --- /dev/null +++ b/docs-gb/concepts/README.md @@ -0,0 +1,7 @@ +## Concepts +* Data-Centric MLOps +* Servers +* OIP +* Components +* Pipelines +* [Experiments](experiments.md) \ No newline at end of file From 95aaee1b5cf10aa8ece5fb9ff8311900eddd56d6 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Thu, 6 Mar 2025 16:16:04 +0530 Subject: [PATCH 11/17] incorporate Paul's feedback --- docs-gb/SUMMARY.md | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 1cbc901cce..a5bee0534c 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -1,16 +1,17 @@ # Table of contents * [About](README.md) * [Concepts](/docs-gb/concepts/README.md) +* [Architecture](architecture/README.md) ## Installation * [Installing Seldon Core 2](installation/README.md) - * [Learning Environment](installation/learning-environment/README.md) - * [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md) - * [Production Environment](installation/production-environment/README.md) - * [Kafka Integration](installation/production-environment/kafka/README.md) - * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) - * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) - * [Test the Installation](installation/test-installation.md) + * [Learning Environment](installation/learning-environment/README.md) + * [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md) + * [Production Environment](installation/production-environment/README.md) + * [Kafka Integration](installation/production-environment/kafka/README.md) + * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) + * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) + * [Test the Installation](installation/test-installation.md) * Advanced Configurations * [Server Config](kubernetes/resources/serverconfig.md) @@ -129,7 +130,6 @@ * [Inference](apis/inference/README.md) * [Open Inference Protocol](apis/inference/v2.md) * [Scheduler](apis/scheduler.md) -* [Architecture](architecture/README.md) * APIs * API Reference From 2652f3d4224eab4ac7281773e7ae33ea8c288450 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Thu, 6 Mar 2025 16:18:57 +0530 Subject: [PATCH 12/17] intro page changes --- docs-gb/SUMMARY.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index a5bee0534c..b90a7c58dc 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -1,5 +1,7 @@ # Table of contents -* [About](README.md) + +## About +* [Overview](README.md) * [Concepts](/docs-gb/concepts/README.md) * [Architecture](architecture/README.md) From 34096fa747b192b5265f3fce9ac4a73c79189638 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Thu, 6 Mar 2025 17:43:32 +0530 Subject: [PATCH 13/17] fix the API section --- docs-gb/SUMMARY.md | 66 ++++++++++++++++++++++------------------------ 1 file changed, 31 insertions(+), 35 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index b90a7c58dc..36da99f839 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -132,41 +132,37 @@ * [Inference](apis/inference/README.md) * [Open Inference Protocol](apis/inference/v2.md) * [Scheduler](apis/scheduler.md) - -* APIs - * API Reference - * Internal APIs - * [Seldon CLI](getting-started/cli.md) - * [CLI](cli/README.md) - * [Seldon](cli/seldon.md) - * [Config](cli/seldon\_config.md) - * [Config Activate](cli/seldon\_config\_activate.md) - * [Config Deactivate](cli/seldon\_config\_deactivate.md) - * [Config Add](cli/seldon\_config\_add.md) - * [Config List](cli/seldon\_config\_list.md) - * [Config Remove](cli/seldon\_config\_remove.md) - * [Experiment](cli/seldon\_experiment.md) - * [Experiment Start](cli/seldon\_experiment\_start.md) - * [Experiment Status](cli/seldon\_experiment\_status.md) - * [Experiment List](cli/seldon\_experiment\_list.md) - * [Experiment Stop](cli/seldon\_experiment\_stop.md) - * [Model](cli/seldon\_model.md) - * [Model Status](cli/seldon\_model\_status.md) - * [Model Load](cli/seldon\_model\_load.md) - * [Model List](cli/seldon\_model\_list.md) - * [Model Infer](cli/seldon\_model\_infer.md) - * [Model Metadata](cli/seldon\_model\_metadata.md) - * [Model Unload](cli/seldon\_model\_unload.md) - * [Pipeline](cli/seldon\_pipeline.md) - * [Pipeline Load](cli/seldon\_pipeline\_load.md) - * [Pipeline Status](cli/seldon\_pipeline\_status.md) - * [Pipeline List](cli/seldon\_pipeline\_list.md) - * [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md) - * [Pipeline Infer](cli/seldon\_pipeline\_infer.md) - * [Pipeline Unload](cli/seldon\_pipeline\_unload.md) - * [Server](cli/seldon\_server.md) - * [Server List](cli/seldon\_server\_list.md) - * [Server Status](cli/seldon\_server\_status.md) + * [Seldon CLI](getting-started/cli.md) + * [CLI](cli/README.md) + * [Seldon](cli/seldon.md) + * [Config](cli/seldon\_config.md) + * [Config Activate](cli/seldon\_config\_activate.md) + * [Config Deactivate](cli/seldon\_config\_deactivate.md) + * [Config Add](cli/seldon\_config\_add.md) + * [Config List](cli/seldon\_config\_list.md) + * [Config Remove](cli/seldon\_config\_remove.md) + * [Experiment](cli/seldon\_experiment.md) + * [Experiment Start](cli/seldon\_experiment\_start.md) + * [Experiment Status](cli/seldon\_experiment\_status.md) + * [Experiment List](cli/seldon\_experiment\_list.md) + * [Experiment Stop](cli/seldon\_experiment\_stop.md) + * [Model](cli/seldon\_model.md) + * [Model Status](cli/seldon\_model\_status.md) + * [Model Load](cli/seldon\_model\_load.md) + * [Model List](cli/seldon\_model\_list.md) + * [Model Infer](cli/seldon\_model\_infer.md) + * [Model Metadata](cli/seldon\_model\_metadata.md) + * [Model Unload](cli/seldon\_model\_unload.md) + * [Pipeline](cli/seldon\_pipeline.md) + * [Pipeline Load](cli/seldon\_pipeline\_load.md) + * [Pipeline Status](cli/seldon\_pipeline\_status.md) + * [Pipeline List](cli/seldon\_pipeline\_list.md) + * [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md) + * [Pipeline Infer](cli/seldon\_pipeline\_infer.md) + * [Pipeline Unload](cli/seldon\_pipeline\_unload.md) + * [Server](cli/seldon\_server.md) + * [Server List](cli/seldon\_server\_list.md) + * [Server Status](cli/seldon\_server\_status.md) * Reference * Glossary * [FAQs](faqs.md) From 4fff46e3c9d4f18d273a6d66018e0ae175941cc1 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Fri, 7 Mar 2025 15:21:32 +0530 Subject: [PATCH 14/17] commented out the emplty pages --- docs-gb/SUMMARY.md | 37 +++++++++++++++++++++++-------------- 1 file changed, 23 insertions(+), 14 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 36da99f839..16622af467 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -22,22 +22,24 @@ * [Pipeline Config](kubernetes/resources/pipeline.md) * [Upgrading](upgrading.md) ## User Guide + * Getting Started * Deploy Model (OIP+MLServer Link) * Pipeline * Inference Server - * Run Inference + * Run Inference --> * [Kubernetes Resources](kubernetes/resources/README.md) * [Servers](servers.md) * [Resource allocation](resource-allocation/README.md) * [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md) * [Models](models/README.md) - * CRD + + * CRD * Registration * Versioning * LLM * Parameterized Models - * Links to Secret Management + * Links to Secret Management --> * [Multi-Model Serving](models/mms.md) * [Inference Artifacts](models/inference-artifacts.md) * [rClone](models/rclone.md) @@ -51,10 +53,12 @@ * [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md) * [Pipelines](pipelines.md) * [Scaling](kubernetes/scaling.md) + * [Autoscaling](kubernetes/autoscaling.md) - * Multi-Component Serving and Overcommit + * [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md) * Data Science Monitoring * [Dataflow with Kafka](architecture/dataflow.md) @@ -70,18 +74,21 @@ * [Tracing](kubernetes/tracing.md) * [Local Metrics](metrics/local-metrics-test.md) * [Performance Tests](performance-tests.md) - * Performance Tuning + + * [Experiments](kubernetes/resources/experiment.md) + * A/B Testing * Traffic Splitting * Canary * Shadow * CI/CD - * Link to Component Versioning + * Link to Component Versioning --> * [Examples](examples/README.md) * [Local examples](examples/local-examples.md) * [Kubernetes examples](examples/k8s-examples.md) @@ -113,18 +120,21 @@ * [Istio](kubernetes/service-meshes/istio.md) * [Traefik](kubernetes/service-meshes/traefik.md) * [Secure Model Endpoints](models/securing-endpoints.md) + ## Resources + * [Security](/getting-started/kubernetes-installation/security/index.html) + * Authentication * Authorization - * Secrets Management + * Secrets Management --> * [APIs](apis/README.md) * [Internal](apis/internal/README.md) * [Chainer](apis/internal/chainer.md) @@ -163,12 +173,11 @@ * [Server](cli/seldon\_server.md) * [Server List](cli/seldon\_server\_list.md) * [Server Status](cli/seldon\_server\_status.md) + - - * [Development](development/README.md) * [License](development/licenses.md) * [Release](development/release.md) From 675bb87b3cd29d89eeba828324ba53ae93bd8e74 Mon Sep 17 00:00:00 2001 From: Rakavitha Kodhandapani Date: Fri, 7 Mar 2025 15:27:52 +0530 Subject: [PATCH 15/17] fixed a typo --- docs-gb/SUMMARY.md | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 16622af467..4e30002dce 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -131,10 +131,11 @@ * Troubleshooting * Tutorials --> * [Security](/getting-started/kubernetes-installation/security/index.html) - + + * Secrets Management + --> * [APIs](apis/README.md) * [Internal](apis/internal/README.md) * [Chainer](apis/internal/chainer.md) @@ -175,8 +176,8 @@ * [Server Status](cli/seldon\_server\_status.md) + * Glossary --> +* [FAQs](faqs.md) * [Development](development/README.md) * [License](development/licenses.md) From 381be3d7456f1a4c8da0156a7066dd9d6fab184d Mon Sep 17 00:00:00 2001 From: paulb-seldon <141156400+paulb-seldon@users.noreply.github.com> Date: Fri, 7 Mar 2025 10:59:26 +0000 Subject: [PATCH 16/17] Move Installation section up a level --- docs-gb/SUMMARY.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 4e30002dce..17a84a72f5 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -6,21 +6,21 @@ * [Architecture](architecture/README.md) ## Installation -* [Installing Seldon Core 2](installation/README.md) - * [Learning Environment](installation/learning-environment/README.md) - * [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md) - * [Production Environment](installation/production-environment/README.md) - * [Kafka Integration](installation/production-environment/kafka/README.md) - * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) - * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) - * [Test the Installation](installation/test-installation.md) +* [Installation Overview](installation/README.md) +* [Learning Environment](installation/learning-environment/README.md) + * [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md) +* [Production Environment](installation/production-environment/README.md) + * [Kafka Integration](installation/production-environment/kafka/README.md) + * [Managed Kafka](installation/production-environment/kafka/managed-kafka.md) + * [Ingress Controller](installation/production-environment/ingress-controller/istio.md) +* [Test the Installation](installation/test-installation.md) - * Advanced Configurations - * [Server Config](kubernetes/resources/serverconfig.md) - * [Server Runtime](kubernetes/resources/seldonruntime.md) - * [Seldon Config](kubernetes/resources/seldonconfig.md) - * [Pipeline Config](kubernetes/resources/pipeline.md) - * [Upgrading](upgrading.md) +* Advanced Configurations + * [Server Config](kubernetes/resources/serverconfig.md) + * [Server Runtime](kubernetes/resources/seldonruntime.md) + * [Seldon Config](kubernetes/resources/seldonconfig.md) + * [Pipeline Config](kubernetes/resources/pipeline.md) +* [Upgrading](upgrading.md) ## User Guide * Getting Started From 1d9029c9b1d27cde42d1fb8e1c29510350c28439 Mon Sep 17 00:00:00 2001 From: paulb-seldon <141156400+paulb-seldon@users.noreply.github.com> Date: Fri, 7 Mar 2025 11:02:27 +0000 Subject: [PATCH 17/17] Hide concepts --- docs-gb/SUMMARY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs-gb/SUMMARY.md b/docs-gb/SUMMARY.md index 17a84a72f5..4d51e6bca3 100644 --- a/docs-gb/SUMMARY.md +++ b/docs-gb/SUMMARY.md @@ -2,7 +2,7 @@ ## About * [Overview](README.md) -* [Concepts](/docs-gb/concepts/README.md) + * [Architecture](architecture/README.md) ## Installation