Skip to content

← random package

RandomPermute

Return an array that has the items in the given array permuted along the first axis.

If deterministic results are sought, pass in a seed; see also CreateRandomSeed for documentation on how seeds are best managed. The node supports alternative compute backends, which can be used to speed up processing. Version 0.8.0

Ports/Properties

array

Array to permute.

  • verbose name: Array
  • default value: None
  • port type: DataPort
  • value type: AnyArray (can be None)
  • data direction: INOUT

seed

Random seed for deterministic results.

  • verbose name: Seed
  • default value: None
  • port type: DataPort
  • value type: AnyArray (can be None)
  • data direction: IN

backend

Optional compute backend to use. Keep is the current default, which resolves to that of the provided array and otherwise numpy unless overridden. Numpy is the standard CPU backend that underpins most of NeuroPype's operations. The others require one or more GPUs to be present on the system, except for torch-cpu. For best performance, keep all arrays that interact with each other (via processing nodes) on the same backend.

  • verbose name: Backend
  • default value: keep
  • port type: EnumPort
  • value type: str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

  • verbose name: Set Breakpoint (Debug Only)
  • default value: False
  • port type: BoolPort
  • value type: bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

  • verbose name: Metadata
  • default value: {}
  • port type: DictPort
  • value type: dict (can be None)