pacman.model.resources package

Module contents

class pacman.model.resources.AbstractSDRAM[source]

Bases: object

Represents an amount of SDRAM used on a chip in the machine.

fixed

Returns the fixed SDRAM cost

get_total_sdram(n_timesteps)[source]

The total SDRAM.

Parameters:n_timesteps (int) – number of timesteps to cost for
Returns:
per_timestep

Returns extra SDRAM cost for each additional timestep

Warning

May well be zero.

report(timesteps, indent='', preamble='', target=None)[source]

Writes a description of this SDRAM to the target.

Parameters:
  • timesteps (int) – Number of timesteps to do total cost for
  • indent (str) – Text at the start of this and all children
  • preamble (str) – Additional text at the start but not in children
  • target (file) – Where to write the output. None is standard print
sub_from(other)[source]

Creates a new SDRAM which is the other less this one

Parameters:other (AbstractSDRAM) – another SDRAM resource
Returns:a New AbstractSDRAM
Return type:AbstractSDRAM
class pacman.model.resources.ConstantSDRAM(sdram)[source]

Bases: pacman.model.resources.abstract_sdram.AbstractSDRAM

Represents an amount of SDRAM used on a chip in the machine.

This is used when the amount of SDRAM needed is not effected by runtime

Parameters:sdram (int or int64) – The amount of SDRAM in bytes
fixed

Returns the fixed SDRAM cost

get_total_sdram(n_timesteps)[source]

The total SDRAM.

Parameters:n_timesteps (int) – number of timesteps to cost for
Returns:
per_timestep

Returns extra SDRAM cost for each additional timestep

Warning

May well be zero.

report(timesteps, indent='', preamble='', target=None)[source]

Writes a description of this SDRAM to the target.

Parameters:
  • timesteps (int) – Number of timesteps to do total cost for
  • indent (str) – Text at the start of this and all children
  • preamble (str) – Additional text at the start but not in children
  • target (file) – Where to write the output. None is standard print
sub_from(other)[source]

Creates a new SDRAM which is the other less this one

Parameters:other (AbstractSDRAM) – another SDRAM resource
Returns:a New AbstractSDRAM
Return type:AbstractSDRAM
class pacman.model.resources.CoreResource(chip, n_cores)[source]

Bases: object

Represents the number of cores that need to be allocated.

Parameters:
  • n_cores (int) – The number of cores to allocate
  • chip (Chip) – chip of where these cores are to be allocated
chip
get_value()[source]
Returns:The chip and the cores required on it.
Return type:tuple(Chip, int)
n_cores
class pacman.model.resources.CPUCyclesPerTickResource(cycles)[source]

Bases: object

Represents the number of CPU clock cycles per tick used or available on a core of a chip in the machine.

Parameters:cycles (int or int64) – The number of CPU clock cycles
get_value()[source]
Returns:The number of CPU clock cycles needed per simulation tick.
Return type:int
class pacman.model.resources.DTCMResource(dtcm)[source]

Bases: object

Represents the amount of local core memory available or used on a core on a chip of the machine.

Parameters:dtcm (int or numpy.integer) – The amount of DTCM in bytes
get_value()[source]
Returns:The required amount of DTCM, in bytes.
Return type:int
class pacman.model.resources.ElementFreeSpace(start_address, size)[source]

Bases: object

Parameters:
  • start_address (int) –
  • size (int) –
size
Return type:int
start_address
Return type:int
class pacman.model.resources.IPtagResource(ip_address, port, strip_sdp, tag=None, traffic_identifier='DEFAULT')[source]

Bases: object

Represents the ability to have a SpiNNaker machine send messages to you during execution.

Parameters:
  • ip_address (str) – The IP address of the host that will receive data from this tag
  • port (int or None) – The port that will
  • strip_sdp (bool) – Whether the tag requires that SDP headers are stripped before transmission of data
  • tag (int or None) – A fixed tag ID to assign, or None if any tag is OK
  • traffic_identifier (str) – The traffic to be sent using this tag; traffic with the same traffic_identifier can be sent using the same tag
get_value()[source]
Returns:The description of the IP tag.
Return type:list(str, int, bool, int, str)
ip_address

The IP address to assign to the tag

Return type:str
port

The port of the tag

Return type:int
strip_sdp

Whether SDP headers should be stripped for this tag

Return type:bool
tag

The tag required, or None if any tag is OK

Return type:int or None
traffic_identifier

The traffic identifier for this IP tag

class pacman.model.resources.MultiRegionSDRAM[source]

Bases: pacman.model.resources.variable_sdram.VariableSDRAM

A resource for SDRAM that comes in regions

add_cost(region, fixed_sdram, per_timestep_sdram=0)[source]

Adds the cost for the specified region

Parameters:
  • region (int or str or enum) – Key to identify the region
  • fixed_sdram (int or numpy.integer) – The fixed cost for this region.
  • per_timestep_sdram (int or numpy.integer) – The variable cost for this region is any
merge(other)[source]

Combines the other SDRAM costs keeping the region mappings

Parameters:other (MultiRegionSDRAM) – Another mapping of costs by region
nest(region, other)[source]

Combines the other SDRAM cost, in a nested fashion.

The totals for the new region are added to the total of this one. A new region is created summarising the cost of others. If other contains a regions which is the same as one in self they are not combined, but kept separate.

Parameters:
  • region (int or str or enum) – Key to identify the summary region
  • other (AbstractSDRAM) – Another SDRAM model to make combine by nesting
regions
report(timesteps, indent='', preamble='', target=None)[source]

Writes a description of this SDRAM to the target.

Parameters:
  • timesteps (int) – Number of timesteps to do total cost for
  • indent (str) – Text at the start of this and all children
  • preamble (str) – Additional text at the start but not in children
  • target (file) – Where to write the output. None is standard print
class pacman.model.resources.ResourceContainer(dtcm=None, sdram=None, cpu_cycles=None, iptags=None, reverse_iptags=None)[source]

Bases: object

Container for the types of resources so that ordering is not a problem.

Parameters:
cpu_cycles
dtcm
extend(other)[source]
Parameters:other (ResourceContainer) –
iptags
reverse_iptags
sdram
class pacman.model.resources.ReverseIPtagResource(port=None, sdp_port=1, tag=None)[source]

Bases: object

Represents the ability to talk to a SpiNNaker machine by sending UDP packets to it during execution.

Parameters:
  • port (int or None) – The UDP port to listen to on the board for this tag or None for a default
  • sdp_port (int) – The SDP port number to be used when constructing SDP packets from the received UDP packets for this tag
  • tag (int or None) – A fixed tag ID to assign, or None if any tag is OK
get_value()[source]
Returns:The description of the reverse IP tag.
Return type:list(int, int, int)
port

The port of the tag

Return type:int
sdp_port

The SDP port to use when constructing the SDP message from the received UDP message

Return type:int
tag

The tag required, or None if any tag is OK

Return type:int or None
class pacman.model.resources.PreAllocatedResourceContainer(specific_sdram_usage=None, specific_core_resources=None, core_resources=None, specific_iptag_resources=None, specific_reverse_iptag_resources=None)[source]

Bases: object

Container object for preallocated resources

Parameters:
  • specific_sdram_usage (iterable(SpecificChipSDRAMResource)) – iterable of SpecificSDRAMResource which states that specific chips have missing SDRAM
  • specific_core_resources (iterable(SpecificCoreResource)) – states which cores have been preallocated
  • core_resources (iterable(CoreResource)) – states a number of cores have been preallocated but don’t care which ones they are
  • specific_iptag_resources (list(SpecificBoardTagResource)) –
  • specific_reverse_iptag_resources (list(SpecificReverseIPTagResource)) –
core_resources
extend(other)[source]
Parameters:other (PreAllocatedResourceContainer) –
specific_core_resources
specific_iptag_resources
specific_reverse_iptag_resources
specific_sdram_usage
class pacman.model.resources.SpecificChipSDRAMResource(chip, sdram_usage)[source]

Bases: object

Represents the SDRAM required for this Chip

Parameters:
  • sdram_usage (AbstractSDRAM) – The amount of SDRAM in bytes needed to be preallocated
  • chip (Chip) – chip of where the SDRAM is to be allocated
chip
Return type:Chip
get_value()[source]
Returns:The chip for which it is required, and the amount of SDRAM required thereon, in bytes.
Return type:tuple(Chip, AbstractSDRAM)
sdram_usage
Return type:AbstractSDRAM
class pacman.model.resources.SpecificCoreResource(chip, cores)[source]

Bases: object

Represents specific cores that need to be allocated.

Parameters:
  • cores (iterable(int)) – The specific cores that need to be allocated (list of processor IDs)
  • chip (Chip) – chip of where these cores are to be allocated
chip
Return type:Chip
cores
Return type:iterable(int)
get_value()[source]
Returns:The chip and the cores required on it.
Return type:tuple(Chip, iterable(int))
pacman.model.resources.SpecificBoardIPtagResource

alias of pacman.model.resources.specific_board_iptag_resource.SpecificBoardTagResource

pacman.model.resources.SpecificBoardReverseIPtagResource

alias of pacman.model.resources.specific_board_reverse_iptag_resource.ReverseIPtagResource

class pacman.model.resources.VariableSDRAM(fixed_sdram, per_timestep_sdram)[source]

Bases: pacman.model.resources.abstract_sdram.AbstractSDRAM

Represents an amount of SDRAM used on a chip in the machine.

This is where the usage increase as the run time increases

Parameters:
  • fixed_sdram – The amount of SDRAM (in bytes) that represents static overhead
  • per_timestep_sdram (float or numpy.float) – The amount of SDRAM (in bytes) required per timestep. Often represents the space to record a timestep.
fixed

Returns the fixed SDRAM cost

get_total_sdram(n_timesteps)[source]

The total SDRAM.

Parameters:n_timesteps (int) – number of timesteps to cost for
Returns:
per_timestep

Returns extra SDRAM cost for each additional timestep

Warning

May well be zero.

report(timesteps, indent='', preamble='', target=None)[source]

Writes a description of this SDRAM to the target.

Parameters:
  • timesteps (int) – Number of timesteps to do total cost for
  • indent (str) – Text at the start of this and all children
  • preamble (str) – Additional text at the start but not in children
  • target (file) – Where to write the output. None is standard print
sub_from(other)[source]

Creates a new SDRAM which is the other less this one

Parameters:other (AbstractSDRAM) – another SDRAM resource
Returns:a New AbstractSDRAM
Return type:AbstractSDRAM