Skip to content

Commit 437ba1f

Browse files
committed
Fixing Broken Links and referrig to the pre-built documentation
1 parent 6fae0fa commit 437ba1f

File tree

1 file changed

+11
-4
lines changed

1 file changed

+11
-4
lines changed

README.md

Lines changed: 11 additions & 4 deletions
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-
documentation and examples. Read the documentation at [embarc.org](https://embarc.org/embarc_mli).
5+
documentation and examples.
66

77
## Release notes
88
----------------
@@ -31,9 +31,16 @@ documentation and examples. Read the documentation at [embarc.org](https://embar
3131
* Average Pooling (HWC Layout)
3232
5. Slicing support: creation of sub-tenors and support for non-contiguous tensor data.
3333

34+
## Documentation
35+
----------------
36+
The pre-built documentation can be found on the [release page](https://github.com/foss-for-synopsys-dwc-arc-processors/embarc_mli/releases)
37+
in the assets list of the required embARC MLI library version. To use it download
38+
*embARC_MLI_\<version\>_API_Doc.zip* file, unzip the archive and
39+
open `<unzipped_archive_root>/html/index.html` file in a browser.
40+
3441
## Package structure
3542
--------------------
36-
./bin - directory holder for embARC MLI library and samples binaries created during build
43+
./bin - directory holder for embARC MLI library and samples binaries created during build
3744
./build - contains common build rules
3845
./doc - contains the API documentation of the embARC MLI library
3946
./include - include files with API prototypes and types
@@ -90,11 +97,11 @@ Please be aware that the list of specializations is not guaranteed to be backwar
9097
---------------
9198

9299
***Q: Can I use ARC GNU tools to build embARC MLI library?***
93-
A: No you cannot. embARC MLI Library must be built by MetaWare Development Tools only. Read the documentation at [embarc.org]( https://embarc.org/embarc_mli/doc/build/html/getting_started/getting_started.html#build-library) for details
100+
A: No you cannot. embARC MLI Library must be built by MetaWare Development Tools only.
94101

95102
***Q: Can I use MetaWare Development Tools Lite to pre-build embARC MLI library and ARC GNU to build example application?***
96103
A: No you cannot. embARC MLI Library must be built by full version of MetaWare Development Tools. Binaries built with MWDT Lite are not compatible with ARC GNU Tools and full MetaWare Development Tools. Read the MWDT Lite documentation for details.
97104

98105
***Q: I can not build and run example application for my Synopsys board (EMSK, IoTDK, etc), what I shall do?***
99-
A: If you build for Synopsys boards refer to documentation [embarc.org](https://embarc.org/platforms.html) as a good starting point.
106+
A: If you build for Synopsys boards refer to documentation [embarc.org](https://embarc.org/projects/development-systems/) as a good starting point.
100107
You should also note that example applications support different configurations for pre trained models and thus memory requirements, not all configurations can be built and run on Synopsys boards due to memory limitations and HW capabilities, read example application readme for details. embARC MLI Library must be also pre built specifically for your board by MetaWare Development Tools. Please note that makefiles provided with examples are configured for IoTDK only if GNU tools are used.

0 commit comments

Comments
 (0)