diff --git a/docs-gen/content/docs/getting-started/introduction.md b/docs-gen/content/docs/getting-started/introduction.md index dc2ad83b2..678a516b0 100644 --- a/docs-gen/content/docs/getting-started/introduction.md +++ b/docs-gen/content/docs/getting-started/introduction.md @@ -49,4 +49,4 @@ Currently, we support the following eventsources: ## Architecture Overview -![architecture](/images/architecture.drawio.svg) +![architecture](/images/architecture.svg) diff --git a/docs-gen/static/images/architecture.svg b/docs-gen/static/images/architecture.svg index 6299c0284..1639f2bde 100644 --- a/docs-gen/static/images/architecture.svg +++ b/docs-gen/static/images/architecture.svg @@ -1,4 +1,4 @@ -
Provider
Namespace
Provider...
User
Namespace
User...
User
Namespace
User...
Provider
Namespace
Provider...
Operator
Namespace
Operator...
Controller Manager
Deployment
Controlle...
Eventing Server
Deployment
Event...
pipeline complition event
p...
Provider
Custom Resource
Provid...
Manages Custom Resources
Create / Update / Delete
Manages Custom Resources...
ML Platform
ML Platform
Kubernetes Cluster
Kubernetes Cluster
Pipeline
Custom Resource
Pipeli...
RunConfiguration
Custom Resource
RunCon...
Run
Custom Resource
Run...
Resource Ops
Argo Workflow
Resource Ops...
Provider
Pod
Provi...
External
External
ML Platform e.g. VAI
Service
ML Pla...
user defined
user defined
Legend
Legend
operator resource
operator resource
created by operator
created by operator
Text is not SVG - cannot display
\ No newline at end of file +
Provider
Namespace
Provider...
User
Namespace
User...
User
Namespace
User...
Provider
Namespace
Provider...
Operator
Namespace
Operator...
Controller Manager
Deployment
Controlle...
Eventing Server
Deployment
Event...
pipeline complition event
pipeline complition event
Provider
Custom Resource
Provid...
Manages Custom Resources
Create / Update / Delete
Manages Custom Resources...
ML Platform
ML Platform
Kubernetes Cluster
Kubernetes Cluster
Pipeline
Custom Resource
Pipeli...
RunConfiguration
Custom Resource
RunCon...
Run
Custom Resource
Run...
Resource Ops
Argo Workflow
Resource Ops...
Provider
Pod
Provi...
External
External
ML Platform e.g. VAI
Service
ML Pla...
user defined
user defined
Legend
Legend
operator resource
operator resource
created by operator
created by operator
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/docs/getting-started/index.xml b/docs/docs/getting-started/index.xml index db3ea4fa3..774674288 100644 --- a/docs/docs/getting-started/index.xml +++ b/docs/docs/getting-started/index.xml @@ -59,7 +59,7 @@ the link between CD and CT to provide Level 2 of the <a href="https://cloud.g <li><a href="../../reference/run-completion">Run Completion Eventsource</a></li> </ul> <h2 id="architecture-overview">Architecture Overview</h2> -<p><img src="https://sky-uk.github.io/kfp-operator/images/architecture.drawio.svg" alt="architecture"></p>Docs: Installationhttps://sky-uk.github.io/kfp-operator/docs/getting-started/installation/Mon, 01 Jan 0001 00:00:00 +0000https://sky-uk.github.io/kfp-operator/docs/getting-started/installation/ +<p><img src="https://sky-uk.github.io/kfp-operator/images/architecture.svg" alt="architecture"></p>Docs: Installationhttps://sky-uk.github.io/kfp-operator/docs/getting-started/installation/Mon, 01 Jan 0001 00:00:00 +0000https://sky-uk.github.io/kfp-operator/docs/getting-started/installation/ <p>We recommend the installation using Helm as it allows a declarative approach to managing Kubernetes resources.</p> <p>This guide assumes you are familiar with <a href="https://helm.sh/">Helm</a>.</p> <h2 id="prerequisites">Prerequisites</h2> diff --git a/docs/docs/getting-started/introduction/index.html b/docs/docs/getting-started/introduction/index.html index d87ad7a5a..a05646e62 100644 --- a/docs/docs/getting-started/introduction/index.html +++ b/docs/docs/getting-started/introduction/index.html @@ -9,7 +9,7 @@ Edit this page Create child page Create documentation issue - Create project issue

Introduction

Compatibility

The operator currently supports

  • TFX Pipelines with Python 3.7 and 3.9 - pipelines created using the KFP DSL are not supported yet
  • KFP standalone (a full KFP installation is not supported yet) and Vertex AI

TFX Pipelines and Components

Unlike imperative Kubeflow Pipelines deployments, the operator takes care of providing all environment-specific configuration and setup for the pipelines. Pipeline creators therefore don’t have to provide DAG runners, metadata configs, serving directories, etc. Furthermore, pusher is not required and the operator can extend the pipeline with this very environment-specific component.

For running a pipeline using the operator, only the list of TFX components needs to be returned. Everything else is done by the operator. See the penguin pipeline for an example.

Lifecycle phases and Parameter types

TFX Pipelines go through certain lifecycle phases that are unique to this technology. It is helpful to understand where these differ and where they are executed.

Development: Creating the components definition as code.

Compilation: Applying compile-time parameters and defining the execution runtime (aka DAG runner) for the pipeline to be compiled into a deployable artifact.

Deployment: Creating a pipeline representation in the target environment.

Running: Instantiating the pipeline, applying runtime parameters and running all pipeline steps involved to completion.

Note: Local runners usually skip compilation and deployment and run the pipeline straight away.

TFX allows the parameterization of Pipelines in most lifecycle stages:

Parameter typeDescriptionExample
Named ConstantsCode constantsANN layer size
Compile-time parameterParameters that are unlikely to change between pipeline runs supplied as environment variabels to the pipeline functionBigquery dataset
Runtime parameterParameters exposed as TFX RuntimeParameter which can be overridden at runtime allow simplified experimentation without having to recompile the pipelineNumber of training runs

The pipeline operator supports the application of compile time and runtime parameters through its custom resources. We strongly encourage the usage of both of these parameter types to speed up development and experimentation lifecycles. Note that Runtime parameters can initialised to default values from both constants and compile-time parameters

Eventing Support

The Kubeflow Pipelines operator can optionally be installed with Argo-Events eventsources which lets users react to events.

Currently, we support the following eventsources:

Architecture Overview

architecture

+ Create project issue

Introduction

Compatibility

The operator currently supports

  • TFX Pipelines with Python 3.7 and 3.9 - pipelines created using the KFP DSL are not supported yet
  • KFP standalone (a full KFP installation is not supported yet) and Vertex AI

TFX Pipelines and Components

Unlike imperative Kubeflow Pipelines deployments, the operator takes care of providing all environment-specific configuration and setup for the pipelines. Pipeline creators therefore don’t have to provide DAG runners, metadata configs, serving directories, etc. Furthermore, pusher is not required and the operator can extend the pipeline with this very environment-specific component.

For running a pipeline using the operator, only the list of TFX components needs to be returned. Everything else is done by the operator. See the penguin pipeline for an example.

Lifecycle phases and Parameter types

TFX Pipelines go through certain lifecycle phases that are unique to this technology. It is helpful to understand where these differ and where they are executed.

Development: Creating the components definition as code.

Compilation: Applying compile-time parameters and defining the execution runtime (aka DAG runner) for the pipeline to be compiled into a deployable artifact.

Deployment: Creating a pipeline representation in the target environment.

Running: Instantiating the pipeline, applying runtime parameters and running all pipeline steps involved to completion.

Note: Local runners usually skip compilation and deployment and run the pipeline straight away.

TFX allows the parameterization of Pipelines in most lifecycle stages:

Parameter typeDescriptionExample
Named ConstantsCode constantsANN layer size
Compile-time parameterParameters that are unlikely to change between pipeline runs supplied as environment variabels to the pipeline functionBigquery dataset
Runtime parameterParameters exposed as TFX RuntimeParameter which can be overridden at runtime allow simplified experimentation without having to recompile the pipelineNumber of training runs

The pipeline operator supports the application of compile time and runtime parameters through its custom resources. We strongly encourage the usage of both of these parameter types to speed up development and experimentation lifecycles. Note that Runtime parameters can initialised to default values from both constants and compile-time parameters

Eventing Support

The Kubeflow Pipelines operator can optionally be installed with Argo-Events eventsources which lets users react to events.

Currently, we support the following eventsources:

Architecture Overview

architecture

\ No newline at end of file diff --git a/docs/docs/index.xml b/docs/docs/index.xml index 0eb614b76..1743abeb3 100644 --- a/docs/docs/index.xml +++ b/docs/docs/index.xml @@ -533,7 +533,7 @@ In this example we are updating a serving component with the location of the new <li><a href="../../reference/run-completion">Run Completion Eventsource</a></li> </ul> <h2 id="architecture-overview">Architecture Overview</h2> -<p><img src="https://sky-uk.github.io/kfp-operator/images/architecture.drawio.svg" alt="architecture"></p>
Docs: Pipeline Dependencieshttps://sky-uk.github.io/kfp-operator/docs/examples/pipeline_dependencies/Mon, 01 Jan 0001 00:00:00 +0000https://sky-uk.github.io/kfp-operator/docs/examples/pipeline_dependencies/ +<p><img src="https://sky-uk.github.io/kfp-operator/images/architecture.svg" alt="architecture"></p>Docs: Pipeline Dependencieshttps://sky-uk.github.io/kfp-operator/docs/examples/pipeline_dependencies/Mon, 01 Jan 0001 00:00:00 +0000https://sky-uk.github.io/kfp-operator/docs/examples/pipeline_dependencies/ <p>Pipeline dependencies allow splitting up larger machine learning pipelines into sub-pipelines. This is particularly useful when:</p> <ul> <li>The data of an earlier step changes at a lower frequency than the data for subsequent steps</li> diff --git a/docs/images/architecture.drawio.svg b/docs/images/architecture.drawio.svg deleted file mode 100644 index 1600363ed..000000000 --- a/docs/images/architecture.drawio.svg +++ /dev/null @@ -1,4 +0,0 @@ - - - -
User
Namespace
User...
Provider
Namespace
Provider...
Operator
Namespace
Operator...
Operator
Deployment
Operat...
Provider
Custom Resource
Provid...
RunConfiguration
Custom Resource
RunCon...
Pipeline
Custom Resource
Pipeli...
RunSchedule
Custom Resource
RunSch...
Run
Custom Resource
Run...
Eventing Server
Deployment
Event...
External
External
External Provider
Service
Exter...
Updates Status Field
Updates Status Field
Manages Custom 
Resources
Create / Update / Delete
Manages Custom...
Resource Ops
Argo Workflow
Resource Ops...
Provider
Pod
Provi...
Status Updater
Pod
Statu...
Resource Ops
Argo Workflow
Resource Ops...
create
create
read status
read status
Text is not SVG - cannot display
\ No newline at end of file diff --git a/docs/images/architecture.svg b/docs/images/architecture.svg index 9177ae57a..1639f2bde 100644 --- a/docs/images/architecture.svg +++ b/docs/images/architecture.svg @@ -1,4 +1,4 @@ -
Provider
Namespace
Provider...
User
Namespace
User...
User
Namespace
User...
Provider
Namespace
Provider...
Operator
Namespace
Operator...
Controller Manager
Deployment
Controlle...
Eventing Server
Deployment
Event...
pipeline complition event
pipeline complition event
Provider
Custom Resource
Provid...
Manages Custom Resources
Create / Update / Delete
Manages Custom Resources...
ML Platform
ML Platform
Kubernetes Cluster
Kubernetes Cluster
Pipeline
Custom Resource
Pipeli...
RunConfiguration
Custom Resource
RunCon...
Run
Custom Resource
Run...
Resource Ops
Argo Workflow
Resource Ops...
Provider
Pod
Provi...
External
External
ML Platform e.g. VAI
Service
ML Pla...
user defined
user defined
Legend
Legend
operator resource
operator resource
created by operator
created by operator
Text is not SVG - cannot display
\ No newline at end of file +
Provider
Namespace
Provider...
User
Namespace
User...
User
Namespace
User...
Provider
Namespace
Provider...
Operator
Namespace
Operator...
Controller Manager
Deployment
Controlle...
Eventing Server
Deployment
Event...
pipeline complition event
pipeline complition event
Provider
Custom Resource
Provid...
Manages Custom Resources
Create / Update / Delete
Manages Custom Resources...
ML Platform
ML Platform
Kubernetes Cluster
Kubernetes Cluster
Pipeline
Custom Resource
Pipeli...
RunConfiguration
Custom Resource
RunCon...
Run
Custom Resource
Run...
Resource Ops
Argo Workflow
Resource Ops...
Provider
Pod
Provi...
External
External
ML Platform e.g. VAI
Service
ML Pla...
user defined
user defined
Legend
Legend
operator resource
operator resource
created by operator
created by operator
Text is not SVG - cannot display
\ No newline at end of file