aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2023-11-20Fix broken pre-built binary table in readmeNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I16efef72b2234ba689749bbd72136b89ef628f26
2023-11-20Remove Android 10 testing warning from readme and update buildtoolNikhil Raj
* Removes warning we had given to users last release about Android 10 (Q) testing * Reverts the patch where we were checking out main branch of Arm NN instead of latest release branch in Buildtool * Updated Android API level in the bianry table in readme Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I1e497b7d0ecf8fa7d9dd7262ca740052c0db444e
2023-09-20Update documentation to correct C++ version: C++ 17Teresa Charlin
Signed-off-by: Teresa Charlin <teresa.charlinreyes@arm.com> Signed-off-by: Tracy Narine <tracy.narine@arm.com> Change-Id: I3aab361023d6330dd1c28d30dee4a81999ad1a53
2023-08-14Update Arm NN readme, build tool readme and Contributing md filesNikhil Raj
* Update Arm NN dev mailing list in CONTRIBUTING.md * Add new arch binaries in Readme.md * Update cxxopts version in Readme.md * Update Ubuntu version in build-tool/README.md Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Icc8a7651e1837d4e7b3b0a08cfe8c67f0d80d5ea
2023-07-27Fix missing pages in DoxygenNikhil Raj
* Some of the pages were moved/renamed hence doxygen was not finding them * Moving arm NN logo to center of the page Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Id19fb3ec488f03d805998dc6b772e0b84f2c4d71
2023-06-22Doxygen: Fix XML parsing error in Arm NN DoxygenNikhil Raj
* Currently Doxygen was failing with error XML Parsing Error: duplicate attribute in main. This is due to an obsolete align attribute * Fixed some minor warnings by closing the Third part tools table Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I08a0d734ee07aef6617aa23c6fbbc05fb20bdfe5
2023-05-05IVGCVSW-7484 Update versions in Arm NN for 23.05Nikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Ib0d7835355e82d94b66b27a25b56b788c4606ae8
2023-02-15Add Inclusive language commitment to main READMENikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I50d6191bd39c1f9192adffb11dfab43bf398ae36
2023-02-13Fix typo in Readme.mdKevin May
Signed-off-by: Kevin May <kevin.may@arm.com> Change-Id: I2a0044096a735def95f7b0225b4e61eb8e2f6bea
2023-02-09Document updates for 23.02Nikhil Raj
* Remove the PerformanceChart. png file which is no more used in the Readme * Update release version for pre-built binaries in readme * Remove link to outdated guide in readme * Update example release branch in Android NDK md file Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I8f5cac684f9fa1c9ec5d2ba2286dea5dd47136ca
2023-01-01IVGCVSW-7390 Bold text not appearing in doxygenNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I409ba5ccdd1f62f4142f69cf99bb6c78042a41e6
2022-11-21Change name of AAR file in the Readme download pathNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Id5521e527b4b8d738acf673c4c51e54c80b71a74
2022-11-08Update Readme files with newer versions of tools added during 22.11Nikhil Raj
* Flatbuffer version updated to 2.0.6 * Android NDK version updated to r25 * Removed cross-compilation guide as its been moved to build-tools * Android binaries updated in Readme Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Ia7054707c9463d8ce8b344ec5d86fdd83424b2c3
2022-09-06Remove branch switch announcement from main Readme fileNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Ief9171e77306f4392481beac1b3e413c08797532
2022-08-29IVGCVSW-6779 Add build-tool Docs and update docsJames Conroy
* Added Arm NN Build Tool README.md and license. * Added Dockerfile diagram image and license. * Updated existing guides: added note to the cross compile guide to use build-tool, removed content from the Delegate BuildGuideNative.md. * Added Arm NN logo image to homepage README.md and added license. Signed-off-by: James Conroy <james.conroy@arm.com> Change-Id: I9306ad24165cf3b0203c2a1852ec3afd718e9eab
2022-08-29Fixing documents for 22.08Nikhil Raj
* Fixed broken links * Updated link to bazel guide * Fixed versioning issues in packaging doc * Updated paths to binary files Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I6120bb2dd56d55a994cd12d99bed054ce4d7c058
2022-07-28IVGCVSW-7049 Inform Arm NN external users about switching branch to mainNikhil Raj
* Adding an announcement in the main Readme file with the date we are freezing master and moving to main branch Change-Id: I87a0e99d83cc872ef6ac3ba1f0fd445665885059 Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
2022-07-27IVGCVSW-7036 Remove reference to Android 32 from Arm NN README.Colm Donelan
Signed-off-by: Colm Donelan <colm.donelan@arm.com> Change-Id: I01000533c3023271f81e9f7f53504ba185a62778
2022-07-27Documentation refactor and updates.Cathal Corbett
* Includes updating ContributorGuide.md with information section 'Contributing code to Arm NN'. * Renaming of ContributorGuide.md to CONTRIBUTING.md. Also renamed associated licence file and links in other pages that call the md file. Signed-off-by: Cathal Corbett <cathal.corbett@arm.com> Change-Id: Ic3336d78b64ae41af07ea9fd03631bb161613c4b
2022-07-27Updated README links to latest releaseMike Kelly
* Changed download links to point at v22.05.01 rather than v22.02 * Corrected Android entries in order to clarify the versions: * 'Android 27' becomes 'Android 8.1 "O/Oreo" (API level 27)' * 'Android 28' becomes 'Android 9 "P/Pie" (API level 28)' * 'Android 29' becomes 'Android 10 "Q/Quince Tart" (API level 29)' * Corrected the download image for armv7a from arm64-v7a Signed-off-by: Mike Kelly <mike.kelly@arm.com> Change-Id: Ic79ebf481d3ee7ea6710d97f0ba665986a8e9c5b
2022-05-20Improve front-facing documentationJames Conroy
* Cleanup and make homepage docs more concise and direct * Highlight use of the TF Lite Delegate, guides and AI Tech talk Signed-off-by: James Conroy <james.conroy@arm.com> Change-Id: I7d0221bf804dd1769568beccbca93d23cdba24b6
2021-11-24Remove deprecated warnings from Readme.mdNikhil Raj
* These deprecated warnings have been there for more than two releases Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I1c816d80f6e74933cf5e4e8cc0dbad9a7a144562
2021-11-12Update the graph path in Readme and update project number in doxyfileNikhil Raj
* Move all the image files used in doxygen to docs/ * Have a single path for all images in Doxyfile * Update project number to 21.11 in Doxyfile Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Ic9102d36b69a8261caf8e55da645463540e0b9f3
2021-11-11IVGCVSW-6373 Update main READMENikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: Iea0afcb69230a22181629424a3f801f3128990d1
2021-10-12Github 581 - Upgrade doctestJan Eilers
* Upgrade doctest to version 2.4.6 to allow Arm NN to build with glibc 2.34 Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Iff2ef286ba5ad0e0ec0f54f510253a2ec4b464d3
2021-07-26IVGCVSW-5966 'Update all the documentation'Sadik Armagan
* Update all documentation for removing BOOST library dependency Signed-off-by: Sadik Armagan <sadik.armagan@arm.com> Change-Id: Ie21ff096a11b7a623b1b9bb6f71eb63ea6e7b615
2021-06-16Fix broken link to Ndk guide in armnn Readme.mdNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I1e96c0b15721e522346e2b66f4e3d388225cebde
2021-05-12IVGCVSW-5722 Update README.mdNarumol Prangnawarat
Signed-off-by: Narumol Prangnawarat <narumol.prangnawarat@arm.com> Change-Id: Ib1d74d644be1738ea13c5f6b2d17b8411fb3f6ee
2021-04-29IVGCVSW-5744 Remove Tensorflow, Caffe and Quantizer from documentationKevin May
* Remove from .md files and Doxygen * Remove from armnn/docker build * Remove Tensorflow model format from ExecuteNetworkParams * Remove Tensorflow model format from ImageTensorGenerator Signed-off-by: Kevin May <kevin.may@arm.com> Change-Id: Id6ed4a7d90366c396e8e0395d0ce43a3bcddcee6
2021-04-12Documentation - Add "How to get involved" section to README.mdFrancis Murtagh
Signed-off-by: Francis Murtagh <francis.murtagh@arm.com> Change-Id: I5919c9b93f335e09e542c7ecfbcba637f64df3b8
2021-03-16IVGCVSW-5778 Update README.md to say 16.04 LTS will be replaced by 18.04 LTS ↵Jim Flynn
from the 21.08 release Change-Id: I89ef90fe696706323715caa5f1a86b6dde978181 Signed-off-by: Jim Flynn <jim.flynn@arm.com>
2021-02-22Minor doc updatesNikhil Raj
* Updating README * Updating android ndk build guide Change-Id: I09f5e4fe09d590b6b482800730b78cbc84cee9e9 Signed-off-by: Nikhil Raj <nikhil.raj@arm.com>
2021-02-22IVGCVSW-5695 Update supported operatorsJan Eilers
* Update supported operators for the delegate, parsers, serializer and deserializer Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: I33ac99a29d894eec055cd05411014075d78b3168
2021-02-19IVGCVSW-5682 Add Deprecation NotificationJan Eilers
* For Quantizer, Tensorflow Parser and Caffe Parser Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: If30daa54947c417c0d700f11e630546b1745b72e
2021-02-01IVGCVSW-5605 Doxygen: Use readme.md as mainpage in doxygenJan Eilers
* Gives the readme file an update * Removes introduction.dox * Adds FAQ to doxygen Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Ibb67e7f2cac7e55556295eb7851c616561b17042
2020-11-26IVGCVSW-5457 Add How-To documentation for the TfLite DelegateJan Eilers
* Add guide.md to the delegate directory * Mentioned the guide in README.md Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Iaa373ecf28f57f4d8383489fecf43670ae8ca190
2020-11-17Added SECURITY.md fileMike Kelly
* New file contains the security policy, vulnerability reporting procedure and a PGP key that can be used to create secure vulnerability reports. * Removed Security section from README.md Signed-off-by: Mike Kelly <mike.kelly@arm.com> Change-Id: Ifdffdf81a7d2033a4fa323f081a7336504d67971
2020-11-17IVGCVSW-5311 Debian Packaging - Host packages in public PPAFrancis Murtagh
* Add guide to github README.md Signed-off-by: Francis Murtagh <francis.murtagh@arm.com> Change-Id: I23df585ee24e90629f821af0c780ad40d8c20f97
2020-11-09IVGCVSW-5462 Link fmt staticallyJan Eilers
* Fmt didn't get installed properly. Each component of an interface library needs to be installed separately. * Changed fmt to be a static library Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Ic69bc9536ee01eed7b434b1ff53150581ba60e00
2020-10-14IVGCVSW-5406 Update README.md with details of third party tools.Colm Donelan
* Add Description, version and provenience to third party tools table. * Update arm-security@arm.com email address. Signed-off-by: Colm Donelan <Colm.Donelan@arm.com> Change-Id: Id48f36ae2319688fafea9fc4757bc75b724b3d02
2020-09-30IVGCVSW-4519 Remove Boost Variant and apply_visitor variantJames Ward
* add mapbox/variant third party package Signed-off-by: James Ward <james.ward@arm.com> Change-Id: I181302780edd9dace40f158a11327316a12ce69a
2020-09-21Added Security Issues sectionMike Kelly
* Added Security Issues section with email address. Signed-off-by: Mike Kelly <mike.kelly@arm.com> Change-Id: If1ccfd3c7847cac0a09b6ec72fdfacba0011455e
2020-06-24IVGCVSW-4487 Adds ghc::filesystem to third-partyJan Eilers
* as replacement for boost::filesystem * added to cmake * added to TPIP in readme.md Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: I0098e490e8597a9bae4781cacba8e19f8a50d1f0
2020-06-19IVGCVSW-4488 Adding cxxopts to third-partyJan Eilers
* as alternative for boost::program_options * added to cmake * added to TPIP list in readme.md Signed-off-by: Jan Eilers <jan.eilers@arm.com> Change-Id: Id8c6a12c988196cdac55650bc4761c08a39b3abb
2020-05-27Update ArmNN README with doxygen informationNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I3ac729efba4945868710e2a233646f9634470967
2020-05-25IVGCVSW-4792 Update armnn readme and support filesNarumol Prangnawarat
* Add TPIP used by Arm NN * Add SqueezeNet to CaffeSupport.md * Add ResNet v2 50 to TensorFlowSupport.md * Update tested networks in TensorFlowLiteSupported.md Signed-off-by: Narumol Prangnawarat <narumol.prangnawarat@arm.com> Change-Id: I15927ea600a3dfffee082933d32f235f3940730e
2020-05-14MLCE-193 README and FAQ updates.Colm Donelan
* Add FAQ entry about ArmNN and ComputeLibrary mismatch * Add documentation reference to README that dynamically referrs to gh branch on GitHub. * Update ONNXSupport.mb to fix broken links. Signed-off-by: Colm Donelan <Colm.Donelan@arm.com> Change-Id: I6390d87443c57cc43e27ea0a27f830f8fc25244d
2020-05-13MLCE-193 Add FAQ.md to ArmNN GitHub.Colm Donelan
* Add basic FAQ.md file. * Refer to the file from README.md Signed-off-by: Colm Donelan <Colm.Donelan@arm.com> Change-Id: I16b861cd5513bd5493e3d2d459b61378b36a6846
2020-04-16IVGCVSW-4704 Update links to how to guides in our README.mdNikhil Raj
Signed-off-by: Nikhil Raj <nikhil.raj@arm.com> Change-Id: I11d059a76062cb7a0efb3e5fcece1d528e6d1879
2020-02-12IVGCVSW-4403 Update readme for sample standalone dynamic backendNarumol Prangnawarat
and remove standalone dynamic reference backend Signed-off-by: Narumol Prangnawarat <narumol.prangnawarat@arm.com> Change-Id: I33bc82d8b07450a9c3f6c5dc415eda8427aec57b