Skip to content

Commit

Permalink
merged in master
Browse files Browse the repository at this point in the history
  • Loading branch information
@Christian-B
Christian-B committed Mar 30, 2023
2 parents bc11555 + 9a007d6 commit 7bba76e
Show file tree
Hide file tree
Showing 28 changed files with 705 additions and 590 deletions.
3 changes: 2 additions & 1 deletion spinn_machine/__init__.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,8 @@
# See the License for the specific language governing permissions and
# limitations under the License.

""" An abstraction of a SpiNNaker Machine. The main functionality is\
"""
An abstraction of a SpiNNaker Machine. The main functionality is
provided by :py:class:`spinn_machine.Machine`.
Functional Requirements
Expand Down
106 changes: 58 additions & 48 deletions spinn_machine/chip.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,13 +19,14 @@


class Chip(object):
""" Represents a SpiNNaker chip with a number of cores, an amount of\
SDRAM shared between the cores, and a router.\
The chip is iterable over the processors, yielding\
``(processor_id, processor)`` where:
"""
Represents a SpiNNaker chip with a number of cores, an amount of
SDRAM shared between the cores, and a router.
The chip is iterable over the processors, yielding
``(processor_id, processor)`` where:
* ``processor_id`` is the ID of a processor
* ``processor`` is the :py:class:`Processor` with ``processor_id``
* ``processor_id`` is the ID of a processor
* ``processor`` is the :py:class:`Processor` with ``processor_id``
"""

# tag 0 is reserved for stuff like IO STD
Expand Down Expand Up @@ -55,7 +56,7 @@ def __init__(self, x, y, n_processors, router, sdram, nearest_ethernet_x,
the IP address of the chip, or ``None`` if no Ethernet attached
:type ip_address: str or None
:param tag_ids: IDs to identify the chip for SDP can be empty to
define no tags or None to allocate tag automatically
define no tags or `None` to allocate tag automatically
based on if there is an ip_address
:type tag_ids: iterable(int) or None
:param nearest_ethernet_x: the nearest Ethernet x coordinate
Expand Down Expand Up @@ -114,8 +115,9 @@ def __generate_processors(self, n_processors, down_cores):
return processors

def is_processor_with_id(self, processor_id):
""" Determines if a processor with the given ID exists in the chip.\
Also implemented as ``__contains__(processor_id)``
"""
Determines if a processor with the given ID exists in the chip.
Also implemented as ``__contains__(processor_id)``
:param int processor_id: the processor ID to check for
:return: Whether the processor with the given ID exists
Expand All @@ -124,8 +126,9 @@ def is_processor_with_id(self, processor_id):
return processor_id in self._p

def get_processor_with_id(self, processor_id):
""" Return the processor with the specified ID, or ``None`` if the\
processor does not exist.
"""
Return the processor with the specified ID, or ``None`` if the
processor does not exist.
:param int processor_id: the ID of the processor to return
:return:
Expand All @@ -139,105 +142,108 @@ def get_processor_with_id(self, processor_id):

@property
def x(self):
""" The x-coordinate of the chip in the two-dimensional grid of chips
"""
The X-coordinate of the chip in the two-dimensional grid of chips.
:return: the x-coordinate of the chip
:rtype: int
"""
return self._x

@property
def y(self):
""" The y-coordinate of the chip in the two-dimensional grid of chips
"""
The Y-coordinate of the chip in the two-dimensional grid of chips.
:return: the y-coordinate of the chip
:rtype: int
"""
return self._y

@property
def processors(self):
""" An iterable of available processors
"""
An iterable of available processors.
:rtype: iterable(Processor)
"""
return iter(self._p.values())

@property
def n_processors(self):
""" The total number of processors
"""
The total number of processors.
:rtype: int
"""
return len(self._p)

@property
def n_user_processors(self):
""" The total number of processors that are not monitors
"""
The total number of processors that are not monitors.
:rtype: int
"""
return self._n_user_processors

@property
def router(self):
""" The router object associated with the chip
"""
The router object associated with the chip.
:return: router associated with the chip
:rtype: Router
"""
return self._router

@property
def sdram(self):
""" The SDRAM associated with the chip
"""
The SDRAM associated with the chip.
:return: SDRAM associated with the chip
:rtype: SDRAM
"""
return self._sdram

@property
def ip_address(self):
""" The IP address of the chip
"""
The IP address of the chip, or ``None`` if there is no Ethernet
connected to the chip.
:return: IP address of the chip, or ``None`` if there is no Ethernet
connected to the chip
:rtype: str or None
"""
return self._ip_address

@property
def nearest_ethernet_x(self):
""" The x coordinate of the nearest Ethernet chip
"""
The X-coordinate of the nearest Ethernet chip.
:return: the x coordinate of the nearest Ethernet chip
:rtype: int
"""
return self._nearest_ethernet_x

@property
def nearest_ethernet_y(self):
""" The y coordinate of the nearest Ethernet chip
"""
The Y-coordinate of the nearest Ethernet chip.
:return: the y coordinate of the nearest Ethernet chip
:rtype: int
"""
return self._nearest_ethernet_y

@property
def tag_ids(self):
""" The tag IDs supported by this chip
"""
The tag IDs supported by this chip.
:return: the set of IDs.
:rtype: iterable(int)
"""
return self._tag_ids

def get_first_none_monitor_processor(self):
""" Get the first processor in the list which is not a monitor core
"""
Get the first processor in the list which is not a monitor core.
:return: a processor, if any non-monitor processors exist
:rtype: Processor or None
"""
for processor in self.processors:
Expand All @@ -247,16 +253,18 @@ def get_first_none_monitor_processor(self):

@property
def parent_link(self):
""" The link down which the parent is found in the tree of chips rooted
at the machine root chip (probably 0, 0 in most cases). This will
be ``None`` if the chip information didn't contain this value.
"""
The link down which the parent is found in the tree of chips rooted
at the machine root chip (probably 0, 0 in most cases). This will
be ``None`` if the chip information didn't contain this value.
:rtype: int or None
"""
return self._parent_link

def get_physical_core_id(self, virtual_p):
""" Get the physical core ID from a virtual core ID
"""
Get the physical core ID from a virtual core ID.
:param int virtual_p: The virtual core ID
:rtype: int or None if core not in map
Expand All @@ -267,8 +275,9 @@ def get_physical_core_id(self, virtual_p):
return self._v_to_p_map[virtual_p]

def get_physical_core_string(self, virtual_p):
""" Get a string that can be appended to a core to show the physical
core, or an empty string if not possible
"""
Get a string that can be appended to a core to show the physical
core, or an empty string if not possible.
:param int virtual_p: The virtual core ID
:rtype: str
Expand All @@ -279,7 +288,8 @@ def get_physical_core_string(self, virtual_p):
return f" (ph: {physical_p})"

def __iter__(self):
""" Get an iterable of processor identifiers and processors
"""
Get an iterable of processor identifiers and processors
:return: An iterable of ``(processor_id, processor)`` where:
* ``processor_id`` is the ID of a processor
Expand All @@ -289,7 +299,8 @@ def __iter__(self):
return iter(self._p.items())

def __len__(self):
""" The number of processors associated with this chip.
"""
The number of processors associated with this chip.
:return: The number of items in the underlying iterator.
:rtype: int
Expand All @@ -306,14 +317,13 @@ def __getitem__(self, processor_id):
def __contains__(self, processor_id):
return self.is_processor_with_id(processor_id)

__REPR_TEMPLATE = ("[Chip: x={}, y={}, sdram={}, ip_address={}, "
"router={}, processors={}, nearest_ethernet={}:{}]")

def __str__(self):
return self.__REPR_TEMPLATE.format(
self._x, self._y, self.sdram, self.ip_address,
self.router, list(self._p.values()),
self._nearest_ethernet_x, self._nearest_ethernet_y)
return (
f"[Chip: x={self._x}, y={self._y}, sdram={self.sdram}, "
f"ip_address={self.ip_address}, router={self.router}, "
f"processors={list(self._p.values())}, "
f"nearest_ethernet={self._nearest_ethernet_x}:"
f"{self._nearest_ethernet_y}]")

def __repr__(self):
return self.__str__()
27 changes: 15 additions & 12 deletions spinn_machine/core_subset.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@


class CoreSubset(object):
""" Represents a subset of the cores on a SpiNNaker chip.
"""
Represents a subset of the cores on a SpiNNaker chip.
"""

__slots__ = (
Expand All @@ -36,7 +37,8 @@ def __init__(self, x, y, processor_ids):
self.add_processor(processor_id)

def add_processor(self, processor_id):
""" Adds a processor ID to this subset
"""
Adds a processor ID to this subset
:param int processor_id: A processor ID
"""
Expand All @@ -47,33 +49,33 @@ def __contains__(self, processor_id):

@property
def x(self):
""" The x-coordinate of the chip
"""
The X-coordinate of the chip
:return: The x-coordinate
:rtype: int
"""
return self._x

@property
def y(self):
""" The y-coordinate of the chip
"""
The Y-coordinate of the chip
:return: The y-coordinate
:rtype: int
"""
return self._y

@property
def processor_ids(self):
""" The subset of processor IDs on the chip
"""
The processor IDs on the chip that in the subset.
:return: An iterable of processor IDs
:rtype: iterable(int)
"""
return iter(self._processor_ids)

def __repr__(self):
return "{}:{}:{}".format(self._x, self._y, self._processor_ids)
return f"{self._x}:{self._y}:{self._processor_ids}"

def __eq__(self, other):
if not isinstance(other, CoreSubset):
Expand All @@ -89,13 +91,14 @@ def __hash__(self):
return (self._x, self._y, processors).__hash__()

def __len__(self):
""" The number of processors in this core subset
"""
The number of processors in this core subset.
"""
return len(self._processor_ids)

def intersect(self, other):
""" Returns a new CoreSubset which is an intersect of this and the\
other.
"""
Returns a new CoreSubset which is an intersect of this and the other.
:param CoreSubset other:
A second CoreSubset with possibly overlapping cores
Expand Down
Loading

0 comments on commit 7bba76e

Please sign in to comment.