Skip to content

Commit ece6c5a

Browse files
committed
DOCS: Fixed links to TF docs + added link to online MLI documentation into the main readme
1 parent 339c18d commit ece6c5a

File tree

5 files changed

+9
-6
lines changed

5 files changed

+9
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ embARC Machine Learning Inference Library
22
==================================================
33

44
This repository contains source code of embARC Machine Learning Inference Library (embARC MLI Library),
5-
examples and documentation.
5+
examples and documentation sources. Full documentation is available [online](https://embarc.org/embarc_mli).
66

77
## Release notes
88
----------------

doc/documents/MLI_kernels/convolution_2d.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ inputs shape.
4949

5050
For more details on calculations see convolution part of `TensorFlow–Neural Network details`_.
5151

52-
.. _TensorFlow–Neural Network details: https://www.tensorflow.org/api_guides/python/nn.
52+
.. _TensorFlow–Neural Network details: https://www.tensorflow.org/versions/r1.11/api_guides/python/nn
5353

5454
ReLU activation function might be applied to result of convolution. The
5555
following types of ReLU activations are supported (for more info see

doc/documents/MLI_kernels/pooling_max.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ padding parameters. This logic is similar to convolution 2D operation
3434
For more information on calculations, see the pooling part of
3535
`TensorFlow–Neural Network details`_.
3636

37-
.. _TensorFlow–Neural Network details: https://www.tensorflow.org/api_guides/python/nn
37+
.. _TensorFlow–Neural Network details: https://www.tensorflow.org/versions/r1.11/api_guides/python/nn
3838

3939
.. caution::
4040
Ensure that input and output

doc/documents/library_model/functions.rst

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -137,8 +137,8 @@ Naming convention for the specializations: \
137137
| | parameters to achieve | |
138138
| | same output size | |
139139
| | (similar to ‘SAME’ | |
140-
| | padding scheme used | |
141-
| | in TensorFlow [3]) | |
140+
| | `padding scheme`_ used | |
141+
| | in TensorFlow) | |
142142
+-----------------------+---------------------------+-----------------------+
143143
| ``Input channels`` | [_ch\ *n*] | convolution group, |
144144
| | | pooling group |
@@ -182,6 +182,9 @@ Naming convention for the specializations: \
182182
| | specializations. | |
183183
+-----------------------+---------------------------+-----------------------+
184184

185+
.. _padding scheme: https://www.tensorflow.org/versions/r1.11/api_guides/python/nn#Notes_on_SAME_Convolution_Padding
186+
187+
185188

186189
For example, the function name of a 16bit 2d convolution kernel with
187190
CHW layout and a kernel size of 3x3 and stride of 1 is:

doc/documents/library_model/hw_dependencies_config.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -109,7 +109,7 @@ round to the nearest even). All parameters are described in *MetaWare
109109
Fixed-Point Reference for ARC EM and ARC HS*.
110110

111111
.. note::
112-
The MLI Library sets the required DSP mode inside each function where it is needed, but does not restore it to previous state. If another ARC DSP code beside MLI library is used in an application, ensure that you set the required DSP mode before its execution. For more information see “Configuring the ARC DSP Extensions” section of *MetaWare DSP Programming Guide for ARC EM and ARC HS* or “Using the FXAPI” section of entry [5] of *MetaWare Fixed-Point Reference for ARC EM and ARC HS*.
112+
The MLI Library sets the required DSP mode inside each function where it is needed, but does not restore it to previous state. If another ARC DSP code beside MLI library is used in an application, ensure that you set the required DSP mode before its execution. For more information see “Configuring the ARC DSP Extensions” section of *MetaWare DSP Programming Guide for ARC EM and ARC HS* or “Using the FXAPI” section of *MetaWare Fixed-Point Reference for ARC EM and ARC HS*.
113113

114114
AGU Support
115115
^^^^^^^^^^^

0 commit comments

Comments
 (0)