flytekitplugins-perian-job 1.14.0b2

Flyte agent for Perian Job Platform (perian.io)

Flytekit Perian Job Platform Plugin

Flyte Agent plugin for executing Flyte tasks on Perian Job Platform (perian.io).

Perian Job Platform is still in closed beta. Contact [e-mail] if you are interested in trying it out.

To install the plugin, run the following command:

pip install flytekitplugins-perian-job

Getting Started

This plugin allows executing PythonFunctionTask on Perian.

An ImageSpec need to be built with the perian agent plugin installed.

Parameters

The following parameters can be used to set the requirements for the Perian task. If any of the requirements are skipped, it is replaced with the cheapest option. At least one requirement value should be set.

• cores: Number of CPU cores
• memory: Amount of memory in GB
• accelerators: Number of accelerators
• accelerator_type: Type of accelerator (e.g. 'A100'). For a full list of supported accelerators, use the perian CLI list-accelerators command.
• country_code: Country code to run the job in (e.g. 'DE')

Credentials

The following secrets are required to be defined for the agent server:

• Perian credentials:
  • perian_organization
  • perian_token
• For accessing the Flyte storage bucket, you need to add either AWS or GCP credentials. These credentials are never logged by Perian and are only stored until then are used, then immediately deleted.
  • AWS credentials:
    • aws_access_key_id
    • aws_secret_access_key
  • GCP credentials:
    • google_application_credentials. This should be the full json credentials.
• (Optional) Custom docker registry for pulling the Flyte image:
  • docker_registry_url
  • docker_registry_username
  • docker_registry_password

Example

example.py workflow example:

from flytekit import ImageSpec, task, workflow
from flytekitplugins.perian_job import PerianConfig

image_spec = ImageSpec(
    name="flyte-test",
    registry="my-registry",
    python_version="3.11",
    apt_packages=["wget", "curl", "git"],
    packages=[
        "flytekitplugins-perian-job",
    ],
)

@task(container_image=image_spec,
      task_config=PerianConfig(
        accelerators=1,
        accelerator_type="A100",
      ))
def perian_hello(name: str) -> str:
    return f"hello {name}!"

@workflow
def my_wf(name: str = "world") -> str:
    return perian_hello(name=name)