oneapi-src/oneAPI-spec oneapi-src/oneAPI-spec

  • Stars
    star
    165
  • Rank 228,906 (Top 5 %)
  • Language
    Python
  • License
    Other
  • Created almost 5 years ago
  • Updated 8 months ago
Twitter logo Share LinkedIn logo Share Facebook logo Share
oneapi-src/oneAPI-spec
github

oneapi-src

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

oneAPI Specification source files

oneAPI Specifications

REUSE status

This repository contains the sources for the oneAPI Specification. For the latest build from main branch, see HTML and PDF.

For more information about oneAPI, see oneapi.io. For information about future releases of the oneAPI specification, see the roadmap. To be notified about new releases, become a release-only watcher of this repo.

The document is written using reStructuredText and built with Sphinx using a theme provided by Read the Docs.

License

The oneAPI specification is licensed under the Creative Commons Attribution 4.0 International License.

See LICENSE for more information.

Contribute

See CONTRIBUTING for more information.

Build the Specification

To build the specification document locally, clone this repository to your local system and follow the setup and build instructions. The setup and build steps make use of scripts/oneapi.py, a helper script for maintenance tasks. You can also look at the source if you want to see how to do the same task manually.

Setup

Install Python 3, Doxygen (>= 1.8.17), LaTeX, etc. To install on Ubuntu:

sudo scripts/install.sh

Create and activate a Python virtual environment with all required tools:

python scripts/oneapi.py spec-venv
source spec-venv/bin/activate

To install directly with pip:

pip install -r requirements.txt

To install on Windows:

python scripts\oneapi.py spec-venv
spec-venv\Scripts\activate

Build the Docs

To build the HTML document, use the following command:

python scripts/oneapi.py html

The document is organized as a book with chapters. Each element of oneAPI is its own chapter and can be built separately. For example, to build the oneVPL chapter, use the following command:

python scripts/oneapi.py html source/elements/oneVPL

To view the HTML docs, visit build/html/index.html in your browser using a file:// URL.

Build the pdf version wit the following command:

python scripts/oneapi.py latexpdf

The generated PDF will be located at build/latexpdf/oneAPI-spec.pdf.

Spell check:

python oneapi.doc. --verbose spelling

CI

We use GitHub actions. See .github/workflows/ci.yml.

PR's trigger the CI to build the document and save it as an artifact. If you are working in a fork on GitHub, commits to the main branch will build and publish the document in the GitHub pages associated with the repository.

Adding licenses to files

Use the reuse tool

Code examples:

reuse addheader --copyright "Intel Corporation" --year 2020 --license MIT source/examples/host-task.cpp

Doc sources:

reuse addheader --copyright "Intel Corporation" --year 2020 --license CC-BY-4.0 source/index.rst

Making a Release

  1. Update:
    • oneapi-doc.json
    • releases/index.rst
  2. Tag it.
  3. Publish with oneAPI doc repo

More Repositories

1

oneTBB

oneAPI Threading Building Blocks (oneTBB)
C++
5,603
star
2

oneDNN

oneAPI Deep Neural Network Library (oneDNN)
C++
3,576
star
3

oneAPI-samples

Samples for Intel® oneAPI Toolkits
C++
922
star
4

oneDPL

oneAPI DPC++ Library (oneDPL) https://software.intel.com/content/www/us/en/develop/tools/oneapi/components/dpc-library.html
C++
720
star
5

oneDAL

oneAPI Data Analytics Library (oneDAL)
C++
607
star
6

oneMKL

oneAPI Math Kernel Library (oneMKL) Interfaces
C++
606
star
7

SYCLomatic

LLVM
221
star
8

level-zero

oneAPI Level Zero Specification Headers and Loader
C++
210
star
9

oneCCL

oneAPI Collective Communications Library (oneCCL)
C++
188
star
10

oneVPL

oneAPI Video Processing Library (oneVPL) dispatcher, tools, and examples
C++
173
star
11

oneapi-ci

Sample configuration files for using oneAPI in CI systems
Shell
92
star
12

oneVPL-intel-gpu

C++
86
star
13

oneAPI-tab

oneAPI Technical Advisory Board (TAB) Meeting Notes
71
star
14

distributed-ranges

Distributed ranges is a generalization of C++ ranges for distributed data structures.
C++
46
star
15

level-zero-tests

oneAPI Level Zero Conformance & Performance test content
C++
45
star
16

Velocity-Bench

C++
42
star
17

unified-runtime

C++
31
star
18

unified-memory-framework

A library for constructing allocators and memory pools. It also contains broadly useful abstractions and utilities for memory management. UMF allows users to manage multiple memory pools characterized by different attributes, allowing certain allocation types to be isolated from others and allocated using different hardware resources as required.
C
31
star
19

oneVPL-cpu

oneAPI Video Processing Library (oneVPL) CPU implementation. This GitHub repository is no longer active. See ReadMe for more information.
C++
25
star
20

level-zero-spec

Python
17
star
21

ishmem

Intel® SHMEM - Device initiated shared memory based communication library
C++
15
star
22

drone-navigation-inspection

AI Starter Kit for AI applications in Drone technology using Intel® Optimized Tensorflow*
Python
13
star
23

predictive-asset-health-analytics

AI Starter Kit for Predictive Asset Maintenance using Intel® optimized version of XGBoost
HTML
13
star
24

SYCLomatic-test

LLVM
13
star
25

text-data-generation

AI Starter Kit for AI Unstructured Synthetic Data Generation using Intel® Extension for Pytorch
Python
10
star
26

traffic-camera-object-detection

AI Starter Kit for traffic camera object detection using Intel® Extension for Pytorch
Python
10
star
27

invoice-to-cash-automation

Ai starter kit for trade promotion and claim documents categorization using pytorch* and Tensorflow*
Python
7
star
28

demand-forecasting

AI Starter Kit for demand forecasting using Intel® Optimized Tensorflow*
Python
7
star
29

disease-prediction

AI Starter Kit for the implementation of AI-based NLP Disease Prediction system using Intel® Extension for PyTorch* and Intel® Neural Compressor
Python
7
star
30

computational-fluid-dynamics

AI Starter Kit for fluid Flow Profiling using Intel® Optimized Tensorflow*
Python
6
star
31

historical-assets-document-process

AI Starter Kit for Historical Assets document processing using Intel® Extension for Pytorch
Python
6
star
32

network-intrusion-detection

AI Starter Kit for Network Intrusion Detection using Intel® Extension for Scikit-learn*
Python
6
star
33

ai-transcribe

AI Starter Kit for the implementation of an AI transcribe system using Intel® Extension for PyTorch*
Python
6
star
34

level-zero-intel-gpu

5
star
35

structural-damage-assessment

AI Starter Kit for applications in Satellite Image processing using Intel® Extension for Pytorch
Python
5
star
36

digital-twin

AI Starter Kit to build a MOSFET Digital Twin for Design Exploration using Intel® optimized version of XGBoost
Python
4
star
37

medical-imaging-diagnostics

AI Starter Kit for image-based abnormalities for different diseases classification using Intel® Optimized Tensorflow*
Python
4
star
38

visual-quality-inspection

AI Starter Kit for Quality Visual Inspection using Intel® Extension for Pytorch
Python
4
star
39

customer-chatbot

AI Starter Kit for Customer Chatbot using Intel® Extension for Pytorch
Python
3
star
40

distributed-ranges-tutorial

C++
3
star
41

purchase-prediction

AI Starter Kit for Purchase Prediction model using Intel® Extension for Scikit-learn*
Python
3
star
42

customer-segmentation

AI Starter Kit for Customer Segmentation for Online Retail using Intel® Extension for Scikit-learn*
Python
3
star
43

powerline-fault-detection

AI Starter Kit for detect faulty signals in power line voltage using Intel® Extension for Scikit-learn*
Python
3
star
44

image-data-generation

AI Starter Kit for Synthetic Image Generation using Intel® Optimized Tensorflow*
Python
2
star
45

intelligent-indexing

AI Starter Kit for Intelligent Indexing of Incoming Correspondence using Intel® Extension for Scikit-learn*
Python
2
star
46

unified-runtime-spec

2
star
47

visual-process-discovery

AI Starter Kit for Visual Process Discovery using Intel® Extension for Pytorch
Python
2
star
48

vertical-search-engine

AI Starter Kit for Semantic Vertical Search Engines using Intel® Extension for Pytorch
Python
2
star
49

document-automation

AI Starter Kit for Named Entity Recognition using Intel® Optimized Tensorflow (version 2.9.0 with oneDNN)
Python
2
star
50

ai-structured-data-generation

AI Starter Kit to generate structured synthetic data using Intel® Distribution of Modin
Python
1
star
51

voice-data-generation

AI Starter Kit for Synthetic Voice and Audio Generation using Intel® Extension for Pytorch
Python
1
star
52

order-to-delivery-time-forecasting

AI Starter Kit of a delivery time forecasting solution using Intel® optimized version of XGBoost
1
star
53

product-recommendations

AI Starter Kit for product recommendation system using Intel® Extension for Scikit-learn*
Jupyter Notebook
1
star
54

customer-churn-prediction

AI Starter Kit for customer churn prediction using Intel® Extension for Scikit-learn*
Python
1
star
55

credit-card-fraud-detection

AI Starter Kit for Credit Card Fraud Detection model using Intel® Extension for Scikit-learn*
Python
1
star
56

loan-default-risk-prediction

AI Starter Kit to predict probability of a loan default from client using Intel® optimized version of XGBoost
Python
1
star
57

ai-data-protection

AI Starter Kit for Personal Identifiable Information Anonymization using Intel® Extension for Pytorch
Python
1
star
58

engineering-design-optimization

AI Starter Kit for Engineering Design Optimization using Intel® Extension for Pytorch
Python
1
star
59

data-streaming-anomaly-detection

AI Starter Kit for Data Streaming Anomaly Detection using Intel® Optimized Tensorflow*
Python
1
star