aboutsummaryrefslogtreecommitdiff
path: root/src/mlia/core/__init__.py
diff options
context:
space:
mode:
Diffstat (limited to 'src/mlia/core/__init__.py')
-rw-r--r--src/mlia/core/__init__.py21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/mlia/core/__init__.py b/src/mlia/core/__init__.py
new file mode 100644
index 0000000..49b1830
--- /dev/null
+++ b/src/mlia/core/__init__.py
@@ -0,0 +1,21 @@
+# SPDX-FileCopyrightText: Copyright 2022, Arm Limited and/or its affiliates.
+# SPDX-License-Identifier: Apache-2.0
+"""Core module.
+
+Core module contains the main components that are used in the workflow of
+ML Inference Advisor:
+ - data collectors
+ - data analyzers
+ - advice producers
+ - event publishers
+ - event handlers
+
+The workflow of ML Inference Advisor consists of 3 stages:
+ - data collection
+ - data analysis
+ - advice generation
+
+Data is being passed from one stage to another via workflow executor.
+Results (collected data, analyzed data, advice, etc) are being published via
+publish/subscribe mechanishm.
+"""