PopART Python API Reference
Version: latest
1. Introduction
2. PopART Python API
2.1. Sessions
2.1.1. Training session
2.1.2. Inference session
2.1.3. Session Options
2.2. Data input and output
2.3. Tensors
2.4. Optimizers
2.4.1. SGD
2.4.2. ConstSGD
2.4.3. Adam
2.4.4. AdaDelta, RMSProp & AdaGrad
2.5. Builder
2.5.1. AiGraphcoreOpset1
2.6. Data flow
2.7. Device manager
2.8. Ops
2.8.1. Op definition for PopART IR
2.9. Patterns
2.10. Utility classes
2.10.1. Writer
2.10.2. Error handling
2.10.3. Debug context
2.10.4. Input shape information
2.10.5. Type definitions
2.10.6. Enums
3. Index
4. Legal notices
PopART Python API Reference
This document is for previous versions of the Poplar SDK up to 2.6.
For up to date information, refer to the
PopART User Guide
»
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
O
|
P
|
R
|
S
|
T
|
V
|
W
_
__init__() (popart.DataFlow method)
(popart.InputShapeInfo method)
(popart.PyStepIO method)
(popart.PyStepIOCallback method)
A
abort() (popart.AiGraphcoreOpset1 method)
,
[1]
AccumulateOuterFragmentSchedule (class in popart)
AccumulateOuterFragmentSettings (class in popart)
accumulateOuterFragmentSettings (popart.SessionOptions property)
accumulationAndReplicationReductionType (popart.SessionOptions property)
accumulationFactor (popart.InferenceSession property)
(popart.SessionOptions property)
(popart.TrainingSession property)
accumulatorTensorLocationSettings (popart.SessionOptions property)
acquireAvailableDevice() (popart.DeviceManager method)
acquireDeviceById() (popart.DeviceManager method)
activationIOSchedule (popart.ExecutionPhaseSettings property)
activationTensorLocationSettings (popart.SessionOptions property)
Adam (class in popart)
AdamMode (class in popart)
Adaptive (class in popart)
AdaptiveMode (class in popart)
add() (popart.InputShapeInfo method)
,
[1]
AiGraphcore (class in popart.builder)
AiGraphcoreOpset1 (class in popart)
,
[1]
(class in popart.builder)
AiOnnx (class in popart.builder)
AiOnnx10 (class in popart.builder)
AiOnnx11 (class in popart.builder)
AiOnnx6 (class in popart.builder)
AiOnnx7 (class in popart.builder)
AiOnnx8 (class in popart.builder)
AiOnnx9 (class in popart.builder)
AiOnnxMl (class in popart.builder)
aliasZeroCopy (popart.SessionOptions property)
alphas() (popart.Adaptive method)
AnchorReturnType (class in popart)
AnchorReturnTypeId (class in popart)
anchors() (popart.DataFlow method)
,
[1]
art() (popart.DataFlow method)
,
[1]
atan2() (popart.AiGraphcoreOpset1 method)
,
[1]
attach() (popart.DeviceInfo method)
AutodiffSettings (class in popart)
AutodiffStitchStrategy (class in popart)
AutomaticLossScalingSettings (class in popart)
autoRecomputation (popart.SessionOptions property)
B
batchesPerStep() (popart.DataFlow method)
,
[1]
batchSchedule (popart.BatchSerializationSettings property)
BatchSerializationBatchSchedule (class in popart)
BatchSerializationMethod (class in popart)
BatchSerializationSettings (class in popart)
batchSerializationSettings (popart.SessionOptions property)
BatchSerializationTransformContext (class in popart)
beta1s() (popart.Adam method)
beta2s() (popart.Adam method)
bitwiseand() (popart.AiGraphcoreOpset1 method)
,
[1]
bitwisenot() (popart.AiGraphcoreOpset1 method)
,
[1]
bitwiseor() (popart.AiGraphcoreOpset1 method)
,
[1]
bitwisexnor() (popart.AiGraphcoreOpset1 method)
,
[1]
bitwisexor() (popart.AiGraphcoreOpset1 method)
,
[1]
Builder (class in popart)
(class in popart.builder)
C
cachePath (popart.SessionOptions property)
call() (popart.AiGraphcoreOpset1 method)
,
[1]
(popart.builder.AiGraphcore method)
clipAllWeights() (popart.ClipNormSettings static method)
ClipNormSettings (class in popart)
clipWeights() (popart.ClipNormSettings static method)
CommGroup (class in popart)
CommGroupType (class in popart)
,
[1]
compileAndExport() (popart.InferenceSession method)
(popart.TrainingSession method)
compileEngine (popart.SessionOptions property)
concatOnExecutionPhaseChange (popart.BatchSerializationSettings property)
concatOnPipelineStageChange (popart.BatchSerializationSettings property)
concatOnVirtualGraphChange (popart.BatchSerializationSettings property)
constantWeights (popart.SessionOptions property)
ConstSGD (class in popart)
,
[1]
copyvarupdate() (popart.AiGraphcoreOpset1 method)
,
[1]
createCpuDevice() (popart.DeviceManager method)
createImplicitPipeliningFwdOnlyProgram (popart.SessionOptions property)
createIpuModelDevice() (popart.DeviceManager method)
createOfflineIPUDevice() (popart.DeviceManager method)
createOfflineIpuFromDeviceInfo() (popart.DeviceManager method)
createSimDevice() (popart.DeviceManager method)
createSubgraphBuilder() (popart.Builder method)
(popart.builder.Builder method)
ctcbeamsearchdecoder() (popart.AiGraphcoreOpset1 method)
,
[1]
ctcloss() (popart.AiGraphcoreOpset1 method)
,
[1]
customCodeletCompileFlags (popart.SessionOptions property)
customCodelets (popart.SessionOptions property)
D
dampenings() (popart.SGD method)
DataFlow (class in popart)
,
[1]
dataFlow (popart.InferenceSession property)
(popart.TrainingSession property)
DataType (class in popart)
DebugContext (class in popart)
DebugInfo (class in popart)
decomposeGradSum (popart.SessionOptions property)
delayVarUpdates (popart.SessionOptions property)
depthtospace() (popart.AiGraphcoreOpset1 method)
,
[1]
detach() (popart.AiGraphcoreOpset1 method)
,
[1]
(popart.DeviceInfo method)
DeviceConnectionType (class in popart)
DeviceInfo (class in popart)
DeviceManager (class in popart)
DeviceSelectionCriterion (class in popart)
DeviceType (class in popart)
disableGradAccumulationTensorStreams (popart.SessionOptions property)
disableOptimizerStateTensorStreams (popart.SessionOptions property)
dotChecks (popart.SessionOptions property)
dotOpNames (popart.SessionOptions property)
dynamicadd() (popart.AiGraphcoreOpset1 method)
,
[1]
dynamicslice() (popart.AiGraphcoreOpset1 method)
,
[1]
dynamicupdate() (popart.AiGraphcoreOpset1 method)
,
[1]
dynamiczero() (popart.AiGraphcoreOpset1 method)
,
[1]
E
enableDistributedReplicatedGraphs (popart.SessionOptions property)
enableEngineCaching (popart.SessionOptions property)
enableExplicitIR() (popart.SessionOptions method)
enableExplicitMainLoops (popart.SessionOptions property)
enableFloatingPointChecks (popart.SessionOptions property)
enableFullyConnectedPass (popart.SessionOptions property)
enableGradientAccumulation (popart.SessionOptions property)
enableLoadAndOffloadRNGState (popart.SessionOptions property)
enableMergeExchange (popart.SessionOptions property)
enableNonStableSoftmax (popart.SessionOptions property)
enableOutlining (popart.SessionOptions property)
enableOutliningCopyCostPruning (popart.SessionOptions property)
enablePattern() (popart.Patterns method)
enablePipelining (popart.SessionOptions property)
enableReplicatedGraphs (popart.SessionOptions property)
enableRuntimeAsserts() (popart.Patterns method)
(popart.PyStepIO method)
enableStableNorm (popart.SessionOptions property)
enableStochasticRounding (popart.SessionOptions property)
enableSupportedDataTypeCasting (popart.SessionOptions property)
ensureFp32LossScaleTensor (popart.SessionOptions property)
enumerateDevices() (popart.DeviceManager method)
epss() (popart.Adam method)
(popart.Adaptive method)
ExchangeStrategy (class in popart)
exchangeStrategy() (popart.AnchorReturnType method)
(popart.InputSettings method)
excludedVirtualGraphs (popart.AccumulateOuterFragmentSettings property)
ExecutionPhaseIOSchedule (class in popart)
ExecutionPhaseSchedule (class in popart)
ExecutionPhaseSettings (class in popart)
executionPhaseSettings (popart.SessionOptions property)
explicitRecomputation (popart.SessionOptions property)
expm1() (popart.AiGraphcoreOpset1 method)
,
[1]
exportPoplarComputationGraph (popart.SessionOptions property)
exportPoplarVertexGraph (popart.SessionOptions property)
F
factor (popart.BatchSerializationSettings property)
finalDotOp (popart.SessionOptions property)
firstDotOp (popart.SessionOptions property)
fmod() (popart.AiGraphcoreOpset1 method)
,
[1]
fromIr() (popart.InferenceSession class method)
G
gelu() (popart.AiGraphcoreOpset1 method)
,
[1]
get() (popart.InputShapeInfo method)
,
[1]
getDefault() (popart.OptimizerValueMap method)
getGlobalReplicationFactor() (popart.SessionOptions method)
getGroupRepresentative() (popart.VariableSettings method)
getId() (popart.DebugInfo method)
getLossScalingVal() (popart.Optimizer method)
getProfilePath() (popart.OutOfMemoryException method)
getRealGroupSize() (popart.VariableSettings method)
getRetrievalMode() (popart.VariableSettings method)
getSharedVariableDomain() (popart.VariableSettings method)
getSummaryReport() (popart.OutOfMemoryException method)
globalReplicaOffset (popart.SessionOptions property)
globalReplicationFactor (popart.SessionOptions property)
GradientTensorTrackingMethod (class in popart)
groupCount() (popart.VariableSettings method)
groupHostSync (popart.SessionOptions property)
groupnormalization() (popart.AiGraphcoreOpset1 method)
,
[1]
groups() (popart.VariableSettings method)
H
has() (popart.InputShapeInfo method)
,
[1]
I
id() (popart.AnchorReturnType method)
identityloss() (popart.AiGraphcoreOpset1 method)
,
[1]
incrementmod() (popart.AiGraphcoreOpset1 method)
,
[1]
infer() (popart.writer.NetWriter method)
InferenceSession (class in popart)
init() (popart.AiGraphcoreOpset1 method)
,
[1]
initAnchorArrays() (popart.InferenceSession method)
(popart.TrainingSession method)
InitType (class in popart)
InputSettings (class in popart)
InputShapeInfo (class in popart)
,
[1]
insertSpecific() (popart.Adam method)
(popart.Adaptive method)
(popart.SGD method)
Instrumentation (class in popart)
instrumentWithHardwareCycleCounter (popart.SessionOptions property)
IrSerializationFormat (class in popart)
isAnchored() (popart.DataFlow method)
,
[1]
isConst() (popart.OptimizerValue method)
isPatternEnabled() (popart.Patterns method)
K
kahnTieBreaker (popart.SessionOptions property)
L
l1loss() (popart.AiGraphcoreOpset1 method)
,
[1]
learningRates() (popart.Adam method)
(popart.Adaptive method)
(popart.SGD method)
loadTileSet (popart.TensorLocation property)
location (popart.TensorLocationSettings property)
log1p() (popart.AiGraphcoreOpset1 method)
,
[1]
logDir (popart.SessionOptions property)
logical_if() (popart.builder.AiOnnx method)
loop() (popart.builder.AiOnnx method)
lstm() (popart.AiGraphcoreOpset1 method)
,
[1]
M
maxWeightNorms() (popart.Adam method)
meanAccumulationAndReplicationReductionStrategy (popart.SessionOptions property)
MeanReductionStrategy (class in popart)
mergeVarUpdate (popart.SessionOptions property)
mergeVarUpdateMemThreshold (popart.SessionOptions property)
MergeVarUpdateType (class in popart)
method (popart.BatchSerializationSettings property)
minElementsForOffChip (popart.TensorLocationSettings property)
minElementsForReplicatedTensorSharding (popart.TensorLocationSettings property)
module
popart.builder
popart.tensorinfo
popart.writer
momentums() (popart.Adaptive method)
(popart.SGD method)
multiconv() (popart.AiGraphcoreOpset1 method)
,
[1]
N
name (popart.AccumulateOuterFragmentSchedule property)
(popart.AdamMode property)
(popart.AdaptiveMode property)
(popart.AnchorReturnTypeId property)
(popart.AutodiffStitchStrategy property)
(popart.BatchSerializationBatchSchedule property)
(popart.BatchSerializationMethod property)
(popart.BatchSerializationTransformContext property)
(popart.CommGroupType property)
,
[1]
(popart.DataType property)
(popart.DeviceConnectionType property)
(popart.DeviceSelectionCriterion property)
(popart.DeviceType property)
(popart.ExchangeStrategy property)
(popart.ExecutionPhaseIOSchedule property)
(popart.ExecutionPhaseSchedule property)
(popart.GradientTensorTrackingMethod property)
(popart.InitType property)
(popart.Instrumentation property)
(popart.IrSerializationFormat property)
(popart.MeanReductionStrategy property)
(popart.MergeVarUpdateType property)
(popart.RecomputationType property)
(popart.RecomputeType property)
(popart.ReductionType property)
(popart.ReplicatedStreamMode property)
(popart.ReplicatedTensorSharding property)
,
[1]
(popart.ScatterReduction property)
(popart.SGDAccumulatorAndMomentum property)
(popart.SubgraphCopyingStrategy property)
(popart.SyncPattern property)
(popart.SyntheticDataMode property)
(popart.TensorRemapType property)
(popart.TensorStorage property)
(popart.TileSet property)
,
[1]
(popart.VariableRetrievalMode property)
(popart.VirtualGraphMode property)
(popart.WeightDecayMode property)
nAnchors() (popart.DataFlow method)
,
[1]
NetWriter (class in popart.writer)
nllloss() (popart.AiGraphcoreOpset1 method)
,
[1]
nop() (popart.AiGraphcoreOpset1 method)
,
[1]
numReplicasReturningVariable() (popart.VariableSettings method)
O
OpDefinition (class in popart)
OperatorIdentifier (class in popart)
Opset (class in popart.builder)
Optimizer (class in popart)
optimizerStateTensorLocationSettings (popart.SessionOptions property)
OptimizerValue (class in popart)
OptimizerValueMap (class in popart)
opxAliasChecking (popart.SessionOptions property)
opxModifyChecking (popart.SessionOptions property)
outlineSequenceBreakCost (popart.SessionOptions property)
outlineThreshold (popart.SessionOptions property)
OutOfMemoryException (class in popart)
P
packedDataBlock() (popart.AiGraphcoreOpset1 method)
,
[1]
partialsTypeMatMuls (popart.SessionOptions property)
Patterns (class in popart)
phases (popart.ExecutionPhaseSettings property)
popart.builder
module
popart.tensorinfo
module
popart.writer
module
prepareDevice() (popart.InferenceSession method)
(popart.TrainingSession method)
printtensor() (popart.AiGraphcoreOpset1 method)
,
[1]
PyStepIO (class in popart)
PyStepIOCallback (class in popart)
R
rearrangeAnchorsOnHost (popart.SessionOptions property)
rearrangeStreamsOnHost (popart.SessionOptions property)
RecomputationType (class in popart)
RecomputeType (class in popart)
reducemedian() (popart.AiGraphcoreOpset1 method)
,
[1]
ReductionType (class in popart)
remainder() (popart.AiGraphcoreOpset1 method)
,
[1]
replicaGroupSize (popart.CommGroup property)
replicatedallreduce() (popart.AiGraphcoreOpset1 method)
,
[1]
replicatedGraphCount (popart.SessionOptions property)
replicatedreducescatter() (popart.AiGraphcoreOpset1 method)
,
[1]
ReplicatedStreamMode (class in popart)
replicatedStreamMode() (popart.InputSettings method)
ReplicatedTensorSharding (class in popart)
,
[1]
replicatedTensorSharding (popart.TensorLocation property)
replicationFactor (popart.InferenceSession property)
(popart.TrainingSession property)
reshape() (popart.AiGraphcoreOpset1 method)
,
[1]
reshape_const() (popart.Builder method)
(popart.builder.Builder method)
reverse() (popart.AiGraphcoreOpset1 method)
,
[1]
round() (popart.AiGraphcoreOpset1 method)
,
[1]
rp() (popart.AnchorReturnType method)
S
saveModel() (popart.writer.NetWriter method)
scale() (popart.AiGraphcoreOpset1 method)
,
[1]
scaledadd() (popart.AiGraphcoreOpset1 method)
,
[1]
scan() (popart.builder.AiOnnx8 method)
(popart.builder.AiOnnx9 method)
scatterreduce() (popart.AiGraphcoreOpset1 method)
,
[1]
ScatterReduction (class in popart)
schedule (popart.AccumulateOuterFragmentSettings property)
scheduleNonWeightUpdateGradientConsumersEarly (popart.SessionOptions property)
separateCallOpPdfs (popart.SessionOptions property)
sequenceslice() (popart.AiGraphcoreOpset1 method)
,
[1]
serializedPoprithmsAnnealGraphsDir (popart.SessionOptions property)
serializedPoprithmsShiftGraphsDir (popart.SessionOptions property)
SessionOptions (class in popart)
setBatchesPerStep() (popart.DataFlow method)
,
[1]
setOnDemandAttachTimeout() (popart.DeviceManager method)
setValue() (popart.DebugInfo method)
SGD (class in popart)
SGDAccumulatorAndMomentum (class in popart)
shapeddropout() (popart.AiGraphcoreOpset1 method)
,
[1]
shapeOnHost() (popart.VariableSettings method)
shapeOnReplica() (popart.VariableSettings method)
shardingDomain (popart.TensorLocation property)
slice() (popart.AiGraphcoreOpset1 method)
,
[1]
stages (popart.ExecutionPhaseSettings property)
storage (popart.TensorLocation property)
storageTileSet (popart.TensorLocation property)
strictOpVersions (popart.SessionOptions property)
SubgraphCopyingStrategy (class in popart)
subgraphCopyingStrategy (popart.SessionOptions property)
subsample() (popart.AiGraphcoreOpset1 method)
,
[1]
swapLimitScheduler (popart.SessionOptions property)
swish() (popart.AiGraphcoreOpset1 method)
,
[1]
SyncPattern (class in popart)
SyntheticDataMode (class in popart)
syntheticDataMode (popart.SessionOptions property)
T
TensorInfo (class in popart)
(class in popart.tensorinfo)
TensorLocation (class in popart)
TensorLocationSettings (class in popart)
tensorremap() (popart.AiGraphcoreOpset1 method)
,
[1]
TensorRemapType (class in popart)
TensorStorage (class in popart)
TileSet (class in popart)
,
[1]
tileSet() (popart.AnchorReturnType method)
(popart.InputSettings method)
timeLimitScheduler (popart.SessionOptions property)
train() (popart.writer.NetWriter method)
TrainingSession (class in popart)
transformContext (popart.BatchSerializationSettings property)
tryAcquireAvailableDevice() (popart.DeviceManager method)
tryAcquireDeviceById() (popart.DeviceManager method)
tryAttachUntilTimeout() (popart.DeviceInfo method)
type (popart.CommGroup property)
V
val() (popart.OptimizerValue method)
VariableRetrievalMode (class in popart)
VariableSettings (class in popart)
velocityScalings() (popart.SGD method)
verify() (popart.VariableSettings method)
VirtualGraphMode (class in popart)
W
WeightDecayMode (class in popart)
weightDecays() (popart.Adam method)
(popart.Adaptive method)
(popart.SGD method)
weightIOSchedule (popart.ExecutionPhaseSettings property)
weightTensorLocationSettings (popart.SessionOptions property)