Skip to content

Endpoint reference

Endpoint

Bases: EndpointDesc

Endpoint class to describe an endpoint with adress ranges and configuration parameters.

num = None class-attribute instance-attribute

The total number of endpoints based on the array configuration.

addr_range_to_list(v) classmethod

Convert single AddrRange to list.

check_addr_range()

Check if the address range is valid.

dict_to_coord_obj(v) classmethod

Convert dict to Coord object.

from_desc(desc, mgr_ports, sbr_ports) classmethod

Create an endpoint from a description.

get_ni_name(name)

Return the name of the NI.

int_to_tuple(v) classmethod

Convert int to tuple.

is_collective_ep()

Return true if the endpoint supports collective operations.

is_mgr()

Return true if the endpoint is a manager.

is_only_mgr()

Return true if the endpoint is only a manager.

is_only_sbr()

Return true if the endpoint is only a subordinate.

is_sbr()

Return true if the endpoint is a subordinate.

render_ports(pkg_name='')

Render the ports of the endpoint.

set_number_eps()

Set the number of endpoints based on array

EndpointDesc

Bases: BaseModel

Endpoint class to describe an endpoint with adress ranges and configuration parameters.

Attributes:

Name Type Description
name str

Unique identifier for the endpoint. Used in connection definitions.
description Optional[str]

Optional description of the endpoint.
array Optional[Union[Tuple[int], Tuple[int, int]]]

Defines the endpoint as an array (1D or 2D). E.g., [4] for a 1D array of size 4, or [4, 4] for a 4x4 grid.
addr_range List[AddrRange]

Defines the address regions served by this endpoint (required if it acts as a Subordinate).
xy_id_offset Optional[Union[SimpleId, Coord]]

Offsets for XY coordinates or IDs, used to manually adjust the logical position of the endpoint in the network.
mgr_port_protocol Optional[List[str]]

List of protocol names (defined in protocols) that this endpoint uses to send requests (Manager role).
sbr_port_protocol Optional[List[str]]

List of protocol names (defined in protocols) that this endpoint uses to receive requests (Subordinate role).

num = None class-attribute instance-attribute

The total number of endpoints based on the array configuration.

addr_range_to_list(v) classmethod

Convert single AddrRange to list.

check_addr_range()

Check if the address range is valid.

dict_to_coord_obj(v) classmethod

Convert dict to Coord object.

get_ni_name(name)

Return the name of the NI.

int_to_tuple(v) classmethod

Convert int to tuple.

is_collective_ep()

Return true if the endpoint supports collective operations.

is_mgr()

Return true if the endpoint is a manager.

is_only_mgr()

Return true if the endpoint is only a manager.

is_only_sbr()

Return true if the endpoint is only a subordinate.

is_sbr()

Return true if the endpoint is a subordinate.

render_ports()

Render the ports of the endpoint.

set_number_eps()

Set the number of endpoints based on array