Source code for ray.cross_language

from __future__ import absolute_import
from __future__ import division
from __future__ import print_function

from ray import Language
from ray.util.annotations import PublicAPI
from ray._raylet import JavaFunctionDescriptor
from ray._raylet import CppFunctionDescriptor

__all__ = [
    "java_function",
    "java_actor_class",
    "cpp_function",
]


def format_args(worker, args, kwargs):
    """Format args for various languages.

    Args:
        worker: The global worker instance.
        args: The arguments for cross language.
        kwargs: The keyword arguments for cross language.

    Returns:
        List of args and kwargs (if supported).
    """
    if not worker.load_code_from_local:
        raise ValueError(
            "Cross language feature needs --load-code-from-local to be set."
        )
    if kwargs:
        raise TypeError("Cross language remote functions does not support kwargs.")
    return args


def get_function_descriptor_for_actor_method(
    language, actor_creation_function_descriptor, method_name, signature: str
):
    """Get function descriptor for cross language actor method call.

    Args:
        language: Target language.
        actor_creation_function_descriptor:
            The function signature for actor creation.
        method_name: The name of actor method.
        signature: The signature for the actor method. When calling Java from Python,
            it should be string in the form of "{length_of_args}".

    Returns:
        Function descriptor for cross language actor method call.
    """
    if language == Language.JAVA:
        return JavaFunctionDescriptor(
            actor_creation_function_descriptor.class_name,
            method_name,
            signature,
        )
    elif language == Language.CPP:
        return CppFunctionDescriptor(
            method_name,
            "PYTHON",
            actor_creation_function_descriptor.class_name,
        )
    else:
        raise NotImplementedError(
            "Cross language remote actor method " f"not support language {language}"
        )


[docs]@PublicAPI(stability="beta") def java_function(class_name, function_name): """Define a Java function. Args: class_name (str): Java class name. function_name (str): Java function name. """ from ray.remote_function import RemoteFunction return RemoteFunction( Language.JAVA, lambda *args, **kwargs: None, JavaFunctionDescriptor(class_name, function_name, ""), None, # num_cpus, None, # num_gpus, None, # memory, None, # object_store_memory, None, # resources, None, # accelerator_type, None, # num_returns, None, # max_calls, None, # max_retries, None, # retry_exceptions, None, # runtime_env, None, # placement_group, None, ) # scheduling_strategy,
@PublicAPI(stability="beta") def cpp_function(function_name): """Define a Cpp function. Args: function_name (str): Cpp function name. """ from ray.remote_function import RemoteFunction return RemoteFunction( Language.CPP, lambda *args, **kwargs: None, CppFunctionDescriptor(function_name, "PYTHON"), None, # num_cpus, None, # num_gpus, None, # memory, None, # object_store_memory, None, # resources, None, # accelerator_type, None, # num_returns, None, # max_calls, None, # max_retries, None, # retry_exceptions, None, # runtime_env, None, # placement_group, None, ) # scheduling_strategy,
[docs]@PublicAPI(stability="beta") def java_actor_class(class_name): """Define a Java actor class. Args: class_name (str): Java class name. """ from ray.actor import ActorClass return ActorClass._ray_from_function_descriptor( Language.JAVA, JavaFunctionDescriptor(class_name, "<init>", ""), max_restarts=0, max_task_retries=0, num_cpus=None, num_gpus=None, memory=None, object_store_memory=None, resources=None, accelerator_type=None, runtime_env=None, )
@PublicAPI(stability="beta") def cpp_actor_class(create_function_name, class_name): """Define a Cpp actor class. Args: create_function_name (str): Create cpp class function name. class_name (str): Cpp class name. """ from ray.actor import ActorClass print("create func=", create_function_name, "class_name=", class_name) return ActorClass._ray_from_function_descriptor( Language.CPP, CppFunctionDescriptor(create_function_name, "PYTHON", class_name), max_restarts=0, max_task_retries=0, num_cpus=None, num_gpus=None, memory=None, object_store_memory=None, resources=None, accelerator_type=None, runtime_env=None, )