Record Class ClusterFollower.Welcome

java.lang.Object

java.lang.Record

smile.llm.cluster.ClusterFollower.Welcome

Record Components:

worldSize - ranks of the whole communicator.

rankOffset - world rank of this follower's first rank.

uniqueId - the NCCL unique id (128 bytes).

params - settings every process must share.

Enclosing class:

ClusterFollower

public static record ClusterFollower.Welcome(int worldSize, int rankOffset, byte[] uniqueId, Map<String,String> params)
extends Record

What the leader tells a follower on connection.

Constructor Summary

Constructors

Constructor	Description
Welcome(int worldSize, int rankOffset, byte[] uniqueId, Map<String,String> params)	Creates an instance of a Welcome record class.

Method Summary

Modifier and Type	Method	Description
final boolean	equals(Object o)	Indicates whether some other object is "equal to" this one.
final int	hashCode()	Returns a hash code value for this object.
Map<String,String>	params()	Returns the value of the params record component.
int	rankOffset()	Returns the value of the rankOffset record component.
final String	toString()	Returns a string representation of this record class.
byte[]	uniqueId()	Returns the value of the uniqueId record component.
int	worldSize()	Returns the value of the worldSize record component.

Methods inherited from class Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

Welcome

public Welcome(int worldSize,
 int rankOffset,
 byte[] uniqueId,
 Map<String,String> params)

Creates an instance of a Welcome record class.

Parameters:

worldSize - the value for the worldSize record component

rankOffset - the value for the rankOffset record component

uniqueId - the value for the uniqueId record component

params - the value for the params record component

Method Details

toString

public final String toString()

Returns a string representation of this record class. The representation contains the name of the class, followed by the name and value of each of the record components.

Specified by:

toString in class Record

Returns:

a string representation of this object

hashCode

public final int hashCode()

Returns a hash code value for this object. The value is derived from the hash code of each of the record components.

Specified by:

hashCode in class Record

Returns:

a hash code value for this object

equals

public final boolean equals(Object o)

Indicates whether some other object is "equal to" this one. The objects are equal if the other object is of the same class and if all the record components are equal. Reference components are compared with Objects::equals(Object,Object); primitive components are compared with the compare method from their corresponding wrapper classes.

Specified by:

equals in class Record

Parameters:

o - the object with which to compare

Returns:

true if this object is the same as the o argument; false otherwise.

worldSize

public int worldSize()

Returns the value of the worldSize record component.

Returns:

the value of the worldSize record component

rankOffset

public int rankOffset()

Returns the value of the rankOffset record component.

Returns:

the value of the rankOffset record component

uniqueId

public byte[] uniqueId()

Returns the value of the uniqueId record component.

Returns:

the value of the uniqueId record component

params

public Map<String,String> params()

Returns the value of the params record component.

Returns:

the value of the params record component