+ * A handle to a Java actor. * - * A handle can be used to invoke a remote actor method, with the {@code "call"} method. For + *
A handle can be used to invoke a remote actor method, with the {@code "call"} method. For * example: - *
{@code
+ *
+ * {@code
* class MyActor {
* public int echo(int x) {
* return x;
@@ -19,11 +20,9 @@ package io.ray.api;
* Assert.assertEqual(result.get(), 1);
* }
*
- * Note, the {@code "call"} method is defined in {@link ActorCall} interface, with multiple
+ * Note, the {@code "call"} method is defined in {@link ActorCall} interface, with multiple
* overloaded versions.
*
* @param The type of the concrete actor class.
*/
-public interface ActorHandle extends BaseActorHandle, ActorCall {
-
-}
+public interface ActorHandle extends BaseActorHandle, ActorCall {}
diff --git a/java/api/src/main/java/io/ray/api/BaseActorHandle.java b/java/api/src/main/java/io/ray/api/BaseActorHandle.java
index 07360f723..bd875d075 100644
--- a/java/api/src/main/java/io/ray/api/BaseActorHandle.java
+++ b/java/api/src/main/java/io/ray/api/BaseActorHandle.java
@@ -3,15 +3,13 @@ package io.ray.api;
import io.ray.api.id.ActorId;
/**
- * A handle to an actor.
+ * A handle to an actor.
*
- * A handle can be used to invoke a remote actor method.
+ *
A handle can be used to invoke a remote actor method.
*/
public interface BaseActorHandle {
- /**
- * @return The id of this actor.
- */
+ /** Returns the id of this actor. */
ActorId getId();
/**
diff --git a/java/api/src/main/java/io/ray/api/ObjectRef.java b/java/api/src/main/java/io/ray/api/ObjectRef.java
index 6b58781dc..23e67f3f5 100644
--- a/java/api/src/main/java/io/ray/api/ObjectRef.java
+++ b/java/api/src/main/java/io/ray/api/ObjectRef.java
@@ -2,15 +2,14 @@ package io.ray.api;
/**
* Represents a reference to an object in the object store.
+ *
* @param The object type.
*/
public interface ObjectRef {
/**
- * Fetch the object from the object store, this method will block
- * until the object is locally available.
+ * Fetch the object from the object store, this method will block until the object is locally
+ * available.
*/
T get();
-
}
-
diff --git a/java/api/src/main/java/io/ray/api/PyActorHandle.java b/java/api/src/main/java/io/ray/api/PyActorHandle.java
index 01fb2dc4d..a2d603971 100644
--- a/java/api/src/main/java/io/ray/api/PyActorHandle.java
+++ b/java/api/src/main/java/io/ray/api/PyActorHandle.java
@@ -1,18 +1,11 @@
package io.ray.api;
-/**
- * Handle of a Python actor.
- */
+/** Handle of a Python actor. */
public interface PyActorHandle extends BaseActorHandle, PyActorCall {
- /**
- * @return Module name of the Python actor class.
- */
+ /** Returns the module name of the Python actor class. */
String getModuleName();
- /**
- * @return Name of the Python actor class.
- */
+ /** Returns the name of the Python actor class. */
String getClassName();
}
-
diff --git a/java/api/src/main/java/io/ray/api/Ray.java b/java/api/src/main/java/io/ray/api/Ray.java
index 7763fae43..3100d60a1 100644
--- a/java/api/src/main/java/io/ray/api/Ray.java
+++ b/java/api/src/main/java/io/ray/api/Ray.java
@@ -12,16 +12,12 @@ import java.util.Map;
import java.util.Optional;
import java.util.concurrent.Callable;
-/**
- * This class contains all public APIs of Ray.
- */
+/** This class contains all public APIs of Ray. */
public final class Ray extends RayCall {
private static RayRuntime runtime = null;
- /**
- * Initialize Ray runtime with the default runtime implementation.
- */
+ /** Initialize Ray runtime with the default runtime implementation. */
public static void init() {
try {
Class clz = Class.forName("io.ray.runtime.DefaultRayRuntimeFactory");
@@ -30,7 +26,6 @@ public final class Ray extends RayCall {
} catch (Exception e) {
throw new RuntimeException("Failed to initialize Ray runtime.", e);
}
-
}
/**
@@ -45,9 +40,7 @@ public final class Ray extends RayCall {
}
}
- /**
- * Shutdown Ray runtime.
- */
+ /** Shutdown Ray runtime. */
public static synchronized void shutdown() {
if (runtime != null) {
internal().shutdown();
@@ -57,7 +50,8 @@ public final class Ray extends RayCall {
/**
* Check if {@link #init} has been called yet.
- * @return True if {@link #init} has already been called and false otherwise.
+ *
+ * Returns True if {@link #init} has already been called and false otherwise.
*/
public static boolean isInitialized() {
return runtime != null;
@@ -66,8 +60,8 @@ public final class Ray extends RayCall {
/**
* Store an object in the object store.
*
- * @param obj The Java object to be stored.
- * @return A ObjectRef instance that represents the in-store object.
+ * @param obj The Java object to be stored. Returns A ObjectRef instance that represents the
+ * in-store object.
*/
public static ObjectRef put(T obj) {
return internal().put(obj);
@@ -76,8 +70,7 @@ public final class Ray extends RayCall {
/**
* Get an object by `ObjectRef` from the object store.
*
- * @param objectRef The reference of the object to get.
- * @return The Java object.
+ * @param objectRef The reference of the object to get. Returns The Java object.
*/
public static T get(ObjectRef objectRef) {
return internal().get(objectRef);
@@ -86,45 +79,43 @@ public final class Ray extends RayCall {
/**
* Get a list of objects by `ObjectRef`s from the object store.
*
- * @param objectList A list of object references.
- * @return A list of Java objects.
+ * @param objectList A list of object references. Returns A list of Java objects.
*/
public static List get(List> objectList) {
return internal().get(objectList);
}
/**
- * Wait for a list of RayObjects to be locally available,
- * until specified number of objects are ready, or specified timeout has passed.
+ * Wait for a list of RayObjects to be locally available, until specified number of objects are
+ * ready, or specified timeout has passed.
*
* @param waitList A list of object references to wait for.
* @param numReturns The number of objects that should be returned.
- * @param timeoutMs The maximum time in milliseconds to wait before returning.
- * @return Two lists, one containing locally available objects, one containing the rest.
+ * @param timeoutMs The maximum time in milliseconds to wait before returning. Returns Two lists,
+ * one containing locally available objects, one containing the rest.
*/
- public static WaitResult wait(List> waitList, int numReturns,
- int timeoutMs) {
+ public static WaitResult wait(List> waitList, int numReturns, int timeoutMs) {
return internal().wait(waitList, numReturns, timeoutMs);
}
/**
- * A convenient helper method for Ray.wait. It will wait infinitely until
- * specified number of objects are locally available.
+ * A convenient helper method for Ray.wait. It will wait infinitely until specified number of
+ * objects are locally available.
*
* @param waitList A list of object references to wait for.
- * @param numReturns The number of objects that should be returned.
- * @return Two lists, one containing locally available objects, one containing the rest.
+ * @param numReturns The number of objects that should be returned. Returns Two lists, one
+ * containing locally available objects, one containing the rest.
*/
public static WaitResult wait(List> waitList, int numReturns) {
return internal().wait(waitList, numReturns, Integer.MAX_VALUE);
}
/**
- * A convenient helper method for Ray.wait. It will wait infinitely until
- * all objects are locally available.
+ * A convenient helper method for Ray.wait. It will wait infinitely until all objects are locally
+ * available.
*
- * @param waitList A list of object references to wait for.
- * @return Two lists, one containing locally available objects, one containing the rest.
+ * @param waitList A list of object references to wait for. Returns Two lists, one containing
+ * locally available objects, one containing the rest.
*/
public static WaitResult wait(List> waitList) {
return internal().wait(waitList, waitList.size(), Integer.MAX_VALUE);
@@ -132,13 +123,12 @@ public final class Ray extends RayCall {
/**
* Get a handle to a named actor of current job.
- *
- * Gets a handle to a named actor with the given name. The actor must
- * have been created with name specified.
*
- * @param name The name of the named actor.
- * @return an ActorHandle to the actor if the actor of specified name exists or an
- * Optional.empty()
+ *
Gets a handle to a named actor with the given name. The actor must have been created with
+ * name specified.
+ *
+ * @param name The name of the named actor. Returns an ActorHandle to the actor if the actor of
+ * specified name exists or an Optional.empty()
*/
public static Optional getActor(String name) {
return internal().getActor(name, false);
@@ -146,13 +136,12 @@ public final class Ray extends RayCall {
/**
* Get a handle to a global named actor.
- *
- * Gets a handle to a global named actor with the given name. The actor must
- * have been created with global name specified.
*
- * @param name The global name of the named actor.
- * @return an ActorHandle to the actor if the actor of specified name exists or an
- * Optional.empty()
+ *
Gets a handle to a global named actor with the given name. The actor must have been created
+ * with global name specified.
+ *
+ * @param name The global name of the named actor. Returns an ActorHandle to the actor if the
+ * actor of specified name exists or an Optional.empty()
*/
public static Optional getGlobalActor(String name) {
return internal().getActor(name, true);
@@ -162,7 +151,7 @@ public final class Ray extends RayCall {
* If users want to use Ray API in their own threads, call this method to get the async context
* and then call {@link #setAsyncContext} at the beginning of the new thread.
*
- * @return The async context.
+ * Returns The async context.
*/
public static Object getAsyncContext() {
return internal().getAsyncContext();
@@ -186,8 +175,7 @@ public final class Ray extends RayCall {
* If users want to use Ray API in their own threads, they should wrap their {@link Runnable}
* objects with this method.
*
- * @param runnable The runnable to wrap.
- * @return The wrapped runnable.
+ * @param runnable The runnable to wrap. Returns The wrapped runnable.
*/
public static Runnable wrapRunnable(Runnable runnable) {
return internal().wrapRunnable(runnable);
@@ -197,16 +185,13 @@ public final class Ray extends RayCall {
* If users want to use Ray API in their own threads, they should wrap their {@link Callable}
* objects with this method.
*
- * @param callable The callable to wrap.
- * @return The wrapped callable.
+ * @param callable The callable to wrap. Returns The wrapped callable.
*/
public static Callable wrapCallable(Callable callable) {
return internal().wrapCallable(callable);
}
- /**
- * Get the underlying runtime instance.
- */
+ /** Get the underlying runtime instance. */
public static RayRuntime internal() {
if (runtime == null) {
throw new IllegalStateException(
@@ -215,59 +200,49 @@ public final class Ray extends RayCall {
return runtime;
}
- /**
- * Update the resource for the specified client.
- * Set the resource for the specific node.
- */
+ /** Update the resource for the specified client. Set the resource for the specific node. */
public static void setResource(UniqueId nodeId, String resourceName, double capacity) {
internal().setResource(resourceName, capacity, nodeId);
}
- /**
- * Set the resource for local node.
- */
+ /** Set the resource for local node. */
public static void setResource(String resourceName, double capacity) {
internal().setResource(resourceName, capacity, UniqueId.NIL);
}
- /**
- * Get the runtime context.
- */
+ /** Get the runtime context. */
public static RuntimeContext getRuntimeContext() {
return internal().getRuntimeContext();
}
/**
- * Create a placement group.
- * A placement group is used to place actors according to a specific strategy
- * and resource constraints.
- * It will sends a request to GCS to preallocate the specified resources, which is asynchronous.
- * If the specified resource cannot be allocated, it will wait for the resource
- * to be updated and rescheduled.
- * This function only works when gcs actor manager is turned on.
+ * Create a placement group. A placement group is used to place actors according to a specific
+ * strategy and resource constraints. It will sends a request to GCS to preallocate the specified
+ * resources, which is asynchronous. If the specified resource cannot be allocated, it will wait
+ * for the resource to be updated and rescheduled. This function only works when gcs actor manager
+ * is turned on.
*
* @param name Name of the placement group.
* @param bundles Pre-allocated resource list.
- * @param strategy Actor placement strategy.
- * @return A handle to the created placement group.
+ * @param strategy Actor placement strategy. Returns A handle to the created placement group.
*/
- public static PlacementGroup createPlacementGroup(String name,
- List> bundles, PlacementStrategy strategy) {
+ public static PlacementGroup createPlacementGroup(
+ String name, List> bundles, PlacementStrategy strategy) {
return internal().createPlacementGroup(name, bundles, strategy);
}
- public static PlacementGroup createPlacementGroup(List> bundles,
- PlacementStrategy strategy) {
+ public static PlacementGroup createPlacementGroup(
+ List> bundles, PlacementStrategy strategy) {
return internal().createPlacementGroup(bundles, strategy);
}
/**
* Intentionally exit the current actor.
- *
- * This method is used to disconnect an actor and exit the worker.
*
- * @throws RuntimeException An exception is raised if this is a driver or this worker is not
- * an actor.
+ *
This method is used to disconnect an actor and exit the worker.
+ *
+ * @throws RuntimeException An exception is raised if this is a driver or this worker is not an
+ * actor.
*/
public static void exitActor() {
runtime.exitActor();
@@ -275,8 +250,8 @@ public final class Ray extends RayCall {
/**
* Get a placement group by placement group Id.
- * @param id placement group id.
- * @return The placement group.
+ *
+ * @param id placement group id. Returns The placement group.
*/
public static PlacementGroup getPlacementGroup(PlacementGroupId id) {
return internal().getPlacementGroup(id);
@@ -284,15 +259,16 @@ public final class Ray extends RayCall {
/**
* Get all placement groups in this cluster.
- * @return All placement groups.
+ *
+ *
Returns All placement groups.
*/
public static List getAllPlacementGroups() {
return internal().getAllPlacementGroups();
}
/**
- * Remove a placement group by id.
- * Throw RayException if remove failed.
+ * Remove a placement group by id. Throw RayException if remove failed.
+ *
* @param id Id of the placement group.
*/
public static void removePlacementGroup(PlacementGroupId id) {
diff --git a/java/api/src/main/java/io/ray/api/WaitResult.java b/java/api/src/main/java/io/ray/api/WaitResult.java
index c6d2e6f67..586c3dc77 100644
--- a/java/api/src/main/java/io/ray/api/WaitResult.java
+++ b/java/api/src/main/java/io/ray/api/WaitResult.java
@@ -3,8 +3,8 @@ package io.ray.api;
import java.util.List;
/**
- * Represents the result of a Ray.wait call. It contains 2 lists,
- * one containing the locally available objects, one containing the rest.
+ * Represents the result of a Ray.wait call. It contains 2 lists, one containing the locally
+ * available objects, one containing the rest.
*/
public final class WaitResult {
@@ -16,18 +16,13 @@ public final class WaitResult {
this.unready = unready;
}
- /**
- * Get the list of ready objects.
- */
+ /** Get the list of ready objects. */
public List> getReady() {
return ready;
}
- /**
- * Get the list of unready objects.
- */
+ /** Get the list of unready objects. */
public List> getUnready() {
return unready;
}
-
}
diff --git a/java/api/src/main/java/io/ray/api/call/ActorCreator.java b/java/api/src/main/java/io/ray/api/call/ActorCreator.java
index 16a24bda6..c6bb9cce8 100644
--- a/java/api/src/main/java/io/ray/api/call/ActorCreator.java
+++ b/java/api/src/main/java/io/ray/api/call/ActorCreator.java
@@ -21,10 +21,9 @@ public class ActorCreator extends BaseActorCreator> {
/**
* Set the JVM options for the Java worker that this actor is running in.
*
- * Note, if this is set, this actor won't share Java worker with other actors or tasks.
+ * Note, if this is set, this actor won't share Java worker with other actors or tasks.
*
- * @param jvmOptions JVM options for the Java worker that this actor is running in.
- * @return self
+ * @param jvmOptions JVM options for the Java worker that this actor is running in. Returns self
* @see io.ray.api.options.ActorCreationOptions.Builder#setJvmOptions(java.lang.String)
*/
public ActorCreator setJvmOptions(String jvmOptions) {
@@ -35,10 +34,9 @@ public class ActorCreator extends BaseActorCreator> {
/**
* Create a java actor remotely and return a handle to the created actor.
*
- * @return a handle to the created java actor.
+ *