📚 Documentation: Inline Documentation for RealTimeGraphQuery Actor

[ayush268]

🙋 Where

https://github.com/NimbleEdge/RecoEdge/blob/75c397a4d911cbea04f2c2913a95ccc8642d5bb6/scala_core/src/main/scala/org/nimbleedge/recoedge/RealTimeGraphQuery.scala

💭 Description

The FLSystemManager is the top level Actor for the FLSystem.

Under FLSystem, lies the entire FL System, mainly the following major actors (entities):

• Orchestrator (root nodes) - It will have aggregators as children.
• Aggregator (intermediate nodes) - An aggregator can have other aggregators and trainers as children.
• Trainer (leaves) - A trainer is at the leaf of the tree. (Other actors might be spawned as need arises).

At each instance the FL System will have a graph of active entities and we have to fetch that real Time Graph or orchestrators / aggregators (as they are the only ones who can be nodes of the tree). Since Querying the real time graph is a heavy query, we spawn an anonymous Actor (just like you would spawn a new thread) to do the query on behalf the main entity and return the result to the requester.

We have to write the inline documentation for the classes and methods (messages).

This issue will help you understand the actor model and how different parts of the codebase are working together. You will have to read the code and after you have an understanding of how its working, you will be writing the documentation for the different parts so that anyone else reading the code can understand it easily.

We are using the ScalaDoc format for documentation. The following links are concise and would be very useful:

• https://docs.scala-lang.org/style/scaladoc.html
• https://www.baeldung.com/scala/scaladoc

👀 Have you spent some time to check if this issue has been raised before?

• [X] I checked and didn't find similar issue

🏢 Have you read the guidlines?

• [X] I have read the Guildlines

🏢 Have you read the Code of Conduct?

• [X] I read the Code of Conduct

[GDTarot]

Hello! May I be assigned please?