oneAPI Specification

• 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
    • Namespaces
  • Conventions
    • Variable (Tensor) Names
    • RNN-Specific Notation
  • Execution Model
    • Engine
    • Stream
  • Data model
    • Data types
      • Bfloat16
        • Workflow
        • Support
      • Int8
        • Workflow
        • Support
    • Memory
      • Memory Formats
        • Plain Memory Formats
        • Format Tags
        • Optimized Format ‘any’
        • Memory Format Propagation
        • API
      • Memory Descriptors and Objects
        • Descriptors
        • Objects
        • API
  • Primitives
    • Common Definitions
      • Base Class for Primitives
      • Base Class for Primitives Descriptors
      • Common Enumerations
      • Normalization Primitives Flags
      • Execution argument indices
    • Attributes
      • Post-ops
        • Supported Post-ops
          • Eltwise Post-op
          • Sum Post-op
          • Examples of Chained Post-ops
        • API
      • Scratchpad Mode
        • Examples
          • Library Manages Scratchpad
          • User Manages Scratchpad
      • Quantization
        • Quantization Model
          • Example: Convolution Quantization Workflow
          • Per-Channel Scaling
        • Output Scaling Attribute
          • Example 1: weights quantization with per-output-channel-and-group scaling
          • Example 2: convolution with groups, with per-output-channel quantization
          • Interplay of Output Scales with Post-ops
      • Attribute Related Error Handling
      • API
    • Batch Normalization
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
        • Source, Destination, and Their Gradients
        • Statistics Tensors
      • 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
        • Regular Convolution
        • Convolution with Groups
        • Convolution with Dilation
        • Deconvolution (Transposed Convolution)
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
      • Post-ops and Attributes
        • Example 1
        • Example 2
      • 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
        • Difference Between Forward Training and Forward Inference
      • Backward
        • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
      • Post-ops and Attributes
      • API
    • Layer normalization
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
        • Mean and Variance
        • Scale and Shift
        • Source, Destination, and Their Gradients
      • API
    • LogSoftmax
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Post-ops and Attributes
      • Data Type Support
      • Data Representation
        • Source, Destination, and Their Gradients
      • API
    • Local Response Normalization
      • Forward
      • Backward
        • Execution Arguments
          • Operation Details
          • Data Type Support
          • Data Representation
        • Source, Destination, and Their Gradients
          • Post-ops and Attributes
          • API
    • Matrix Multiplication
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
      • Attributes and Post-ops
      • API
    • Pooling
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Type Support
      • Data Representation
        • Source, Destination, and Their Gradients
      • Post-ops and Attributes
      • API
    • Reorder
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Representation
      • Post-ops and Attributes
      • API
    • Resampling
      • Forward
        • Nearest Neighbor Resampling
        • Bilinear Resampling
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Post-ops and Attributes
      • API
    • RNN
      • Cell Functions
        • Vanilla RNN
        • LSTM
          • LSTM (or Vanilla LSTM)
          • LSTM with Peephole
          • LSTM with Projection
        • GRU
        • Linear-Before-Reset GRU
      • Execution Arguments
      • Operation Details
      • Data Types Support
        • Data Representation
        • Post-ops and Attributes
      • API
    • Shuffle
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Data Types Support
      • Data Layouts
      • Post-ops and Attributes
      • API
    • Softmax
      • Forward
        • Difference Between Forward Training and Forward Inference
      • Backward
      • Execution Arguments
      • Operation Details
      • Post-ops and Attributes
      • Data Types Support
      • Data Representation
        • Source, Destination, and Their Gradients
      • API
    • Sum
      • Execution Arguments
      • Operation Details
      • Post-ops and Attributes
      • Data Types Support
      • Data Representation
        • Sources, Destination
      • 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
        • Custom Datatypes
      • Reductions
      • Collective Operations
        • Allgatherv
        • Allreduce
        • Alltoall
        • Alltoallv
        • Barrier
        • Broadcast
        • Reduce
        • ReduceScatter
      • Operation Attributes
      • Operation Progress Tracking
        • Request
    • 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
    • End-to-end example
    • Descriptors
      • Floating-point Types
      • Computational Methods
      • Computational Tasks
    • Operations
      • General operation definition
      • Operation shortcuts
      • Input
      • Result
      • Supported operation
    • Computational modes
      • Batch
      • Online
      • Distributed
  • Common Interface
    • Current Version of this oneDAL Specification
    • Header files
    • Namespaces
    • Error handling
      • Exception classification
    • Common type definitions
      • Programming interface
        • Scalar types
        • Enum classes
        • Data type
        • Range
  • Data management
    • Key concepts
      • Dataset
      • Data source
      • Table
      • Table metadata
      • Accessor
      • Example of interaction between table and accessor objects
    • Details
      • Array
        • Usage example
        • Data ownership requirements
        • Programming interface
      • Accessors
        • Requirements
        • Accessor Types
        • Details
          • Column accessor
          • Row accessor
      • Data Sources
        • Read
          • Read operation definition
          • Read operation shortcuts
          • Args
          • Result
        • Data Source Types
        • Details
          • CSV data source
      • Tables
        • Requirements on table types
        • Table types
        • Programming interface
          • Table
          • Table metadata
          • Data layout
          • Feature type
  • Algorithms
    • Clustering
      • K-Means
        • Mathematical formulation
          • Training
          • Inference
        • Usage example
          • Training
          • Inference
        • Programming Interface
          • Descriptor
          • Model
          • Training train(...)
          • Inference infer(...)
      • K-Means initialization
        • Mathematical formulation
          • Computing
          • Computing method: dense
        • Usage example
          • Computing
        • Programming Interface
          • Descriptor
          • Computing compute(...)
    • Nearest Neighbors (kNN)
      • k-Nearest Neighbors Classification (k-NN)
        • Mathematical formulation
          • Training
          • Inference
        • Usage example
          • Training
          • Inference
        • Programming Interface
          • Descriptor
          • Model
          • Training train(...)
          • Inference infer(...)
    • Decomposition
      • Principal Components Analysis (PCA)
        • Mathematical formulation
          • Training
          • Inference
        • Usage example
          • Training
          • Inference
        • Programming Interface
          • Descriptor
          • Model
          • Training train(...)
          • Inference infer(...)
  • Appendix
    • k-d Tree
      • Related terms
  • Bibliography
• oneTBB
  • General Information
    • Introduction
    • Notational Conventions
    • Identifiers
      • Case
      • Reserved Identifier Prefixes
    • Named Requirements
      • Algorithms
        • Range
        • Splittable
        • ParallelForBody
        • ParallelForFunc
        • ParallelForIndex
        • ParallelReduceBody
        • ParallelReduceFunc
        • ParallelReduceReduction
        • ParallelForEachBody
          • ItemType
        • ContainerBasedSequence
        • ParallelScanBody
        • ParallelScanCombine
        • ParallelScanFunc
        • BlockedRangeValue
        • FilterBody
      • Mutexes
        • Mutex
        • ReaderWriterMutex
      • Containers
        • HashCompare
        • ContainerRange
      • Task scheduler
        • SuspendFunc
      • Flow Graph
        • AsyncNodeBody
        • ContinueNodeBody
        • GatewayType
        • FunctionNodeBody
        • JoinNodeFunctionObject
        • InputNodeBody
        • MultifunctionNodeBody
        • Sequencer
    • Thread Safety
  • oneTBB Interfaces
    • Configuration
      • Namespaces
        • tbb Namespace
        • tbb::flow Namespace
        • oneapi::tbb Namespace
      • Version Information
        • TBB_runtime_interface_version Function
        • TBB_runtime_version Function
        • TBB_VERSION Environment Variable
      • Enabling Debugging Features
        • TBB_USE_ASSERT Macro
        • TBB_USE_PROFILING_TOOLS Macro
      • Feature Macros
        • TBB_USE_EXCEPTIONS macro
        • TBB_USE_GLIBCXX_VERSION macro
    • Algorithms
      • Parallel Functions
        • parallel_for
        • parallel_reduce
          • Example (Imperative Form)
          • Example with Lambda Expressions
        • parallel_deterministic_reduce
        • parallel_scan
          • pre_scan and final_scan Classes
          • Example (Imperative Form)
          • Example with Lambda Expressions
        • parallel_for_each
          • feeder Class
          • Example
        • parallel_invoke
          • Example
        • parallel_pipeline
          • Example
          • filter Class Template
          • flow_control Class
        • parallel_sort
      • Blocked Ranges
        • blocked_range
          • Member functions
        • blocked_range2d
          • Member types
          • Member functions
        • blocked_range3d
          • Member types
          • Member functions
      • Partitioners
        • auto_partitioner
        • affinity_partitioner
        • static_partitioner
        • simple_partitioner
      • Split Tags
        • proportional split
          • Member functions
        • split
    • Flow Graph
      • Graph Class
        • graph
          • reset_flags enumeration
          • Member functions
      • Nodes
        • Abstract Interfaces
          • graph_node
          • sender
          • receiver
        • Properties
          • Forwarding and Buffering
        • Functional Nodes
          • continue_node
          • function_node
          • input_node
          • multifunction_node
          • async_node
          • Function Nodes Policies
          • Nodes Priorities
          • Predefined Concurrency Limits
          • copy_body
        • Buffering Nodes
          • overwrite_node
          • write_once_node
          • buffer_node
          • queue_node
          • priority_queue_node
          • sequencer_node
        • Service Nodes
          • limiter_node
          • broadcast_node
          • join_node
          • split_node
          • indexer_node
          • composite_node
      • Ports and Edges
        • input_port
        • output_port
        • make_edge
        • remove_edge
      • Special Messages Types
        • continue_msg
        • tagged_msg
          • Member functions
          • Non-member functions
      • Examples
        • Dependency Flow Graph Example
        • Message Flow Graph Example
    • Task Scheduler
      • Scheduling controls
        • task_group_context
          • Member types and constants
          • Member functions
        • global_control
          • Member types and constants
          • Member functions
        • Resumable tasks
          • Example
      • Task Group
        • task_group
          • Member functions
          • Non-member functions
        • task_group_status
          • Member constants
      • Task Arena
        • task_arena
          • Member types and constants
          • Member functions
        • this_task_arena
        • task_scheduler_observer
          • Member functions
          • Example
    • Containers
      • Sequences
        • concurrent_vector
          • Class Template Synopsis
          • Requirements
          • Description
          • Exception Safety
          • Member functions
          • Non-member functions
          • Other
      • Queues
        • concurrent_queue
          • Class Template Synopsis
          • Member functions
          • Other
        • concurrent_bounded_queue
          • Class Template Synopsis
          • Member functions
          • Other
        • concurrent_priority_queue
          • Class Template Synopsis
          • Member functions
          • Non-member functions
          • Other
      • Unordered associative containers
        • concurrent_hash_map
          • Class Template Synopsis
          • Member classes
          • Member functions
          • Non-member functions
          • Other
        • concurrent_unordered_map
          • Class Template Synopsis
          • Description
          • Member functions
          • Non-member functions
          • Other
        • concurrent_unordered_multimap
          • Class Template Synopsis
          • Description
          • Member functions
          • Non-member functions
          • Other
        • concurrent_unordered_set
          • Class Template Synopsis
          • Description
          • Member functions
          • Non-member functions
          • Other
        • concurrent_unordered_multiset
          • Class Template Synopsis
          • Description
          • Member functions
          • Non-member functions
          • Other
      • Ordered associative containers
        • concurrent_map
          • Class Template Synopsis
          • Member classes
          • Member functions
          • Non-member functions
          • Other
        • concurrent_multimap
          • Class Template Synopsis
          • Member classes
          • Member functions
          • Non-member functions
          • Other
        • concurrent_set
          • Class Template Synopsis
          • Member functions
          • Non-member functions
          • Other
        • concurrent_multiset
          • Class Template Synopsis
          • Member functions
          • Non-member functions
          • Other
      • Auxiliary classes
        • tbb_hash_compare
          • Class Template Synopsis
          • Member functions
        • Node handles
          • Class synopsis
          • Member functions
    • Thread Local Storage
      • combinable
        • Member functions
      • enumerable_thread_specific
        • Member functions
          • Construction, destruction, copying
          • Concurrently safe modifiers
          • Concurrently unsafe modifiers
          • Size and capacity
          • Iteration
          • Combining
        • Non-member types and constants
      • flattened2d
        • Member functions
        • Non-member functions
  • oneTBB Auxiliary Interfaces
    • Memory Allocation
      • Allocators
        • tbb_allocator
          • Member Functions
          • Non-member Functions
        • scalable_allocator
          • Member Functions
          • Non-member Functions
        • cache_aligned_allocator
          • Member Functions
          • Non-member Functions
      • Memory Resources
        • cache_aligned_resource
          • Member Functions
        • scalable_memory_resource
      • Library Functions
        • C Interface to Scalable Allocator
    • Mutual Exclusion
      • Mutex Classes
        • spin_mutex
          • Member classes
          • Member functions
        • spin_rw_mutex
          • Member classes
          • Member functions
        • speculative_spin_mutex
          • Member classes
          • Member functions
        • speculative_spin_rw_mutex
          • Member classes
          • Member functions
        • queuing_mutex
          • Member classes
          • Member functions
        • queuing_rw_mutex
          • Member classes
          • Member functions
        • null_mutex
          • Member classes
          • Member functions
        • null_rw_mutex
          • Member classes
          • Member functions
    • Timing
      • Syntax
      • Classes
        • tick_count class
        • tick_count::interval_t class
        • Non-member functions
• oneVPL
  • Architecture
  • Programming Guide
  • Mandatory APIs and Functions
    • Disclaimer
    • Exported Functions
    • Mandatory APIs
  • oneVPL API Reference
    • Function Reference
    • Structure Reference
    • Enumerator Reference
      • Angle
      • BitstreamDataFlag
      • BPSEIControl
      • BRCStatus
      • BRefControl
      • ChromaFormateIdc
      • ChromaSiting
      • CodecFormatFourCC
      • CodecLevel
        • H.264 Level 1-1.3
        • H.264 Level 2-2.2
        • H.264 Level 3-3.2
        • H.264 Level 4-4.2
        • H.264 Level 5-5.2
        • MPEG2 Levels
        • VC-1 Level Low (Simple and Main Profiles)
        • VC-1 Advanced Profile Levels
        • HEVC Levels
      • CodecProfile
        • H.264 Profiles
        • H.264 Constraints
      • CodingOptionValue
      • ColorFourCC
      • ContentInfo
      • Corruption
      • DeinterlacingMode
      • ErrorTypes
      • ExtendedBufferID
      • ExtMemBufferType
      • ExtMemFrameType
      • Frame Data Flags
      • FrameType
      • FrcAlgm
      • GeneralConstraintFlags
      • GopOptFlag
      • GPUCopy
      • HEVC Profiles
      • HEVC Tiers
      • HEVCRegionEncoding
      • HEVCRegionType
      • ImageStabMode
      • InsertHDRPayload
      • InterpolationMode
      • IntraPredBlockSize/InterPredBlockSize
      • IntraRefreshTypes
      • IOPattern
      • JPEG Profiles
      • JPEGColorFormat
      • JPEGScanType
      • LongTermIdx
      • LookAheadDownSampling
      • MBQPMode
      • mfxComponentType
      • mfxHandleType
      • mfxIMPL
      • mfxImplCapsDeliveryFormat
      • mfxMediaAdapterType
      • mfxMemoryFlags
      • MfxNalUnitType
      • mfxPriority
      • mfxResourceType
      • mfxSkipMode
      • mfxStatus
      • MirroringType
      • MPEG-2 Profiles
      • Multi-view Video Coding Extension Profiles
      • MVPrecision
      • NominalRange
      • PartialBitstreamOutput
      • PayloadCtrlFlags
      • PicStruct
      • PicType
      • PlatformCodeName
      • PRefType
      • Protected
      • RateControlMethod
      • ROImode
      • Rotation
      • SampleAdaptiveOffset
      • ScalingMode
      • ScenarioInfo
      • SegmentFeature
      • SegmentIdBlockSize
      • SkipFrame
      • TargetUsage
      • TelecinePattern
      • TimeStampCalc
      • TransferMatrix
      • TrellisControl
      • VC-1 Profiles
      • VP8 Profiles
      • VP9 Profiles
      • VP9ReferenceFrame
      • VPPFieldProcessingMode
      • WeightedPred
    • Define Reference
      • API
    • Type Reference
      • Basic Types
      • Typedefs
    • Dispatcher API
      • Dispatcher API Function Reference
        • API
          • MFXCreateConfig
          • MFXCreateSession
          • MFXDispReleaseImplDescription
          • MFXEnumImplementations
          • MFXLoad
          • MFXSetConfigFilterProperty
          • MFXUnload
      • Dispatcher API Structure Reference
        • API
          • mfxDecoderDescription
          • mfxDeviceDescription
          • mfxEncoderDescription
          • mfxImplDescription
          • mfxVariant
          • mfxVPPDescription
      • Dispatcher API Enumeration Reference
        • API
          • mfxAccelerationMode
          • mfxImplType
      • Dispatcher API Define Reference
        • API
          • MFX_IMPL_NAME_LEN
          • MFX_STRFIELD_LEN
  • oneVPL API Versioning
  • 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
  • Glossary
    • Acronyms and Terms
    • Video Formats
    • Color Formats
• oneMKL
  • oneMKL Architecture
    • Execution Model
      • Use of Queues
        • Non-Member Functions
        • Member Functions
      • Device Usage
      • Asynchronous Execution
        • Synchronization When Using Buffers
        • Synchronization When Using USM APIs
      • 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
      • Exception classification
        • Common exceptions
        • LAPACK specific exceptions
    • Other Features
      • 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 Appendix
    • Future considerations
    • Acknowledgement
• Contributors
• HTML and PDF Versions
  • Release Notes
    • 1.0
    • 0.9
    • 0.85
    • 0.8
    • 0.7
    • 0.5
• Legal Notices and Disclaimers