Module Schedulers.Multicore

Parameters

Signature

include Ir.Backend_intf.Backend_device_common with type buffer_ptr = Backend.buffer_ptr
include Ir.Backend_intf.Device with type buffer_ptr = Backend.buffer_ptr
include Ir.Backend_intf.Device_types with type buffer_ptr = Backend.buffer_ptr
include Ir.Backend_intf.Device_config with type buffer_ptr = Backend.buffer_ptr
include Ir.Backend_intf.Buffer with type buffer_ptr = Backend.buffer_ptr
type buffer_ptr = Backend.buffer_ptr
include sig ... end
type dev

Interface to a device driver.

val sexp_of_dev : dev -> Sexplib0.Sexp.t
type runner

Interface to a stream driver.

val sexp_of_runner : runner -> Sexplib0.Sexp.t
type event

An event tracks if a stream finished computing past a particular point in its schedue. These values are used internally for scheduling across streams of the backend, and can be used for explicit scheduling.

val sexp_of_event : event -> Sexplib0.Sexp.t
val name : Base.string
val sexp_of_device : device -> Sexplib0.Sexp.t
val sexp_of_stream : stream -> Sexplib0.Sexp.t
type nonrec context = (buffer_ptr, stream) Ir.Backend_intf.context
val sexp_of_context : context -> Sexplib0.Sexp.t
include Ir.Backend_intf.Alloc_buffer with type buffer_ptr := buffer_ptr and type stream := stream
include Ir.Backend_intf.Buffer with type buffer_ptr := buffer_ptr
val sexp_of_buffer_ptr : buffer_ptr -> Sexplib0.Sexp.t
include sig ... end
type nonrec buffer = buffer_ptr Ir.Backend_intf.buffer
val sexp_of_buffer : buffer -> Sexplib0.Sexp.t
type nonrec ctx_arrays = buffer_ptr Ir.Backend_intf.ctx_arrays
val sexp_of_ctx_arrays : ctx_arrays -> Sexplib0.Sexp.t
val alloc_buffer : ?old_buffer:buffer -> size_in_bytes:Base.int -> stream -> buffer
val alloc_zero_init_array : Ir.Ops.prec -> dims:Base.int Base.array -> stream -> buffer_ptr
val free_buffer : (stream -> buffer_ptr -> Base.unit) Base.option
val make_device : dev -> ordinal:Base.int -> device
val make_stream : device -> runner -> stream
val make_context : ?ctx_arrays:ctx_arrays -> stream -> context

Returns a context without a parent.

val make_child : ?ctx_arrays:ctx_arrays -> context -> context

Returns a context with the same Backend_intf.context.stream, and Backend_intf.context.ctx_arrays if omitted, as the given context's, which is also the Backend_intf.context.parent.

val get_name : stream -> Base.string
val sync : event -> Base.unit

Blocks till the event completes, if it's not done already.

It is rarely needed to call sync explicitly, because it should always be called internally when necessary, in particular before extracting values from host.

val is_done : event -> Base.bool

Whether the event completed.

val will_wait_for : context -> event -> Base.unit

Schedules waiting for the given event on the context's stream.

NOTE: it should rarely be needed to call will_wait_for explicitly, because it should always be called internally when necessary.

val static_properties : Base.Sexp.t

Returns a sexp description of the properties of all devices.

val get_used_memory : device -> Base.int

Returns (an upper bound of) the memory used for arrays, in bytes.

val get_global_debug_info : Base.unit -> Base.Sexp.t

Global debug information; backend-specific and might evolve independently on the backends.

val get_debug_info : stream -> Base.Sexp.t

Per-stream debug information; backend-specific and might evolve independently on the backends

val await : stream -> Base.unit

Blocks till the stream becomes idle, i.e. synchronizes the stream.

val all_work : stream -> event

Returns the event indicating if any currently running or scheduled computations on the stream have completed.

val is_idle : stream -> Base.bool

Whether the stream is currently waiting for work.

val get_device : ordinal:Base.int -> device
val num_devices : Base.unit -> Base.int
val suggested_num_streams : device -> Base.int

The optimal number of streams for the given device to follow the Backend_intf.config strategy.

val new_stream : device -> stream
val schedule_task : stream -> Ir.Task.t -> Base.unit