oneAPI Specification
0.9
Introduction
Target Audience
Goals of the Specification
Definitions
Contribution Guidelines
Sign your work
Software Architecture
oneAPI Platform
API Programming Example
Direct Programming Example
Library Interoperability
Queueing
API Arguments
Asynchronous APIs
Exceptions
oneAPI Elements
DPC++
Overview
Detailed API and Language Descriptions
Open Source Implementation
Testing
Acknowledgment
oneDPL
Namespaces
Supported C++ Standard Library APIs and Algorithms
Extensions to Parallel STL
DPC++ Execution Policy
device_policy class
make_device_policy function
Buffer wrappers
Specific API of oneDPL
Function Objects
Iterators
Parallel Algorithms
oneDNN
Introduction
General API notes
Error Handling
Conventions
Variable (Tensor) Names
RNN-Specific Notation
Execution Model
Engine
Stream
Data model
Data types
Bfloat16
Int8
Memory
Memory Formats
Memory Descriptors and Objects
Primitives
Common Definitions
Base Class for Primitives
Base Class for Primitives Descriptors
Common Enumerations
Normalization Primitives Flags
Execution argument indices
Attributes
Post-ops
Scratchpad Mode
Quantization
Attribute Related Error Handling
API
Batch Normalization
Forward
Backward
Execution Arguments
Operation Details
Data Types Support
Data Representation
Post-ops and Attributes
API
Binary
Forward and Backward
Execution Arguments
Operation Details
Post-ops and Attributes
Data Types Support
Data Representation
API
Concat
Forward and Backward
Execution Arguments
Operation Details
Data Types Support
Data Representation
Post-ops and Attributes
API
Convolution and Deconvolution
Forward
Backward
Execution Arguments
Operation Details
Data Types Support
Data Representation
Post-ops and Attributes
Algorithms
API
Elementwise
Forward
Backward
Difference Between Forward Training and Forward Inference
Execution Arguments
Operation Details
Data Type Support
Data Representation
Post-ops and Attributes
API
Inner Product
Forward
Backward
Operation Details
Data Types Support
Data Representation
Post-ops and Attributes
API
Layer normalization
Forward
Backward
Execution Arguments
Operation Details
Data Types Support
Data Representation
API
LogSoftmax
Forward
Backward
Execution Arguments
Operation Details
Post-ops and Attributes
Data Type Support
Data Representation
API
Local Response Normalization
Forward
Backward
Matrix Multiplication
Execution Arguments
Operation Details
Data Types Support
Data Representation
Attributes and Post-ops
API
Pooling
Forward
Backward
Execution Arguments
Operation Details
Data Type Support
Data Representation
Post-ops and Attributes
API
Reorder
Execution Arguments
Operation Details
Data Types Support
Data Representation
Post-ops and Attributes
API
Resampling
Forward
Backward
Execution Arguments
Operation Details
Data Types Support
Post-ops and Attributes
API
RNN
Cell Functions
Execution Arguments
Operation Details
Data Types Support
API
Shuffle
Forward
Backward
Execution Arguments
Operation Details
Data Types Support
Data Layouts
Post-ops and Attributes
API
Softmax
Forward
Backward
Execution Arguments
Operation Details
Post-ops and Attributes
Data Types Support
Data Representation
API
Sum
Execution Arguments
Operation Details
Post-ops and Attributes
Data Types Support
Data Representation
API
Open Source Implementation
Implementation Notes
Testing
oneCCL
Introduction
Definitions
oneCCL Concepts
Environment
Key-Value Store
Communicator
Device Communicator
Request
Event
Stream
Operation Attributes
Communication Operations
Datatypes
Reductions
Collective Operations
Operation Attributes
Operation Progress Tracking
Error Handling
Programming Model
Generic Workflow
Host Communication Support
Example
Device Communication Support
Example
Level Zero
Detailed API Descriptions
oneDAL
Introduction
Glossary
Machine learning terms
oneDAL terms
Common oneAPI terms
Mathematical Notations
Programming model
Basic usage scenario
Memory objects
Algorithm Anatomy
Descriptors
Operations
Managing execution context
Computational modes
Batch
Online
Distributed
Common Interface
Header files
Namespaces
Managing object lifetimes
Error handling
Exception classification
Data management
Key concepts
Dataset
Data source
Table
Metadata
Table builder
Accessor
Use-case example for table, accessor and table builder
Details
Data Sources
Tables
Table Builders
Accessors
Algorithms
Clustering
K-Means
Nearest Neighbors (kNN)
k-Nearest Neighbors Classification (k-NN)
Decomposition
Principal Components Analysis (PCA)
Appendix
k-d Tree
Related terms
Bibliography
oneTBB
General Information
Introduction
Notational Conventions
Identifiers
Case
Reserved Identifier Prefixes
Named Requirements
Algorithms
Mutexes
Containers
Task scheduler
Flow Graph
Thread Safety
oneTBB Interfaces
Configuration
Namespaces
Version Information
Enabling Debugging Features
Feature Macros
Algorithms
Parallel Functions
Blocked Ranges
Partitioners
Split Tags
Flow Graph
Graph Class
Nodes
Ports and Edges
Special Messages Types
Examples
Task Scheduler
Scheduling controls
Task Group
Task Arena
Containers
Sequences
Queues
Unordered associative containers
Ordered associative containers
Auxiliary classes
Thread Local Storage
combinable
enumerable_thread_specific
flattened2d
oneTBB Auxiliary Interfaces
Memory Allocation
Allocators
Memory Resources
Library Functions
Mutual Exclusion
Mutex Classes
Timing
Syntax
Classes
oneVPL
Architecture
Programming Guide
Mandatory/Optional APIs and Features
Disclaimer
Functions must be exposed by any implementation
Mandatory API for each implementation
Appendices
oneVPL for Intel
®
Media Software Development Kit Users
oneVPL Ease of Use Enhancements
New APIs in oneVPL
Intel
®
Media Software Development Kit Feature Removals
Intel
®
Media Software Development Kit API Removals
Configuration Parameter Constraints
DECODE, ENCODE, and VPP Constraints
DECODE Constraints
ENCODE Constraints
VPP Constraints
Specifying Configuration Parameters
Multiple-segment Encoding
Streaming and Video Conferencing Features
Dynamic Bitrate Change
Dynamic Resolution Change
Dynamic Reference Frame Scaling
Forced Keyframe Generation
Reference List Selection
Low Latency Encoding and Decoding
Reference Picture Marking Repetition SEI Message
Long Term Reference Frame
Temporal Scalability
Switchable Graphics and Multiple Monitors
Switchable Graphics
Multiple Monitors
Working Directly with VA API for Linux*
CQP HRD Mode Encoding
Acronyms and Abbreviations
oneVPL API Versioning
oneVPL API Reference
Types
Basic Types
Typedefs
Dispatcher API
Defines
Enums
mfxImplType
mfxAccelerationMode
Structures
mfxVariant
mfxDecoderDescription
mfxEncoderDescription
mfxVPPDescription
mfxDeviceDescription
mfxImplDescription
Functions
Enums
mfxStatus
mfxIMPL
mfxImplCapsDeliveryFormat
mfxPriority
GPUCopy
PlatformCodeName
mfxMediaAdapterType
mfxMemoryFlags
mfxResourceType
ColorFourCC
ChromaFormatIdc
PicStruct
Frame Data Flags
Corruption
TimeStampCalc
IOPattern
CodecFormatFourCC
CodecProfile
CodecLevel
VC-1 Advanced Profile Levels
HEVC Tiers
GopOptFlag
TargetUsage
RateControlMethod
TrellisControl
BRefControl
LookAheadDownSampling
BPSEIControl
SkipFrame
IntraRefreshTypes
WeightedPred
PRefType
ScenarioInfo
ContentInfo
IntraPredBlockSize/InterPredBlockSize
MVPrecision
CodingOptionValue
BitstreamDataFlag
ExtendedBufferID
PayloadCtrlFlags
ExtMemBufferType
ExtMemFrameType
FrameType
MfxNalUnitType
mfxHandleType
mfxSkipMode
FrcAlgm
ImageStabMode
InsertHDRPayload
LongTermIdx
TransferMatrix
NominalRange
ROImode
DeinterlacingMode
TelecinePattern
VPPFieldProcessingMode
PicType
MBQPMode
GeneralConstraintFlags
SampleAdaptiveOffset
ErrorTypes
HEVCRegionType
HEVCRegionEncoding
Angle
ScalingMode
InterpolationMode
MirroringType
ChromaSiting
VP9ReferenceFrame
SegmentIdBlockSize
SegmentFeature
mfxComponentType
PartialBitstreamOutput
BRCStatus
Rotation
JPEGColorFormat
JPEGScanType
Protected
Structs
mfxRange32U
mfxI16Pair
mfxHDLPair
mfxVersion
mfxStructVersion
mfxPlatform
mfxInitParam
mfxInfoMFX
mfxFrameId
mfxFrameInfo
mfxVideoParam
mfxFrameData
mfxFrameSurfaceInterface
mfxFrameSurface1
mfxBitstream
mfxEncodeStat
mfxDecodeStat
mfxPayload
mfxEncodeCtrl
mfxFrameAllocRequest
mfxFrameAllocResponse
mfxFrameAllocator
mfxComponentInfo
mfxAdapterInfo
mfxAdaptersInfo
mfxQPandMode
VPP Structures
Extension buffers structures
VPP Extension Buffers
Bitrate Control Extension Buffers
VP8 Extension Buffers
JPEG Extension Buffers
MVC Extension Buffers
PCP Extension Buffers
Defines
Functions
Implementation Capabilities
Session Management
VideoCORE
Memory
VideoENCODE
VideoDECODE
VideoVPP
Adapters
oneMKL
oneMKL Architecture
Execution Model
Use of Queues
Device Usage
Asynchronous Execution
Host Thread Safety
Memory Model
The Buffer Memory Model
Unified Shared Memory Model
API Design
oneMKL namespaces
Standard C++ datatype usage
DPC++ datatype usage
oneMKL defined datatypes
Exceptions and Error Handling
Other Features
oneMKL Specification Versioning Strategy
Current Version of this oneMKL Specification
Pre/Post Condition Checking
oneMKL Domains
Dense Linear Algebra
Sparse Linear Algebra
Discrete Fourier Transforms
Random Number Generators
Summary Statistics
Vector Math
oneMKL Appendices
Future considerations
Acknowledgment
Contributors
HTML and PDF Versions
Release Notes
0.9
0.85
0.8
0.7
0.5
Legal Notices and Disclaimers
oneAPI Specification
oneAPI Specification
»
oneDAL
Edit on GitHub
Clustering
¶
K-Means
Lloyd’s method
Usage example
API
Methods
Descriptor
Model
Training
onedal
::
train
(
...
)
Input
Result
Operation semantics
Inference
onedal
::
infer
(
...
)
Input
Result
Operation semantics