Hera is a Python framework for constructing and submitting Argo Workflows. The main goal of Hera is to make Argo Workflows more accessible by abstracting away some setup that is typically necessary for constructing Argo workflows.
Project description
Hera (hera-workflows)
The Argo was constructed by the shipwright Argus,
and its crew were specially protected by the goddess Hera.
(https://en.wikipedia.org/wiki/Argo)
Hera is a Python framework for constructing and submitting Argo Workflows. The main goal of Hera is to make Argo Workflows more accessible by abstracting away some setup that is typically necessary for constructing workflows.
Python functions are first class citizens in Hera - they are the atomic units (execution payload) that are submitted for remote execution. The framework makes it easy to wrap execution payloads into Argo Workflow tasks, set dependencies, resources, etc.
You can watch the introductory Hera presentation at the "Argo Workflows and Events Community Meeting 20 Oct 2021" here!
Table of content
Assumptions
Hera is exclusively dedicated to remote workflow submission and execution. Therefore, it requires an Argo server to be deployed to a Kubernetes cluster. Currently, Hera assumes that the Argo server sits behind an authentication layer that can authenticate workflow submission requests by using the Bearer token on the request. To learn how to deploy Argo to your own Kubernetes cluster you can follow the Argo Workflows guide!
Another option for workflow submission without the authentication layer is using port forwarding to your Argo server
deployment and submitting workflows to localhost:2746 (2746 is the default, but you are free to use yours). Please
refer to the documentation of Argo Workflows to see the
command for port forward!
In the future some of these assumptions may either increase or decrease depending on the direction of the project. Hera is mostly designed for practical data science purposes, which assumes the presence of a DevOps team to set up an Argo server for workflow submission.
Installation
There are multiple ways to install Hera:
-
You can install from PyPi:
pip install hera-workflows
-
You can install from conda:
conda install -c conda-forge hera-workflows
-
Install it directly from this repository using:
python -m pip install git+https://github.com/argoproj-labs/hera-workflows --ignore-installed
-
Alternatively, you can clone this repository and then run the following to install:
pip install .
Examples
A very primitive example of submitting a task within a workflow through Hera is:
from hera import Task, Workflow, WorkflowService
def say(m: str):
print(m)
with Workflow('my-workflow', service=WorkflowService(host='my-argo-domain.com', token='my-argo-server-token')) as w:
Task('say', say, func_params=[{'m': 'Hello, world!'}]) >> Task('say', say, func_params=[{'m': 'Goodbye, world!'}])
w.create()
See the examples directory for a collection of Argo workflow construction and submission via Hera!
Contributing
If you plan to submit contributions to Hera you can install Hera in a virtual environment managed by poetry:
poetry install
In you activated poetry shell, you can utilize the tasks found in tox.ini, e.g.:
To run tests on all supported python versions with coverage run tox:
tox
To list all available tox envs run:
tox -a
To run selected tox envs, e.g. for a specific python version with coverage run:
tox -e py37,coverage
As coverage depends on py37, it will run after py37
See project tox.ini for more details
Also, see the contributing guide!
Concepts
Currently, Hera is centered around two core concepts. These concepts are also used by Argo, which Hera aims to stay consistent with:
Task- the object that holds the Python function for remote execution/the atomic unit of execution;Workflow- the higher level representation of a collection of tasks.
Comparison
There are other libraries currently available for structuring and submitting Argo Workflows:
- Couler, which aims to provide a unified interface for constructing and managing workflows on different workflow engines;
- Argo Python DSL, which allows you to programmaticaly define Argo worfklows using Python.
While the aforementioned libraries provide amazing functionality for Argo workflow construction and submission, they require an advanced understanding of Argo concepts. When Dyno Therapeutics started using Argo Workflows, it was challenging to construct and submit experimental machine learning workflows. Scientists and engineers at Dyno Therapeutics used a lot of time for workflow definition rather than the implementation of the atomic unit of execution - the Python function - that performed, for instance, model training.
Hera presents a much simpler interface for task and workflow construction, empowering users to focus on their own executable payloads rather than workflow setup. Here's a side by side comparison of Hera, Argo Python DSL, and Couler:
| Hera | Couler | Argo Python DSL |
|---|---|---|
from hera import Task, Workflow, WorkflowService
def say(message: str):
print(message)
with Workflow('diamond', WorkflowService(host='my-argo-server.com', token='my-auth-token')) as w:
a = Task('A', say, func_params=[{'message': 'This is task A!'}])
b = Task('B', say, func_params=[{'message': 'This is task B!'}])
c = Task('C', say, func_params=[{'message': 'This is task C!'}])
d = Task('D', say, func_params=[{'message': 'This is task D!'}])
a >> b >> d
a >> c >> d
w.create()
|
import couler.argo as couler
from couler.argo_submitter import ArgoSubmitter
def job(name):
couler.run_container(
image="docker/whalesay:latest",
command=["cowsay"],
args=[name],
step_name=name,
)
def diamond():
couler.dag(
[
[lambda: job(name="A")],
[lambda: job(name="A"), lambda: job(name="B")], # A -> B
[lambda: job(name="A"), lambda: job(name="C")], # A -> C
[lambda: job(name="B"), lambda: job(name="D")], # B -> D
[lambda: job(name="C"), lambda: job(name="D")], # C -> D
]
)
diamond()
submitter = ArgoSubmitter()
couler.run(submitter=submitter)
|
from argo.workflows.dsl import Workflow
from argo.workflows.dsl.tasks import *
from argo.workflows.dsl.templates import *
class DagDiamond(Workflow):
@task
@parameter(name="message", value="A")
def A(self, message: V1alpha1Parameter) -> V1alpha1Template:
return self.echo(message=message)
@task
@parameter(name="message", value="B")
@dependencies(["A"])
def B(self, message: V1alpha1Parameter) -> V1alpha1Template:
return self.echo(message=message)
@task
@parameter(name="message", value="C")
@dependencies(["A"])
def C(self, message: V1alpha1Parameter) -> V1alpha1Template:
return self.echo(message=message)
@task
@parameter(name="message", value="D")
@dependencies(["B", "C"])
def D(self, message: V1alpha1Parameter) -> V1alpha1Template:
return self.echo(message=message)
@template
@inputs.parameter(name="message")
def echo(self, message: V1alpha1Parameter) -> V1Container:
container = V1Container(
image="alpine:3.7",
name="echo",
command=["echo", "{{inputs.parameters.message}}"],
)
return container
|
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file hera-workflows-3.6.4.tar.gz.
File metadata
- Download URL: hera-workflows-3.6.4.tar.gz
- Upload date:
- Size: 44.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.8.3 requests/2.28.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 4735879ee655388996a653f43eb33fb9833f29346685c10338290113ba0fe268 |
|
| MD5 | 90f905a6d80c434b33c478b5e7c232cd |
|
| BLAKE2b-256 | 3a716e3c2f98cd187ed2d95d0d6326b77847d4e2566697b96606b8766af0d6d7 |
File details
Details for the file hera_workflows-3.6.4-py3-none-any.whl.
File metadata
- Download URL: hera_workflows-3.6.4-py3-none-any.whl
- Upload date:
- Size: 53.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.3.0 pkginfo/1.8.3 requests/2.28.1 setuptools/47.1.0 requests-toolbelt/0.9.1 tqdm/4.64.0 CPython/3.7.13
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 37970c718d45f71dd1b43359f52ec4197f9461e8460e8373bc74d6a60adf004f |
|
| MD5 | 6a4b323429a71963ceaa6db0027fa8d0 |
|
| BLAKE2b-256 | f6bc1d042f9eafcbe3a82909b027245dbcd5330f9d18dfd450db932f74cd702a |
