Skip to content

Commit e7f6a05

Browse files
authored
oneart github links and remove intel in oidn (#289)
1 parent b38a203 commit e7f6a05

File tree

3 files changed

+22
-17
lines changed

3 files changed

+22
-17
lines changed

source/elements/oneART/source/conf.py

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,3 +31,11 @@
3131
'**/*.inc.rst',
3232
'*.inc.rst',
3333
]
34+
35+
html_theme_options = {
36+
'repository_url': 'https://github.com/oneapi-src/oneapi-spec',
37+
'path_to_docs': 'source/elements/oneART/source',
38+
'use_issues_button': True,
39+
'use_edit_page_button': True,
40+
'repository_branch': 'main',
41+
}

source/elements/oneART/source/index.rst

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
Advanced Ray Tracing
99
====================
1010

11-
Overview
12-
--------
13-
1411
.. include:: overview.inc.rst
1512

1613
.. toctree::

source/elements/oneART/source/oidn-spec.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
1-
Intel Open Image Denoise API
2-
============================
1+
Open Image Denoise API
2+
======================
33

4-
Intel Open Image Denoise provides a C99 API (also compatible with C++) and a C++11 wrapper API as well. For simplicity, this document mostly refers to the C99 version of the API.
4+
Open Image Denoise provides a C99 API (also compatible with C++) and a C++11 wrapper API as well. For simplicity, this document mostly refers to the C99 version of the API.
55

66
The API is designed in an object-oriented manner, e.g. it contains device objects (``OIDNDevice`` type), buffer objects (``OIDNBuffer`` type), and filter objects (``OIDNFilter`` type). All objects are reference-counted, and handles can be released by calling the appropriate release function (e.g. ``oidnReleaseDevice``) or retained by incrementing the reference count (e.g. ``oidnRetainDevice``).
77

@@ -20,7 +20,7 @@ To have a quick overview of the C99 and C++11 APIs, see the following simple exa
2020

2121
#include <OpenImageDenoise/oidn.h>
2222
...
23-
// Create an Intel Open Image Denoise device
23+
// Create an Open Image Denoise device
2424
OIDNDevice device = oidnNewDevice(OIDN_DEVICE_TYPE_DEFAULT);
2525
oidnCommitDevice(device);
2626

@@ -55,7 +55,7 @@ To have a quick overview of the C99 and C++11 APIs, see the following simple exa
5555

5656
#include <OpenImageDenoise/oidn.hpp>
5757
...
58-
// Create an Intel Open Image Denoise device
58+
// Create an Open Image Denoise device
5959
oidn::DeviceRef device = oidn::newDevice();
6060
device.commit();
6161

@@ -79,7 +79,7 @@ To have a quick overview of the C99 and C++11 APIs, see the following simple exa
7979
Device
8080
------
8181

82-
Intel Open Image Denoise supports a device concept, which allows different components of the application to use the Open Image Denoise API without interfering with each other. An application first needs to create a device with
82+
Open Image Denoise supports a device concept, which allows different components of the application to use the Open Image Denoise API without interfering with each other. An application first needs to create a device with
8383

8484
::
8585

@@ -134,7 +134,7 @@ Parameters supported by all devices.
134134

135135
Additional parameters supported only by CPU devices.
136136

137-
Note that the CPU device heavily relies on setting the thread affinities to achieve optimal performance, so it is highly recommended to leave this option enabled. However, this may interfere with the application if that also sets the thread affinities, potentially causing performance degradation. In such cases, the recommended solution is to either disable setting the affinities in the application or in Intel Open Image Denoise, or to always set/reset the affinities before/after each parallel region in the application (e.g., if using TBB, with ``tbb::task_arena`` and ``tbb::task_scheduler_observer``).
137+
Note that the CPU device heavily relies on setting the thread affinities to achieve optimal performance, so it is highly recommended to leave this option enabled. However, this may interfere with the application if that also sets the thread affinities, potentially causing performance degradation. In such cases, the recommended solution is to either disable setting the affinities in the application or in Open Image Denoise, or to always set/reset the affinities before/after each parallel region in the application (e.g., if using TBB, with ``tbb::task_arena`` and ``tbb::task_scheduler_observer``).
138138

139139
Once parameters are set on the created device, the device must be committed with
140140

@@ -148,7 +148,7 @@ This device can then be used to construct further objects, such as buffers and f
148148

149149
void oidnReleaseDevice(OIDNDevice device);
150150

151-
Note that Intel Open Image Denoise uses reference counting for all object types, so this function decreases the reference count of the device, and if the count reaches 0 the device will automatically get deleted. It is also possible to increase the reference count by calling
151+
Note that Open Image Denoise uses reference counting for all object types, so this function decreases the reference count of the device, and if the count reaches 0 the device will automatically get deleted. It is also possible to increase the reference count by calling
152152

153153
::
154154

@@ -183,7 +183,7 @@ to get notified when errors occur. Only a single callback function can be regist
183183

184184
When the device construction fails, ``oidnNewDevice`` returns ``NULL`` as device. To detect the error code of a such failed device construction, pass ``NULL`` as device to the ``oidnGetDeviceError`` function. For all other invocations of ``oidnGetDeviceError``, a proper device handle must be specified.
185185

186-
The following errors are currently used by Intel Open Image Denoise:
186+
The following errors are currently used by Open Image Denoise:
187187

188188
=============================== ==========================================
189189
Name Description
@@ -202,7 +202,7 @@ Possible error codes, i.e., valid constants of type ``OIDNError``.
202202
Buffer
203203
------
204204

205-
Large data like images can be passed to Intel Open Image Denoise either via pointers to memory allocated and managed by the user (this is the recommended, often easier and more efficient approach, if supported by the device) or by creating buffer objects (supported by all devices). To create a new data buffer with memory allocated and owned by the device, holding ``byteSize`` number of bytes, use
205+
Large data like images can be passed to Open Image Denoise either via pointers to memory allocated and managed by the user (this is the recommended, often easier and more efficient approach, if supported by the device) or by creating buffer objects (supported by all devices). To create a new data buffer with memory allocated and owned by the device, holding ``byteSize`` number of bytes, use
206206

207207
::
208208

@@ -273,7 +273,7 @@ Supported data formats, i.e., valid constants of type ``OIDNFormat``.
273273
Filter
274274
------
275275

276-
Filters are the main objects in Intel Open Image Denoise that are responsible for the actual denoising. The library ships with a collection of filters which are optimized for different types of images and use cases. To create a filter object, call
276+
Filters are the main objects in Open Image Denoise that are responsible for the actual denoising. The library ships with a collection of filters which are optimized for different types of images and use cases. To create a filter object, call
277277

278278
::
279279

@@ -338,7 +338,7 @@ Filters support a progress monitor callback mechanism that can be used to report
338338
OIDNProgressMonitorFunction func,
339339
void* userPtr);
340340

341-
Only a single callback function can be registered per filter, and further invocations overwrite the previously set callback function. Passing ``NULL`` as function pointer disables the registered callback function. Once registered, Intel Open Image Denoise will invoke the callback function multiple times during filter operations, by passing the payload as set at registration time (``userPtr`` argument), and a ``double`` in the range [0, 1] which estimates the progress of the operation (``n`` argument). When returning ``true`` from the callback function, Intel Open Image Denoise will continue the filter operation normally. When returning ``false``, the library will cancel the filter operation with the ``OIDN_ERROR_CANCELLED`` error code.
341+
Only a single callback function can be registered per filter, and further invocations overwrite the previously set callback function. Passing ``NULL`` as function pointer disables the registered callback function. Once registered, Open Image Denoise will invoke the callback function multiple times during filter operations, by passing the payload as set at registration time (``userPtr`` argument), and a ``double`` in the range [0, 1] which estimates the progress of the operation (``n`` argument). When returning ``true`` from the callback function, Open Image Denoise will continue the filter operation normally. When returning ``false``, the library will cancel the filter operation with the ``OIDN_ERROR_CANCELLED`` error code.
342342

343343
After setting all necessary parameters for the filter, the changes must be commmitted by calling
344344

@@ -356,7 +356,7 @@ Finally, an image can be filtered by executing the filter with
356356

357357
which will read the input image data from the specified buffers and produce the denoised output image.
358358

359-
In the following we describe the different filters that are currently implemented in Intel Open Image Denoise.
359+
In the following we describe the different filters that are currently implemented in Open Image Denoise.
360360

361361
RT
362362
~~
@@ -490,7 +490,7 @@ Parameters supported by the ``RTLightmap`` filter.
490490
Training
491491
========
492492

493-
The Intel Open Image Denoise source distribution includes a Python-based neural network training toolkit (located in the ``training`` directory), which can be used to train the denoising filter models with image datasets provided by the user. This is an advanced feature of the library which usage requires some background knowledge of machine learning and basic familiarity with deep learning frameworks and toolkits (e.g. PyTorch or TensorFlow, TensorBoard).
493+
The Open Image Denoise source distribution includes a Python-based neural network training toolkit (located in the ``training`` directory), which can be used to train the denoising filter models with image datasets provided by the user. This is an advanced feature of the library which usage requires some background knowledge of machine learning and basic familiarity with deep learning frameworks and toolkits (e.g. PyTorch or TensorFlow, TensorBoard).
494494

495495
The training toolkit consists of the following command-line scripts:
496496

0 commit comments

Comments
 (0)