From: subhash kumar singh <subh.singh@samsung.com>
Date: Fri, 7 Feb 2025 13:18:18 +0000 (+0530)
Subject: Add flow diagram for model states
X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=commitdiff_plain;h=refs%2Fheads%2Fk-release;p=aiml-fw%2Faimlfw-dep.git

Add flow diagram for model states

Added flow diagram to understand different state of model
training.

Change-Id: I6ec54cf2d5a51901afa4eff18d3f8547d3c99050
Signed-off-by: subhash kumar singh <subh.singh@samsung.com>
---

diff --git a/docs/_static/flow.png b/docs/_static/flow.png
new file mode 100644
index 0000000..291674e
Binary files /dev/null and b/docs/_static/flow.png differ
diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst
index 3e69d93..a167d5d 100755
--- a/docs/installation-guide.rst
+++ b/docs/installation-guide.rst
@@ -539,6 +539,27 @@ Verify Updated Artifact-Version after retraining from MME
 |               From 1.x.0 to 1.(x + 1).0
 
 
+Below state diagram captures the flow for model state for training/training.
+
+.. image:: _static/flow.png
+  :width: 600
+  :alt: State diagram to represent different states of model training
+
+.. code-block::
+        
+        @startuml
+                [*] -[#blue]-> State1 : Registrer Model to MME
+                State1 -[#blue]-> State1 : Update Model
+                State1 -[#blue]-> [*] : Delete Model Registration
+                State1 : Model onboarded
+                State1 -[#blue]-> State2 : Train Model Request
+                State2 : Trained model
+                State2 -[#blue]-> [*] : Delete Model Registration
+                State2 -[#blue]-> State3 : Re-train Model Request
+                State3 : Retrained model
+                State3 -[#blue]-> [*] : Delete Model Registration
+        @enduml
+
 ..  _reference4:
 
 Model-Deployment