MLBEDSW-3424: Added API.md

- Added API.md that describes the external APIs.
- Renamed npu_get_api_version

Signed-off-by: Louis Verhaard <louis.verhaard@arm.com>
Change-Id: I6e6e6103a889da656b4e00c3cce3eee60dfa844a

3 files changed, 12 insertions, 12 deletions

diff --git a/ethosu/vela/api.py b/ethosu/vela/api.py
index 22f81d09..e6286008 100644
--- a/ethosu/vela/api.py
+++ b/ethosu/vela/api.py
@@ -25,9 +25,9 @@ from typing import Tuple
 
 import numpy
 
-API_version_major = 1
-API_version_minor = 0
-api_version = f"{API_version_major}.{API_version_minor}"
+API_VERSION_MAJOR = 1
+API_VERSION_MINOR = 0
+API_VERSION = f"{API_VERSION_MAJOR}.{API_VERSION_MINOR}"
 
 
 class NpuAccelerator(Enum):
@@ -388,13 +388,13 @@ class NpuElementWiseOperation(NpuBlockOperation):
         self.rescale: Optional[Tuple] = None
 
 
-def npu_get_API_version():
+def npu_get_api_version():
     """
     Public facing API to get the API version
     :return: int, the 16 most significant bits, corresponding to major version
             the 16 least significant bits, corresponding to minor version
     """
-    version = (API_version_major << 16) | (API_version_minor & 0xFFFF)
+    version = (API_VERSION_MAJOR << 16) | (API_VERSION_MINOR & 0xFFFF)
     return version
 
 
diff --git a/ethosu/vela/test/extapi/test_extapi_get_version.py b/ethosu/vela/test/extapi/test_extapi_get_version.py
index 3a6f25c4..779c2135 100644
--- a/ethosu/vela/test/extapi/test_extapi_get_version.py
+++ b/ethosu/vela/test/extapi/test_extapi_get_version.py
@@ -15,12 +15,12 @@
 # limitations under the License.
 # Description:
 # Contains unit tests for get API version for an external consumer
-from ethosu.vela.api import api_version
-from ethosu.vela.api import npu_get_API_version
+from ethosu.vela.api import API_VERSION
+from ethosu.vela.api import npu_get_api_version
 
 
-def test_npu_get_API_version():
-    int_version = npu_get_API_version()
+def test_npu_get_api_version():
+    int_version = npu_get_api_version()
     version_major = int_version >> 16
     version_minor = 0xFFFF & int_version
-    assert api_version == f"{version_major}.{version_minor}"
+    assert API_VERSION == f"{version_major}.{version_minor}"
diff --git a/ethosu/vela/vela.py b/ethosu/vela/vela.py
index f03bae75..b93774d0 100644
--- a/ethosu/vela/vela.py
+++ b/ethosu/vela/vela.py
@@ -30,7 +30,7 @@ from . import scheduler
 from . import stats_writer
 from . import tflite_writer
 from ._version import __version__
-from .api import api_version
+from .api import API_VERSION
 from .debug_database import DebugDatabase
 from .errors import InputFileError
 from .nn_graph import PassPlacement
@@ -192,7 +192,7 @@ def main(args=None):
     parser = argparse.ArgumentParser(prog="vela", description="Neural network model compiler for Arm Ethos-U NPUs")
     parser.add_argument("--version", action="version", version=__version__)
     parser.add_argument(
-        "--api-version", action="version", version=api_version, help="Displays the version of the external API."
+        "--api-version", action="version", version=API_VERSION, help="Displays the version of the external API."
     )
     parser.add_argument(
         "--supported-ops-report",