fix(docs): changed the name from core v2 to Core 2 (#5963)

* changes the name from seldon core v2 to Seldon Core 2 * Update LICENSE Update after Tanu confirms from JP * Update license.txt update after Tanu confirms * Update license.txt update after Tanu confirms * Update license.txt update after Tanu confirms * Update license.txt update after Tanu confirms * Update license.txt update after Tanu confirms * Update license.txt reverted to the old file * revert the license files --------- Co-authored-by: Rakavitha Kodhandapani <[email protected]>
SeldonIO · Oct 10, 2024 · 3ab43bb · 3ab43bb
1 parent faf064f
commit 3ab43bb
Show file tree

Hide file tree

Showing 79 changed files with 200 additions and 201 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -175,15 +175,15 @@ Generated by [`auto-changelog`](https://github.com/CookPete/auto-changelog).
 - Add payload logging with Envoy Taps [`#1`](https://github.com/sakoush/seldon-core-v2/pull/1)
 - Updated to non deprecated grpc settings [`#29`](https://github.com/sakoush/seldon-core-v2/pull/29)
 - add gRPC inference [`#28`](https://github.com/sakoush/seldon-core-v2/pull/28)
-- Seldon Core V2 Scheduler Update [`#27`](https://github.com/sakoush/seldon-core-v2/pull/27)
+- Seldon Core 2 Scheduler Update [`#27`](https://github.com/sakoush/seldon-core-v2/pull/27)
 - Add V2 APIs and Samples [`#26`](https://github.com/sakoush/seldon-core-v2/pull/26)
 - New Operator APIs [`#25`](https://github.com/sakoush/seldon-core-v2/pull/25)
 - Remove initial operator [`#24`](https://github.com/sakoush/seldon-core-v2/pull/24)
 - SCV2 POC Update [`#23`](https://github.com/sakoush/seldon-core-v2/pull/23)
-- Seldon Core V2 - Scheduler experiments [`#22`](https://github.com/sakoush/seldon-core-v2/pull/22)
-- Seldon core v2 (add smoke test) [`#21`](https://github.com/sakoush/seldon-core-v2/pull/21)
-- Seldon core v2 (further updates) [`#20`](https://github.com/sakoush/seldon-core-v2/pull/20)
-- Seldon V2 APIs initial Draft [`02d963c`](https://github.com/sakoush/seldon-core-v2/commit/02d963c378826704532dcaf60287bbad55cc26ff)
+- Seldon Core 2 - Scheduler experiments [`#22`](https://github.com/sakoush/seldon-core-v2/pull/22)
+- Seldon Core 2 (add smoke test) [`#21`](https://github.com/sakoush/seldon-core-v2/pull/21)
+- Seldon Core 2 (further updates) [`#20`](https://github.com/sakoush/seldon-core-v2/pull/20)
+- Seldon Core 2 APIs initial Draft [`02d963c`](https://github.com/sakoush/seldon-core-v2/commit/02d963c378826704532dcaf60287bbad55cc26ff)
 - Initial commit for Model reconcile [`a1dfb6d`](https://github.com/sakoush/seldon-core-v2/commit/a1dfb6d7f5f332714439aa7d6bb0bb4c14fdc7ce)
 - update status for model [`d127e19`](https://github.com/sakoush/seldon-core-v2/commit/d127e19644dfd01c418fd4279ac21215bd151931)
 - add k8s config handling [`86d58d0`](https://github.com/sakoush/seldon-core-v2/commit/86d58d0699e4c69ae995ce2d8554467accfec5a8)

diff --git a/README.md b/README.md
@@ -60,7 +60,7 @@ ansible-playbook playbooks/kind-cluster.yaml
 ansible-playbook playbooks/setup-ecosystem.yaml
 ```
 
-Deploy Seldon Core v2
+Deploy Seldon Core 2
 
 ```
 cd ..
@@ -69,7 +69,7 @@ make deploy-k8s
 
 Run [k8s-examples.ipynb](samples/k8s-examples.ipynb)
 
-Undeploy Seldon Core v2
+Undeploy Seldon Core 2
 
 ```
 make undeploy-k8s
@@ -78,7 +78,7 @@ make undeploy-k8s
 
 ## Documentation
 
-[Seldon Core v2 docs](https://docs.seldon.io/projects/seldon-core/en/v2/)
+[Seldon Core 2 docs](https://docs.seldon.io/projects/seldon-core/en/v2/)
 
 ## License
 

diff --git a/RELEASE.md b/RELEASE.md
@@ -1,6 +1,6 @@
 # Release Process
 
-This document summarizes the release process for Seldon Core v2.
+This document summarizes the release process for Seldon Core 2.
 It is aimed mainly at the maintainers.
 
 > :warning: **NOTE:** This is a work in progress.

diff --git a/ansible/README.md b/ansible/README.md
@@ -29,12 +29,12 @@ We have tested provided instructions on Python 3.8 - 3.11 with following version
 and `kubernetes.core` collection in version `2.4.0`.
 
 
-Once installed you can use the following Playbooks that you will find in [Ansible](https://github.com/SeldonIO/seldon-core/tree/v2/ansible) folder of Seldon Core V2 repository.
+Once installed you can use the following Playbooks that you will find in [Ansible](https://github.com/SeldonIO/seldon-core/tree/v2/ansible) folder of Seldon Core 2 repository.
 
 You also need to have installed [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl-linux/) CLI.
 
 
-## Installing Seldon Core v2 using Ansible
+## Installing Seldon Core 2 using Ansible
 
 ### One-liner local kind install (from scratch)
 
@@ -72,7 +72,7 @@ existing k8s cluster).
 
 ### Create Kind Cluster
 
-It is recommended to first install Seldon Core v2 inside Kind cluster.
+It is recommended to first install Seldon  inside Kind cluster.
 This allow to test and trial the installation in isolated environment that is easy to remove.
 
 ```bash
@@ -93,7 +93,7 @@ The most common change will be to install in another namespace with:
 ansible-playbook playbooks/setup-ecosystem.yaml -e seldon_mesh_namespace=<mynamespace>
 ```
 
-### Install Seldon Core v2
+### Install Seldon Core 2
 
 Run the following from the `ansible/` folder:
 
@@ -122,23 +122,23 @@ will only install Kafka when setting up the ecosystem.
 
 |                         | type   | default                       | comment                                                  |
 |-------------------------|--------|-------------------------------|----------------------------------------------------------|
-| seldon_mesh_namespace   | string | seldon-mesh                   | namespace to install Seldon Core v2                      |
-| seldon_kafka_namespace  | string | seldon-mesh                   | namespace to install Kafka Cluster for Core v2           |
+| seldon_mesh_namespace   | string | seldon-mesh                   | namespace to install Seldon Core 2                      |
+| seldon_kafka_namespace  | string | seldon-mesh                   | namespace to install Kafka Cluster for Seldon Core 2           |
 | full_install            | bool   | yes                           | enables full ecosystem installation                      |
 | install_kafka           | bool   | `{{ full_install }}`          | installs Strimzi Kafka Operator                          |
 | install_prometheus      | bool   | `{{ full_install }}`          | installs Prometheus Operator                             |
 | install_grafana         | bool   | `{{ full_install }}`          | installs Grafana Operator                                |
 | install_certmanager     | bool   | `{{ full_install }}`          | installs Cert Manager                                    |
 | install_jaeger          | bool   | `{{ full_install }}`          | installs Jaeger                                          |
 | install_opentelemetry   | bool   | `{{ full_install }}`          | installs OpenTelemetry                                   |
-| configure_kafka         | bool   | `{{ install_kafka }}`         | configures Kafka Cluster for Core v2                     |
-| configure_prometheus    | bool   | `{{ install_prometheus }}`    | configure Prometheus using Core v2 specific resources    |
-| configure_jaeger        | bool   | `{{ install_jaeger }}`        | configure Jaeger using Core v2 specific resources        |
-| configure_opentelemetry | bool   | `{{ install_opentelemetry }}` | configure OpenTelemetry using Core v2 specific resources |
+| configure_kafka         | bool   | `{{ install_kafka }}`         | configures Kafka Cluster for Seldon Core 2                     |
+| configure_prometheus    | bool   | `{{ install_prometheus }}`    | configure Prometheus using Seldon Core 2 specific resources    |
+| configure_jaeger        | bool   | `{{ install_jaeger }}`        | configure Jaeger using Seldon Core 2 specific resources        |
+| configure_opentelemetry | bool   | `{{ install_opentelemetry }}` | configure OpenTelemetry using Seldon Core 2 specific resources |
 
 
 
-### Seldon Core v2 configuration options
+### Seldon Core 2 configuration options
 
 |                         | type   | default                       | comment                                                 |
 |-------------------------|--------|-------------------------------|---------------------------------------------------------|
@@ -237,6 +237,6 @@ rm -rf ~/.cache/seldon/
 ```
 
 ```{note}
-If you used Ansible to install Seldon Core v2 and its ecosystem into K8s cluster other than Kind you need to manually remove all the components.
-Notes on how to remove Seldon Core v2 Helm installation itself you can find [here](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/kubernetes-installation/helm.html#uninstall).
+If you used Ansible to install Seldon Core 2 and its ecosystem into K8s cluster other than Kind you need to manually remove all the components.
+Notes on how to remove Seldon Core 2 Helm installation itself you can find [here](https://docs.seldon.io/projects/seldon-core/en/v2/contents/getting-started/kubernetes-installation/helm.html#uninstall).
 ```
diff --git a/ansible/playbooks/kind-cluster.yaml b/ansible/playbooks/kind-cluster.yaml
@@ -1,5 +1,5 @@
 ---
-- name: Create Kind Cluster for Seldon Core v2
+- name: Create Kind Cluster for Seldon Core 2
   hosts: localhost
   roles:
     - kind

diff --git a/ansible/playbooks/setup-ecosystem.yaml b/ansible/playbooks/setup-ecosystem.yaml
@@ -1,5 +1,5 @@
 ---
-- name: Setup Seldon Core v2 Ecosystem
+- name: Setup Seldon Core 2 Ecosystem
   hosts: localhost
   roles:
   - ecosystem

diff --git a/ansible/roles/ecosystem/tasks/prometheus.yaml b/ansible/roles/ecosystem/tasks/prometheus.yaml
@@ -4,7 +4,7 @@
     name: prometheus
   when: install_prometheus | bool
 
-- name: Create Seldon Core v2 PodMonitors
+- name: Create Seldon Core 2 PodMonitors
   kubernetes.core.k8s:
     state: present
     namespace: "{{ seldon_mesh_namespace }}"

diff --git a/ansible/roles/seldon/tasks/install_components.yaml b/ansible/roles/seldon/tasks/install_components.yaml
@@ -1,5 +1,5 @@
 ---
-- name: "Install Seldon Core v2 components"
+- name: "Install Seldon Core 2 components"
   kubernetes.core.helm:
     state: present
     name: "seldon-core-v2-components"

diff --git a/ansible/roles/seldon/tasks/install_crds.yaml b/ansible/roles/seldon/tasks/install_crds.yaml
@@ -1,5 +1,5 @@
 ---
-- name: "Install Seldon Core v2 CRDs"
+- name: "Install Seldon Core 2 CRDs"
   kubernetes.core.helm:
     state: present
     name: "seldon-core-v2-crds"

diff --git a/ansible/roles/seldon/tasks/install_runtime.yaml b/ansible/roles/seldon/tasks/install_runtime.yaml
@@ -1,5 +1,5 @@
 ---
-- name: "Install Seldon Core v2 runtime"
+- name: "Install Seldon Core 2 runtime"
   kubernetes.core.helm:
     state: present
     name: "seldon-core-v2-runtime"

diff --git a/ansible/roles/seldon/tasks/install_servers.yaml b/ansible/roles/seldon/tasks/install_servers.yaml
@@ -1,5 +1,5 @@
 ---
-- name: "Install Seldon Core v2 servers"
+- name: "Install Seldon Core 2 servers"
   kubernetes.core.helm:
     state: present
     name: "seldon-core-v2-servers"

diff --git a/docs-gb/README.md b/docs-gb/README.md
@@ -50,7 +50,7 @@ Seldon V2 supports any V2 protocol inference server. At present we include Seldo
 
 ## Service Mesh Agnostic
 
-Seldon core v2 can be integrated with any Kubernetes service mesh. There are current examples with istio, Ambassador and Traefic.
+Seldon Core 2 can be integrated with any Kubernetes service mesh. There are current examples with istio, Ambassador and Traefic.
 
 ![mesh](images/mesh.png)
 

diff --git a/docs-gb/architecture/README.md b/docs-gb/architecture/README.md
@@ -1,6 +1,6 @@
 # Architecture
 
-The current set of components used in Seldon Core V2 is shown below:
+The current set of components used in Seldon Core 2 is shown below:
 
 ![architecture](../images/architecture.png)
 

diff --git a/docs-gb/architecture/dataflow.md b/docs-gb/architecture/dataflow.md
@@ -1,6 +1,6 @@
 # Data flow design paradigm in Seldon Core
 
-Seldon Core v2 is designed around data flow paradigm. Here we will explain what that means and some of the rationals behind this choice.
+Seldon Core 2 is designed around data flow paradigm. Here we will explain what that means and some of the rationals behind this choice.
 
 ## Seldon Core v1
 
@@ -18,15 +18,15 @@ While this is a convenient way of implementing evaluation graph with microservic
 
 The realisation of this disparity led to a new approach towards inference graph evaluation in v2, based on the data flow paradigm. Data flow is a well known concept in software engineering, known from 1960s. In contrast to services, that model programs as a control flow, focusing on the order of operations, data flow proposes to model software systems as a series of connections that modify incoming data, focusing on data flowing through the system. A particular flavor of data flow paradigm used by v2 is known as flow-based programming, FBP. FBP defines software applications as a set of processes which exchange data via connections that are external to those processes. Connections are made via named ports, which promotes data coupling between components of the system.
 
-Data flow design makes data in software the top priority. That is one of the key messages of the so called "data-centric AI" idea, which is becoming increasingly popular within the ML community. Data is a key component of a successful ML project. Data needs to be discovered, described, cleaned, understood, monitored and verified. Consequently, there is a growing demand for data-centric platforms and solutions. Making Seldon Core data-centric was one of the key goals of the v2 design.
+Data flow design makes data in software the top priority. That is one of the key messages of the so called "data-centric AI" idea, which is becoming increasingly popular within the ML community. Data is a key component of a successful ML project. Data needs to be discovered, described, cleaned, understood, monitored and verified. Consequently, there is a growing demand for data-centric platforms and solutions. Making Seldon Core data-centric was one of the key goals of the Seldon Core 2 design.
 
-## Seldon Core v2
+## Seldon Core 2
 
 In the context of Seldon Core application of FBP design approach means that the evaluation implementation is done the same way inferece graph. So instead of routing everything through a centralized orchestrator the evaluation happens in the same graph-like manner:
 
 ![dataflow](../images/dataflow-inference-graph.png)
 
-As far as implementation goes, Seldon Core v2 runs on Kafka. Inference request is put onto a pipeline input topic, which triggers an evaluation. Each part of the inference graph is a service running in its own container fronted by a model gateway. Model gateway listens to a corresponding input Kafka topic, reads data from it, calls the service and puts the received response to an output Kafka topic. There is also a pipeline gateway that allows to interact with Seldon Core in synchronous manner.
+As far as implementation goes, Seldon Core 2 runs on Kafka. Inference request is put onto a pipeline input topic, which triggers an evaluation. Each part of the inference graph is a service running in its own container fronted by a model gateway. Model gateway listens to a corresponding input Kafka topic, reads data from it, calls the service and puts the received response to an output Kafka topic. There is also a pipeline gateway that allows to interact with Seldon Core in synchronous manner.
 
 This approach gives SCv2 several important features. Firstly, Seldon Core natively supports both synchronous and asynchronous modes of operation. Asynchronicity is achieved via streaming: input data can be sent to an input topic in Kafka, and after the evaluation the output topic will contain the inference result. For those looking to use it in the v1 style, a service API is provided.
 

diff --git a/docs-gb/cli/README.md b/docs-gb/cli/README.md
@@ -19,11 +19,11 @@ Seldon provides a CLI for easy management and testing of model, experiment, and
 
 The CLI talks to 3 backend services on default endpoints:
 
-1. The Seldon Core V2 Scheduler: default `0.0.0.0:9004`
+1. The Seldon Core 2 Scheduler: default `0.0.0.0:9004`
 2. The Seldon Core inference endpoint: default `0.0.0.0:9000`
 3. The Seldon Kafka broker: default: `0.0.0.0:9092`
 
-These defaults will be correct when Seldon Core v2 is installed locally as per the docs. For Kubernetes, you will need to change these by defining environment variables.
+These defaults will be correct when Seldon Core 2 is installed locally as per the docs. For Kubernetes, you will need to change these by defining environment variables.
 
 ```go
 const (
@@ -73,7 +73,7 @@ export SELDON_KAFKA_BROKER=<ip>:<port>
 
 ## Config file
 
-You can create a config file to manage connections to running seldon core v2 installs. The settings will override any environment variable settings.
+You can create a config file to manage connections to running Seldon Core 2 installs. The settings will override any environment variable settings.
 
 The definition is shown below:
 

diff --git a/docs-gb/development/release.md b/docs-gb/development/release.md
@@ -1,6 +1,6 @@
 # Release Process
 
-This document summarizes the release process for Seldon Core v2.
+This document summarizes the release process for Seldon Core 2.
 It is aimed mainly at the maintainers.
 
 {% hint style="warning" %}

diff --git a/docs-gb/examples/model-zoo.md b/docs-gb/examples/model-zoo.md
@@ -1,6 +1,6 @@
 # Seldon Model Zoo
 
-Examples of various model artifact types from various frameworks running under Seldon Core V2.
+Examples of various model artifact types from various frameworks running under Seldon Core 2.
 
 * SKlearn
 * Tensorflow

diff --git a/docs-gb/examples/notebooks/k8s-tritonclient-aio.ipynb b/docs-gb/examples/notebooks/k8s-tritonclient-aio.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Tritonclient Examples with Seldon Core V2 (Asyncio)\n",
+    "## Tritonclient Examples with Seldon Core 2 (Asyncio)\n",
     "\n",
     "- Note: for compatibility of Tritonclient check this issue https://github.com/SeldonIO/seldon-core-v2/issues/471\n",
     "\n",

diff --git a/docs-gb/examples/notebooks/k8s-tritonclient.ipynb b/docs-gb/examples/notebooks/k8s-tritonclient.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "## Tritonclient Examples with Seldon Core V2\n",
+    "## Tritonclient Examples with Seldon Core 2\n",
     "\n",
     "- Note: for compatibility of Tritonclient check this issue https://github.com/SeldonIO/seldon-core-v2/issues/471"
    ]