Skip to content

API Reference

Generated from the source docstrings, so it cannot drift from the code.

Page Covers
pl Decorators, types, control flow, and the type-dispatched operator wrappers
pl.tile Tile-level operators — inside an InCore function
pl.tensor Tensor-level operators — orchestration, whole tensors
pl.system Synchronization, cache and cross-core primitives
pl.array Fixed-length arrays, mainly for pl.TASK_ID fan-in
pl.prefetch Asynchronous GM to L2 prefetch
pl.optimizations The entries that pl.at(..., optimizations=[...]) accepts

How to use it

Start from the catalog, not from here. It groups every operator by family with a one-line description, and each name links into the page above that carries its signature. These pages answer "what are the arguments"; the catalog answers "which operator do I want".

Names are canonical, not as you spell them. pl.create_tensor is an alias for tensor.create, so it appears here as create on the pl.tensor page. The catalog links resolve that for you.

A missing symbol is a bug in the docstring, not in the page. These pages render whatever the source carries; if something reads thin, the fix is in the docstring.

What the build checks

mkdocs build --strict fails on a docstring whose Args: names a parameter the signature does not have, and on a catalog link naming a symbol that is not rendered. Both are real defects, and both were found the first time these pages were built.

See Also