Source code for torchx.components.base.binary_component

# Copyright (c) Facebook, Inc. and its affiliates.
# All rights reserved.
#
# This source code is licensed under the BSD-style license found in the
# LICENSE file in the root directory of this source tree.

from typing import Dict, List, Optional

from torchx.specs import api


def binary_component(
    name: str,
    image: str,
    entrypoint: str,
    args: Optional[List[str]] = None,
    env: Optional[Dict[str, str]] = None,
    resource: api.Resource = api.NULL_RESOURCE,
) -> api.AppDef:
    """
    binary_component creates a single binary component from the
    provided arguments.

    >>> from torchx.components.base.binary_component import binary_component
    >>> binary_component(
    ...     name="datapreproc",
    ...     image="pytorch/pytorch:latest",
    ...     entrypoint="python3",
    ...     args=["--version"],
    ...     env={
    ...         "FOO": "bar",
    ...     },
    ... )
    AppDef(name='datapreproc', ...)
    """

    return api.AppDef(
        name=name,
        roles=[
            api.Role(
                name=name,
                image=image,
                entrypoint=entrypoint,
                args=args or [],
                env=env or {},
                resource=resource,
            ),
        ],
    )