Skip to content

Commit 7b50670

Browse files
AlexVeprevAlexVeprev
authored
Add missed commits from release_oneDPL (uxlfoundation#64)
Cherry-pick has been done for the following commits: 2f96057 0cd5982 beedaff 15f5bd1
1 parent a982aa0 commit 7b50670

21 files changed

+828
-285
lines changed

‎README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,12 @@ Install Intel(R) oneAPI Base Toolkit (Base Kit) to use oneDPL and please refer t
1515
Here is the latest [Release Notes](https://software.intel.com/content/www/us/en/develop/articles/intel-oneapi-dpcpp-library-release-notes-beta.html).
1616

1717
## License
18-
oneDPL is licensed under [Apache License Version 2.0 with LLVM exceptions](https://github.com/oneapi-src/oneDPL/blob/release_oneDPL/licensing/LICENSE.txt).
18+
oneDPL is licensed under [Apache License Version 2.0 with LLVM exceptions](https://github.com/oneapi-src/oneDPL/blob/release_oneDPL/licensing/LICENSE.txt). Refer to the "[LICENSE](licensing/LICENSE.txt)" file for the full license text and copyright notice.
19+
20+
## Security
21+
See Intel's [Security Center](https://www.intel.com/content/www/us/en/security-center/default.html)
22+
for information on how to report a potential security issue or vulnerability.
23+
See also: [Security Policy](SECURITY.md)
1924

2025
## Contributing
2126
See [CONTRIBUTING.md](https://github.com/oneapi-src/oneDPL/blob/release_oneDPL/CONTRIBUTING.md) for details.

‎SECURITY.md

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
# Security Policy
2+
3+
## Report a Vulnerability
4+
5+
Please report security issues or vulnerabilities to the [Intel Security Center].
6+
7+
For more information on how Intel works to resolve security issues, see
8+
[Vulnerability Handling Guidelines].
9+
10+
[Intel Security Center]:https://www.intel.com/security
11+
12+
[Vulnerability Handling Guidelines]:https://www.intel.com/content/www/us/en/security-center/vulnerability-handling-guidelines.html

‎documentation/library_guide/Makefile

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Minimal makefile for Sphinx documentation
2+
#
3+
4+
# You can set these variables from the command line.
5+
SPHINXOPTS =
6+
SPHINXBUILD = sphinx-build
7+
SOURCEDIR = ./
8+
BUILDDIR = _build
9+
10+
PAPEROPT_a4 = -D latex_paper_size=a4
11+
PAPEROPT_letter = -D latex_paper_size=letter
12+
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
13+
ERROROPTS = -W --keep-going
14+
15+
# Put it first so that "make" without argument is like "make help".
16+
help:
17+
@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
18+
19+
.PHONY: help Makefile create_rst_examples
20+
21+
clean:
22+
rm -rf $(BUILDDIR)/*
23+
24+
latex:
25+
"$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS)
26+
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
27+
@echo
28+
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
29+
@echo "Run \`make' in that directory to run these through (pdf)latex" \
30+
"(use \`make latexpdf' here to do that automatically)."
31+
32+
html:
33+
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
34+
@echo
35+
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

‎documentation/library_guide/_static/custom.css

+48
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
1+
.wy-side-nav-search, .wy-nav-top {
2+
background: #4308E5;
3+
}
4+
5+
/* make the page width fill the window */
6+
.wy-nav-content {
7+
max-width: 1100px;
8+
}
9+
10+
11+
.eqno {
12+
margin-left: 5px;
13+
float: right;
14+
}
15+
.math .headerlink {
16+
display: none;
17+
visibility: hidden;
18+
}
19+
.math:hover .headerlink {
20+
display: inline-block;
21+
visibility: visible;
22+
margin-right: -0.7em;
23+
}
24+
25+
/* A workaround for https://github.com/readthedocs/sphinx_rtd_theme/issues/647
26+
* Override display for function signatures so that there is spacing between
27+
* types and arguments */
28+
.rst-content dl:not(.docutils) dt {
29+
display: table-cell !important;
30+
}
31+
.rst-content dl:not(.docutils) dd {
32+
margin-top: 6px;
33+
}
34+
35+
/* override table width restrictions
36+
* https://rackerlabs.github.io/docs-rackspace/tools/rtd-tables.html */
37+
@media screen and (min-width: 767px) {
38+
39+
.wy-table-responsive table td {
40+
/* !important prevents the common CSS stylesheets from overriding
41+
this as on RTD they are loaded after this stylesheet */
42+
white-space: normal !important;
43+
}
44+
45+
.wy-table-responsive {
46+
overflow: visible !important;
47+
}
48+
}

‎documentation/library_guide/_static/custom.js

+53
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
//configure tms
2+
var wapLocalCode = 'us-en';
3+
//dynamically set per localized site, see mapping table for values
4+
var wapSection = "oneapi-docs";
5+
//load tms
6+
(function() {
7+
var host = (window.document.location.protocol == 'http:') ? "http://www.intel.com" : "https://www.intel.com";
8+
var url = host+"/content/dam/www/global/wap/tms-loader.js"; //wap file url
9+
var po = document.createElement('script');
10+
po.type = 'text/javascript';
11+
po.async = true;
12+
po.src = url;
13+
var s = document.getElementsByTagName('script')[0];
14+
s.parentNode.insertBefore(po, s);
15+
})();
16+
17+
window.MathJax = {
18+
TeX: {
19+
Macros: {
20+
src: '\\operatorname{src}',
21+
srclayer: '\\operatorname{src\\_layer}',
22+
srciter: '\\operatorname{src\\_iter}',
23+
srciterc: '\\operatorname{src\\_iter\\_c}',
24+
weights: '\\operatorname{weights}',
25+
weightslayer: '\\operatorname{weights\\_layer}',
26+
weightsiter: '\\operatorname{weights\\_iter}',
27+
weightspeephole: '\\operatorname{weights\\_peephole}',
28+
weightsprojection: '\\operatorname{weights\\_projection}',
29+
bias: '\\operatorname{bias}',
30+
dst: '\\operatorname{dst}',
31+
dstlayer: '\\operatorname{dst\\_layer}',
32+
dstiter: '\\operatorname{dst\\_iter}',
33+
dstiterc: '\\operatorname{dst\\_iter\\_c}',
34+
diffsrc: '\\operatorname{diff\\_src}',
35+
diffsrclayer: '\\operatorname{diff\\_src\\_layer}',
36+
diffsrciter: '\\operatorname{diff\\_src\\_iter}',
37+
diffsrciterc: '\\operatorname{diff\\_src\\_iter\\_c}',
38+
diffweights: '\\operatorname{diff\\_weights}',
39+
diffweightslayer: '\\operatorname{diff\\_weights\\_layer}',
40+
diffweightsiter: '\\operatorname{diff\\_weights\\_iter}',
41+
diffweightspeephole: '\\operatorname{diff\\_weights\\_peephole}',
42+
diffweightsprojection: '\\operatorname{diff\\_weights\\_projection}',
43+
diffbias: '\\operatorname{diff\\_bias}',
44+
diffdst: '\\operatorname{diff\\_dst}',
45+
diffdstlayer: '\\operatorname{diff\\_dst\\_layer}',
46+
diffdstiter: '\\operatorname{diff\\_dst\\_iter}',
47+
diffdstiterc: '\\operatorname{diff\\_dst\\_iter\\_c}',
48+
diffgamma: '\\operatorname{diff\\_\\gamma}',
49+
diffbeta: '\\operatorname{diff\\_\\beta}',
50+
workspace: '\\operatorname{workspace}'
51+
}
52+
}
53+
}

‎documentation/library_guide/_static/favicons.png

467 Bytes
Loading

‎documentation/library_guide/_static/oneAPI-rgb-rev-100.png

7.24 KB
Loading

‎documentation/library_guide/_templates/layout.html

+33
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{% extends "!layout.html" %}
2+
3+
{% block sidebartitle %}
4+
5+
{% if logo and theme_logo_only %}
6+
<a href="{{ pathto(master_doc) }}">
7+
{% else %}
8+
<a href="https://docs.oneapi.com/index.html" class="icon icon-home"> {{ project }}
9+
{% endif %}
10+
11+
{% if logo %}
12+
{# Not strictly valid HTML, but it's the only way to display/scale
13+
it properly, without weird scripting or heaps of work
14+
#}
15+
<img src="{{ pathto('_static/' + logo, 1) }}" class="logo" alt="Logo"/>
16+
{% endif %}
17+
</a>
18+
19+
{% if theme_display_version %}
20+
{%- set nav_version = version %}
21+
{% if READTHEDOCS and current_version %}
22+
{%- set nav_version = current_version %}
23+
{% endif %}
24+
{% if nav_version %}
25+
<div class="version">
26+
{{ nav_version }}
27+
</div>
28+
{% endif %}
29+
{% endif %}
30+
31+
{% include "searchbox.html" %}
32+
33+
{% endblock %}

‎documentation/library_guide/conf.py

+153
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,153 @@
1+
#===============================================================================
2+
# Copyright 2014-2020 Intel Corporation
3+
#
4+
# Licensed under the Apache License, Version 2.0 (the "License");
5+
# you may not use this file except in compliance with the License.
6+
# You may obtain a copy of the License at
7+
#
8+
# http://www.apache.org/licenses/LICENSE-2.0
9+
#
10+
# Unless required by applicable law or agreed to in writing, software
11+
# distributed under the License is distributed on an "AS IS" BASIS,
12+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
# See the License for the specific language governing permissions and
14+
# limitations under the License.
15+
#===============================================================================
16+
17+
## Content:
18+
## Intel(R) DAAL configuration file for the Sphinx documentation builder
19+
##******************************************************************************
20+
21+
# Configuration file for the Sphinx documentation builder.
22+
#
23+
# This file only contains a selection of the most common options. For a full
24+
# list see the documentation:
25+
# http://www.sphinx-doc.org/en/master/config
26+
27+
# -- Path setup --------------------------------------------------------------
28+
29+
# If extensions (or modules to document with autodoc) are in another directory,
30+
# add these directories to sys.path here. If the directory is relative to the
31+
# documentation root, use os.path.abspath to make it absolute, like shown here.
32+
#
33+
# import os
34+
# import sys
35+
# sys.path.insert(0, os.path.abspath('.'))
36+
37+
38+
# -- Project information -----------------------------------------------------
39+
40+
project = 'oneAPI Libraries Documentation'
41+
copyright = '2020, Intel Corporation'
42+
author = 'Intel'
43+
44+
# The full version, including alpha/beta/rc tags
45+
release = '1.0'
46+
47+
rst_prolog = """
48+
.. |full_name| replace:: oneAPI Libraries
49+
.. |short_name| replace:: oneAPI
50+
.. |product| replace:: prod
51+
.. |namespace| replace:: namespace
52+
.. |daal_in_code| replace:: in_code
53+
.. |reg| unicode:: U+000AE
54+
.. |copy| unicode:: U+000A9
55+
.. |base_tk| replace:: Intel\ |reg|\ oneAPI Base Toolkit
56+
.. |dpcpp| replace:: Intel\ |reg|\ oneAPI DPC++ Compiler
57+
"""
58+
59+
60+
# for substitutions in code blocks and sphinx-prompts:
61+
substitutions = [
62+
('|short_name|', 'oneDAL'),
63+
('|daal_in_code|', 'daal')
64+
]
65+
66+
# -- General configuration ---------------------------------------------------
67+
68+
# Add any Sphinx extension module names here, as strings. They can be
69+
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
70+
# ones.
71+
extensions = [
72+
'sphinx-prompt',
73+
'sphinx_substitution_extensions',
74+
#'sphinx.ext.extlinks',
75+
#'sphinx_tabs.tabs'
76+
]
77+
78+
docbundle_settings = {
79+
'csv_dir':'csv_dir'
80+
}
81+
82+
83+
# The master toctree document.
84+
master_doc = 'index'
85+
86+
87+
# Add any paths that contain templates here, relative to this directory.
88+
templates_path = ['_templates']
89+
90+
# List of patterns, relative to source directory, that match files and
91+
# directories to ignore when looking for source files.
92+
# This pattern also affects html_static_path and html_extra_path.
93+
exclude_patterns = ["opt-notice.rst", 'dev_guide/data-management/numeric-tables/*.rst', 'topics/*.rst',
94+
'dev_guide/algorithms/dbscan/distributed-steps/*',
95+
'dev_guide/algorithms/kmeans/includes/*',
96+
'notes/issues/2021.1-beta06/includes/*']
97+
98+
extlinks = {'cpp_example': ('https://github.com/oneapi-src/oneDAL/tree/master/examples/cpp/source/%s', ''),
99+
'java_example': ('https://github.com/oneapi-src/oneDAL/tree/master/examples/java/com/intel/daal/examples/%s', ''),
100+
'daal4py_example': ('https://github.com/IntelPython/daal4py/tree/master/examples/%s', ''),
101+
'cpp_sample': ('https://github.com/oneapi-src/oneDAL/tree/master/samples/cpp/%s', '')}
102+
103+
# -- Options for HTML output -------------------------------------------------
104+
105+
# The theme to use for HTML and HTML Help pages. See the documentation for
106+
# a list of builtin themes.
107+
#
108+
## html_theme = 'alabaster'
109+
110+
# Add any paths that contain custom static files (such as style sheets) here,
111+
# relative to this directory. They are copied after the builtin static files,
112+
# so a file named "default.css" will overwrite the builtin "default.css".
113+
html_static_path = ['_static']
114+
html_css_files = [
115+
'custom.css',
116+
]
117+
html_logo = '_static/oneAPI-rgb-rev-100.png'
118+
html_favicon = '_static/favicons.png'
119+
#latex_logo = '_static/oneAPI-rgb-3000.png'
120+
html_show_sourcelink = False
121+
#html_js_files = ['custom.js']
122+
123+
# html_context = {
124+
# 'css_files': [
125+
# '_static/style.css', # override wide tables in RTD theme
126+
# ],
127+
# }
128+
129+
130+
# html_theme = 'otc_tcs_sphinx_theme'
131+
# html_theme_path = ['_themes']
132+
133+
import sys
134+
import os
135+
# on_rtd is whether we are on readthedocs.org, this line of code grabbed from docs.readthedocs.org
136+
on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
137+
138+
import sphinx_rtd_theme
139+
html_theme = 'sphinx_rtd_theme'
140+
html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
141+
if on_rtd:
142+
using_rtd_theme = True
143+
144+
# Theme options
145+
html_theme_options = {
146+
# 'typekit_id': 'hiw1hhg',
147+
# 'analytics_id': '',
148+
# 'sticky_navigation': True, # Set to False to disable the sticky nav while scrolling.
149+
'logo_only': False, # if we have a html_logo below, this shows /only/ the logo with no title text
150+
'collapse_navigation': False, # Collapse navigation (False makes it tree-like)
151+
# 'display_version': True, # Display the docs version
152+
'navigation_depth': 4 # Depth of the headers shown in the navigation bar
153+
}

‎documentation/library_guide/extension_api.rst

+4-3
Original file line numberDiff line numberDiff line change
@@ -243,13 +243,13 @@ lesser argument unchanged.
243243
- maximum: A function object type where the operator() applies ``std::greater`` to its arguments, then returns the
244244
greater argument unchanged.
245245

246-
247246
Range-based API
248247
--------------------------
249248

250249
C++20 indroduces the *Ranges* library. С++20 standard splits ranges into two categories: *factories* and *adaptors*.
251250
A range factory doesn't have underlying data. An element is generated on success by an index or by dereferencing an iterator.
252-
A range adaptor, from the DPC++ library perspective, is an utility that transforms *base range*, or another adapted range into a view with custom behavior.
251+
A range adaptor, from the DPC++ library perspective, is an utility that transforms *base range*, or another adapted range into
252+
a view with custom behavior.
253253

254254
The DPC++ library supports ``iota_view`` range factory.
255255

@@ -264,7 +264,8 @@ The range adaptors may be combined into a pipeline with a ``base`` range at the
264264
auto range_1 = iota_view(0, 10) | views::reverse();
265265
auto range_2 = all_view(buf) | views::reverse();
266266
267-
For the range, based on the ``all_view`` factory, data access is permitted on a device only. ``size()`` and ``empty()`` methods are allowed to be called on both host and device.
267+
For the range, based on the ``all_view`` factory, data access is permitted on a device only. ``size()`` and ``empty()`` methods are allowed
268+
to be called on both host and device.
268269

269270
The following algorithms are available to use with the ranges:
270271

0 commit comments

Comments
 (0)