oneAPI Specification Logo
0.85
  • 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
  • oneDPL
    • Namespaces
    • Supported C++ Standard Library APIs and Algorithms
      • Extensions to Parallel STL
        • DPC++ Execution Policy
        • Wrappers for SYCL Buffers
      • Specific API of oneDPL
  • 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
        • oneCCL Environment
        • oneCCL Stream
        • oneCCL Communicator
      • oneCCL Collective Communication
        • Collective Operations
        • Data Types
        • Collective Call Attributes
        • Track Communication Progress
      • Error Handling
    • Programming Model
      • Generic Workflow
      • GPU support
        • Example
      • CPU 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
    • oneVPL for Intel® Media Software Development Kit Users
      • oneVPL Usability Enhancements
      • Obsolete MSDK Features omitted from oneVPL
      • MSDK API’s not present in oneVPL
      • oneVPL API’s not present in MSDK
    • oneVPL API versioning
    • Acronyms and Abbreviations
    • Architecture
      • Video Decoding
      • Video Encoding
      • Video Processing
    • Programming Guide
      • Status Codes
      • SDK Session
        • Media SDK dispatcher (legacy)
        • oneVPL diapatcher
        • Multiple Sessions
      • Frame and Fields
        • Frame Surface Locking
      • Decoding Procedures
        • Bitstream Repositioning
        • Broken Streams Handling
        • VP8 Specific Details
        • JPEG
        • Multi-view video decoding
      • Encoding Procedures
        • Encoding procedure
        • Configuration Change
        • External Bit Rate Control
        • JPEG
        • Multi-view video encoding
      • Video Processing Procedures
        • Configuration
        • Region of Interest
        • Multi-view video processing
      • Transcoding Procedures
        • Asynchronous Pipeline
        • Surface Pool Allocation
        • Pipeline Error Reporting
      • Working with hardware acceleration
        • Working with multiple Intel media devices
        • Working with video memory
        • Working with Microsoft* DirectX* Applications
        • Working with VA API Applications
        • Memory Allocation and External Allocators
        • External memory managment
        • Internal memory managment
        • mfxFrameSurfaceInterface
        • Hardware Device Error Handling
    • Summary Tables
      • Mandatory API reference
        • Functions per API Version
    • Appendicies
      • Configuration Parameter Constraints
      • Multiple-Segment Encoding
      • Streaming and Video Conferencing Features
        • Dynamic Bitrate Change
        • Dynamic Resolution Change
        • Dynamic reference frame scaling
        • Forced Key Frame 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
    • oneVPL API Reference
      • Basic Types
      • Typedefs
      • oneVPL Dispatcher API
        • Defines
        • Structures
        • mfxVariant
        • mfxDecoderDescription
        • mfxEncoderDescription
        • mfxVPPDescription
        • mfxImplDescription
        • Functions
      • Enums
        • mfxStatus
        • mfxIMPL
        • mfxImplCapsDeliveryFormat
        • mfxPriority
        • GPUCopy
        • PlatformCodeName
        • mfxMediaAdapterType
        • mfxMemoryFlags
        • mfxResourceType
        • ColorFourCC
        • ChromaFormatIdc
        • PicStruct
        • Frame Data Flags
        • Corruption
        • TimeStampCalc
        • IOPattern
        • CodecFormatFourCC
        • CodecProfile
        • CodecLevel
        • HEVC Tiers
        • GopOptFlag
        • TargetUsage
        • RateControlMethod
        • TrellisControl
        • BRefControl
        • LookAheadDownSampling
        • BPSEIControl
        • SkipFrame
        • IntraRefreshTypes
        • WeightedPred
        • PRefType
        • ScenarioInfo
        • ContentInfo
        • IntraPredBlockSize/InterPredBlockSize
        • MVPrecision
        • CodingOptionValue
        • BitstreamDataFlag
        • ExtendedBufferID
        • PayloadCtrlFlags
        • 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
        • MCTFTemporalMode
        • mfxComponentType
        • PartialBitstreamOutput
        • BRCStatus
        • Rotation
        • JPEGColorFormat
        • JPEGScanType
        • Protected
      • Structs
        • mfxRange32U
        • mfxI16Pair
        • mfxHDLPair
        • mfxVersion
        • mfxStructVersion
        • mfxPlatform
        • mfxInitParam
        • mfxInfoMFX
        • mfxFrameInfo
        • mfxVideoParam
        • mfxFrameData
        • mfxFrameSurfaceInterface
        • mfxFrameSurface1
        • mfxBitstream
        • mfxEncodeStat
        • mfxDecodeStat
        • mfxPayload
        • mfxEncodeCtrl
        • mfxFrameAllocRequest
        • mfxFrameAllocResponse
        • mfxFrameAllocator
        • mfxComponentInfo
        • mfxAdapterInfo
        • mfxAdaptersInfo
        • mfxQPandMode
        • VPP Structures
        • Extension buffers structures
        • VPP Extention buffers
        • mfxExtVPPDenoise
        • Bit Rate Control Extension Buffers
        • VP8 Extenrion Buffers
        • JPEG Extension Buffers
        • MVC Extension Buffers
        • PCP Extension Buffers
      • Functions
        • Implementation Capabilities
        • Session Management
        • VideoCORE
        • Memory
        • VideoENCODE
        • VideoDECODE
        • VideoVPP
  • 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
      • Vector Math
  • Contributors
  • HTML and PDF Versions
    • Release Notes
      • 0.85
      • 0.8
      • 0.7
      • 0.5
  • Legal Notices and Disclaimers
oneAPI Specification
  • oneAPI Specification »
  • Edit on GitHub

Legal Notices and Disclaimers¶

The content of this oneAPI Specification is licensed under the Creative Commons Attribution 4.0 International License. Unless stated otherwise, the sample code examples in this document are released to you under the MIT license.

This specification is a continuation of Intel’s decades-long history of working with standards groups and industry/academia initiatives such as The Khronos Group*, to create and define specifications in an open and fair process to achieve interoperability and interchangeability. oneAPI is intended to be an open specification and we encourage you to help us make it better. Your feedback is optional, but to enable Intel to incorporate any feedback you may provide to this specification, and to further upstream your feedback to other standards bodies, including The Khronos Group SYCL* specification, please submit your feedback under the terms and conditions below. Any contribution of your feedback to the oneAPI Specification does not prohibit you from also contributing your feedback directly to other standard bodies, including The Khronos Group under their respective submission policies.

By opening an issue, providing feedback, or otherwise contributing to the specification, you agree that Intel will be free to use, disclose, reproduce, modify, license, or otherwise distribute your feedback at its sole discretion without any obligations or restrictions of any kind, including without limitation, intellectual property rights or licensing obligations.

This document contains information on products, services and/or processes in development. All information provided here is subject to change without notice.

Intel and the Intel logo are trademarks of Intel Corporation in the U.S. and/or other countries.

*Other names and brands may be claimed as the property of others.

Next Previous

© Copyright 2020, Intel Corporation

Built with Sphinx using a theme provided by Read the Docs.