Skip to content

Commit c711ecf

Browse files
Rajakavitha1Rakavitha Kodhandapanipaulb-seldon
authored
IA mapping (#6236)
* summary.md ia mapping * 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 * Update SUMMARY.md - moved scaling one level up * Update SUMMARY.md incorporated the changes that Paul suggested. * Update SUMMARY.md Found a place for experiments * Update SUMMARY.md * incoporate pauls suggestions * moved one level up for some topics under integrations * is changes paul suggestions * paul's changes * incorporate Paul's feedback * intro page changes * fix the API section * commented out the emplty pages * fixed a typo * Move Installation section up a level * Hide concepts --------- Co-authored-by: Rakavitha Kodhandapani <[email protected]> Co-authored-by: paulb-seldon <[email protected]>
1 parent 83c6c81 commit c711ecf

File tree

2 files changed

+161
-98
lines changed

2 files changed

+161
-98
lines changed

‎docs-gb/SUMMARY.md

+154-98
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,94 @@
11
# Table of contents
2-
* [About](README.md)
32

4-
## Installation
5-
* [Installing Seldon Core 2](installation/README.md)
6-
* [Learning Environment](installation/learning-environment/README.md)
7-
* [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md)
8-
* [Production Environment](installation/production-environment/README.md)
9-
* [Kafka Integration](installation/production-environment/kafka/README.md)
10-
* [Managed Kafka](installation/production-environment/kafka/managed-kafka.md)
11-
* [Ingress Controller](installation/production-environment/ingress-controller/istio.md)
12-
* [Test the Installation](installation/test-installation.md)
13-
14-
## User Guide
15-
* [Getting Started](getting-started/README.md)
16-
* [Seldon CLI](getting-started/cli.md)
17-
* [Operational Monitoring](operational-monitoring/README.md)
18-
* [Observability](operational-monitoring/observability.md)
19-
* [Operational Metrics](operational-monitoring/operational.md)
20-
* [Usage Metrics](operational-monitoring/usage.md)
21-
* [Local Metrics](operational-monitoring/local-metrics-test.md)
22-
* [APIs](apis/README.md)
23-
* [Internal](apis/internal/README.md)
24-
* [Chainer](apis/internal/chainer.md)
25-
* [Agent](apis/internal/agent.md)
26-
* [Inference](apis/inference/README.md)
27-
* [Open Inference Protocol](apis/inference/v2.md)
28-
* [Scheduler](apis/scheduler.md)
3+
## About
4+
* [Overview](README.md)
5+
<!-- * [Concepts](/docs-gb/concepts/README.md) -->
296
* [Architecture](architecture/README.md)
30-
* [DataFlow](architecture/dataflow.md)
7+
8+
## Installation
9+
* [Installation Overview](installation/README.md)
10+
* [Learning Environment](installation/learning-environment/README.md)
11+
* [Self-hosted Kafka](installation/learning-environment/self-hosted-kafka.md)
12+
* [Production Environment](installation/production-environment/README.md)
13+
* [Kafka Integration](installation/production-environment/kafka/README.md)
14+
* [Managed Kafka](installation/production-environment/kafka/managed-kafka.md)
15+
* [Ingress Controller](installation/production-environment/ingress-controller/istio.md)
16+
* [Test the Installation](installation/test-installation.md)
17+
18+
* Advanced Configurations
19+
* [Server Config](kubernetes/resources/serverconfig.md)
20+
* [Server Runtime](kubernetes/resources/seldonruntime.md)
21+
* [Seldon Config](kubernetes/resources/seldonconfig.md)
22+
* [Pipeline Config](kubernetes/resources/pipeline.md)
23+
* [Upgrading](upgrading.md)
24+
## User Guide
25+
<!-->
26+
* Getting Started
27+
* Deploy Model (OIP+MLServer Link)
28+
* Pipeline
29+
* Inference Server
30+
* Run Inference -->
31+
* [Kubernetes Resources](kubernetes/resources/README.md)
32+
* [Servers](servers.md)
33+
* [Resource allocation](resource-allocation/README.md)
34+
* [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md)
35+
* [Models](models/README.md)
36+
<!-->
37+
* CRD
38+
* Registration
39+
* Versioning
40+
* LLM
41+
* Parameterized Models
42+
* Links to Secret Management -->
43+
* [Multi-Model Serving](models/mms.md)
44+
* [Inference Artifacts](models/inference-artifacts.md)
45+
* [rClone](models/rclone.md)
46+
* [Parameterized Models](models/parameterized-models/README.md)
47+
* [Pandas Query](models/parameterized-models/pandasquery.md)
48+
* [Storage Secrets](kubernetes/storage-secrets.md)
49+
* Inference
50+
* [Inference Server](https://docs.seldon.io/projects/seldon-core/en/v2/contents/about/index.html#inference-servers)
51+
* [Run Inference](https://docs.seldon.io/projects/seldon-core/en/v2/contents/inference/index.html)
52+
* [OIP](apis/inference/v2.md)
53+
* [Batch](examples/batch-examples-k8s.md) and (examples/batch-examples-local.md)
54+
* [Pipelines](pipelines.md)
55+
* [Scaling](kubernetes/scaling.md)
56+
<!--
57+
* Server Scaling
58+
* Component Scaling -->
59+
* [Autoscaling](kubernetes/autoscaling.md)
60+
<!--
61+
* Multi-Component Serving and Overcommit -->
62+
* [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md)
63+
* Data Science Monitoring
64+
* [Dataflow with Kafka](architecture/dataflow.md)
65+
* Request & Response Logging
66+
* [Model Performance Metrics](performance-tests.md)
67+
* [Drift Detection](drift.md)
68+
* [Outlier Detection](outlier.md)
69+
* [Explainability](explainers.md)
70+
* Operational Monitoring
71+
* [Operational Metrics](metrics/operational.md)
72+
* Kubernetes Metrics
73+
* [Usage Metrics](metrics/usage.md)
74+
* [Tracing](kubernetes/tracing.md)
75+
* [Local Metrics](metrics/local-metrics-test.md)
76+
* [Performance Tests](performance-tests.md)
77+
<!--
78+
* Performance Tuning -->
79+
<!--
80+
* Rollouts & Experiments
81+
* Rollout Strategies
82+
* Progressive Rollouts
83+
* Rollbacks -->
84+
* [Experiments](kubernetes/resources/experiment.md)
85+
<!-->
86+
* A/B Testing
87+
* Traffic Splitting
88+
* Canary
89+
* Shadow
90+
* CI/CD
91+
* Link to Component Versioning -->
3192
* [Examples](examples/README.md)
3293
* [Local examples](examples/local-examples.md)
3394
* [Kubernetes examples](examples/k8s-examples.md)
@@ -50,81 +111,76 @@
50111
* [Production image classifier with drift and outlier monitoring](examples/cifar10.md)
51112
* [Production income classifier with drift, outlier and explanations](examples/income.md)
52113
* [Conditional pipeline with pandas query model](examples/pandasquery.md)
53-
* [Kubernetes Server with PVC](examples/k8s-pvc.md)
54-
* [Kubernetes](kubernetes/README.md)
55-
* [Scaling](kubernetes/scaling.md)
56-
* [Autoscaling](kubernetes/autoscaling.md)
57-
* [HPA Autoscaling in single-model serving](kubernetes/hpa-rps-autoscaling.md)
58-
* [Tracing](kubernetes/tracing.md)
59-
* [Storage Secrets](kubernetes/storage-secrets.md)
60-
* [Kafka](kubernetes/kafka.md)
61-
* [Metrics](kubernetes/metrics.md)
62-
* [Resources](kubernetes/resources/README.md)
63-
* [Model](kubernetes/resources/model.md)
64-
* [Experiment](kubernetes/resources/experiment.md)
65-
* [Pipeline](kubernetes/resources/pipeline.md)
66-
* [Server](kubernetes/resources/server.md)
67-
* [Server Config](kubernetes/resources/serverconfig.md)
68-
* [Server Runtime](kubernetes/resources/seldonruntime.md)
69-
* [Seldon Config](kubernetes/resources/seldonconfig.md)
114+
* [Kubernetes Server with PVC](examples/k8s-pvc.md)
115+
116+
117+
## Integrations
70118
* [Service Meshes](kubernetes/service-meshes/README.md)
71119
* [Ambassador](kubernetes/service-meshes/ambassador.md)
72120
* [Istio](kubernetes/service-meshes/istio.md)
73121
* [Traefik](kubernetes/service-meshes/traefik.md)
74-
* [Resource allocation](resource-allocation/README.md)
75-
* [Example: Serving models on dedicated GPU nodes](resource-allocation/example-serving-models-on-dedicated-gpu-nodes.md)
76-
* [Models](models/README.md)
77-
* [Multi-Model Serving](models/mms.md)
78-
* [Inference Artifacts](models/inference-artifacts.md)
79-
* [rClone](models/rclone.md)
80-
* [Parameterized Models](models/parameterized-models/README.md)
81-
* [Pandas Query](models/parameterized-models/pandasquery.md)
82-
* [Securing Endpoints](models/securing-endpoints.md)
83-
* [Scheduling](models/scheduling.md)
84-
* [Metrics](metrics/README.md)
85-
* [Usage](metrics/usage.md)
86-
* [Operational](metrics/operational.md)
87-
* [Local Metrics](metrics/local-metrics-test.md)
122+
* [Secure Model Endpoints](models/securing-endpoints.md)
123+
<!--
124+
* Audit Trails
125+
* Alerts
126+
* Data Management
127+
* Modules
128+
-->
129+
## Resources
130+
<!--
131+
* Troubleshooting
132+
* Tutorials -->
133+
* [Security](/getting-started/kubernetes-installation/security/index.html)
134+
<!--
135+
* Authentication
136+
* Authorization
137+
* Secrets Management
138+
-->
139+
* [APIs](apis/README.md)
140+
* [Internal](apis/internal/README.md)
141+
* [Chainer](apis/internal/chainer.md)
142+
* [Agent](apis/internal/agent.md)
143+
* [Inference](apis/inference/README.md)
144+
* [Open Inference Protocol](apis/inference/v2.md)
145+
* [Scheduler](apis/scheduler.md)
146+
* [Seldon CLI](getting-started/cli.md)
147+
* [CLI](cli/README.md)
148+
* [Seldon](cli/seldon.md)
149+
* [Config](cli/seldon\_config.md)
150+
* [Config Activate](cli/seldon\_config\_activate.md)
151+
* [Config Deactivate](cli/seldon\_config\_deactivate.md)
152+
* [Config Add](cli/seldon\_config\_add.md)
153+
* [Config List](cli/seldon\_config\_list.md)
154+
* [Config Remove](cli/seldon\_config\_remove.md)
155+
* [Experiment](cli/seldon\_experiment.md)
156+
* [Experiment Start](cli/seldon\_experiment\_start.md)
157+
* [Experiment Status](cli/seldon\_experiment\_status.md)
158+
* [Experiment List](cli/seldon\_experiment\_list.md)
159+
* [Experiment Stop](cli/seldon\_experiment\_stop.md)
160+
* [Model](cli/seldon\_model.md)
161+
* [Model Status](cli/seldon\_model\_status.md)
162+
* [Model Load](cli/seldon\_model\_load.md)
163+
* [Model List](cli/seldon\_model\_list.md)
164+
* [Model Infer](cli/seldon\_model\_infer.md)
165+
* [Model Metadata](cli/seldon\_model\_metadata.md)
166+
* [Model Unload](cli/seldon\_model\_unload.md)
167+
* [Pipeline](cli/seldon\_pipeline.md)
168+
* [Pipeline Load](cli/seldon\_pipeline\_load.md)
169+
* [Pipeline Status](cli/seldon\_pipeline\_status.md)
170+
* [Pipeline List](cli/seldon\_pipeline\_list.md)
171+
* [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md)
172+
* [Pipeline Infer](cli/seldon\_pipeline\_infer.md)
173+
* [Pipeline Unload](cli/seldon\_pipeline\_unload.md)
174+
* [Server](cli/seldon\_server.md)
175+
* [Server List](cli/seldon\_server\_list.md)
176+
* [Server Status](cli/seldon\_server\_status.md)
177+
<!--
178+
* Reference
179+
* Glossary -->
180+
* [FAQs](faqs.md)
181+
88182
* [Development](development/README.md)
89183
* [License](development/licenses.md)
90184
* [Release](development/release.md)
91-
* [CLI](cli/README.md)
92-
* [Seldon](cli/seldon.md)
93-
* [Config](cli/seldon\_config.md)
94-
* [Config Activate](cli/seldon\_config\_activate.md)
95-
* [Config Deactivate](cli/seldon\_config\_deactivate.md)
96-
* [Config Add](cli/seldon\_config\_add.md)
97-
* [Config List](cli/seldon\_config\_list.md)
98-
* [Config Remove](cli/seldon\_config\_remove.md)
99-
* [Experiment](cli/seldon\_experiment.md)
100-
* [Experiment Start](cli/seldon\_experiment\_start.md)
101-
* [Experiment Status](cli/seldon\_experiment\_status.md)
102-
* [Experiment List](cli/seldon\_experiment\_list.md)
103-
* [Experiment Stop](cli/seldon\_experiment\_stop.md)
104-
* [Model](cli/seldon\_model.md)
105-
* [Model Status](cli/seldon\_model\_status.md)
106-
* [Model Load](cli/seldon\_model\_load.md)
107-
* [Model List](cli/seldon\_model\_list.md)
108-
* [Model Infer](cli/seldon\_model\_infer.md)
109-
* [Model Metadata](cli/seldon\_model\_metadata.md)
110-
* [Model Unload](cli/seldon\_model\_unload.md)
111-
* [Pipeline](cli/seldon\_pipeline.md)
112-
* [Pipeline Load](cli/seldon\_pipeline\_load.md)
113-
* [Pipeline Status](cli/seldon\_pipeline\_status.md)
114-
* [Pipeline List](cli/seldon\_pipeline\_list.md)
115-
* [Pipeline Inspect](cli/seldon\_pipeline\_inspect.md)
116-
* [Pipeline Infer](cli/seldon\_pipeline\_infer.md)
117-
* [Pipeline Unload](cli/seldon\_pipeline\_unload.md)
118-
* [Server](cli/seldon\_server.md)
119-
* [Server List](cli/seldon\_server\_list.md)
120-
* [Server Status](cli/seldon\_server\_status.md)
121-
* [Pipelines](pipelines.md)
122-
* [Experiments](experiments.md)
123-
* [Servers](servers.md)
124-
* [Inference](inference.md)
125-
* [Outlier Detection](outlier.md)
126-
* [Drift Detection](drift.md)
127-
* [Explainers](explainers.md)
128-
* [Performance Tests](performance-tests.md)
129-
* [Upgrading](upgrading.md)
130-
* [FAQ](faqs.md)
185+
186+

‎docs-gb/concepts/README.md

+7
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
## Concepts
2+
* Data-Centric MLOps
3+
* Servers
4+
* OIP
5+
* Components
6+
* Pipelines
7+
* [Experiments](experiments.md)

0 commit comments

Comments
 (0)