📚 Documentation: Inline Documentation for TopologyTree Data Structure

[ayush268]

🙋 Where

https://github.com/NimbleEdge/RecoEdge/blob/75c397a4d911cbea04f2c2913a95ccc8642d5bb6/scala_core/src/main/scala/org/nimbleedge/recoedge/models/TopologyTree.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).

The TopologyTree data structure contains information about the graphical structure of the above entities. The entities are represented by their corresponding Identifier class objects.

We have to write the inline documentation for the classes.

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

[abhiwalia15]

Hello @ayush268, I would like to work on this issue. Please confirm if it is available.

Regards, Mrinal