Skip to content

Commit 2cc44e6

Browse files
committed
fixed readme
1 parent 525d3db commit 2cc44e6

1 file changed

Lines changed: 8 additions & 12 deletions

File tree

  • src/bitbots_motion/bitbots_rl_motion

src/bitbots_motion/bitbots_rl_motion/README.md

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,24 @@ The package contains a framework which is a capsule for the application of polic
44

55
## Framework structure
66

7-
The code is divided in five sections: Configs, Handlers, Models, Nodes and rest.
8-
9-
The Models-folder contains all policy models. Node, the framework expects that policies are in .onnx-format.
7+
The code is divided in five sections: Configs, Handlers, Nodes, Launch and rest.
108

119
The Nodes-folder contains all relevant ROS-Nodes regarding policy models. These nodes are responsible for starting the policies correctly, feeding them with correct data and publishing their outputs correctly.
1210
The name of the node describes for which kind of policy it is suitable.
1311
The RL Node is a special case. All other nodes are kids of the RL Node. It centralizes the execution loop and minimizes boiler plate code.
1412

1513
The Handlers-folder contains all handlers. A handler is a specific type of object which is responsible for processing external data such that they are comprehensible for the policy models. All handlers are kids of the Handler class.
1614

17-
The Configs-folder contains all robot/policy specific configurations. Files in the Configs-folder should be in .yaml-format.
15+
The Configs-folder contains all robot/policy specific configurations. Files in the Configs-folder should be in .yaml-format. They also contain the paths to the onnx-policy models.
16+
17+
The Launch-folder contains a launch file which starts all relevant policy nodes.
1818

19-
phase.py, policy_nodes.py and previous_action.py are two files, which do not fall in any of the aforementioned categories.
20-
phase.py defines a PhaseObject, which is responsible for the phase management. previous_action.py defindes a PreviousAction object, which is responsible for saving and provide the previous action. policy_nodes.py can be looked as the launch file. It defines, which nodes and policies will be used.
19+
phase.py and previous_action.py are two files, which do not fall in any of the aforementioned categories.
20+
phase.py defines a PhaseObject, which is responsible for the phase management. previous_action.py defindes a PreviousAction object, which is responsible for saving and provide the previous action.
2121
Both files are located in the bitbots_rl_motion folder.
2222

2323
## Execution
2424

25-
For proper starting you need a policy model and a config file. The config file should have the same structure as the wolfgang_config.yaml file.
25+
For proper starting you need a policy model and a config file. The config file should have the same structure as the wolfgang_dribbling_model_config.yaml file.
2626
Furthermore, you have to create or adjust a node file to your needs. walk_node.py can be used for orientation. If chages are conducted on the RL_Node class, it should be announced.
27-
Finally, you define which nodes and policies you wanna use in the policy_nodes.py file.
28-
29-
30-
31-
27+
Finally, you define which nodes and policies you wanna use in the launch file.

0 commit comments

Comments
 (0)