stulp / dmpbbo

Python/C++ library for Dynamical Movement Primitives and Black-Box Optimization
GNU Lesser General Public License v2.1
226 stars 89 forks source link

dmp_bb_robot readme #44

Closed studywolf closed 5 years ago

studywolf commented 5 years ago

It would be helpful if there could be a one liner be added about the use of the demo_one_update and demo_perform_rollouts be added in the readme on what the input directory is expected to contain. I didn't see anything in the referenced section of the docs about use of those files specifically.

stulp commented 5 years ago

Thanks for pointing this out. I am working on a complete revision of the documentation in the branch "revise_documentation". The main change will be to move the tutorial from the doxygen documentation to Markdown files. The main aim of the doxygen documentation will be to document the API.

During this major revision, I will include your suggestion above.

stulp commented 5 years ago

I'm done converting the tutorials to Markdown files. However, I have not yet described demos/dmp_bbo_robot/ yet. It needs an overhaul, which is a bit more work. The things to do (note to self):

On the stack!

stulp commented 5 years ago

The overhaul of boost::serialization and writing a tutorial for dmp_bbo_robot is done. The demo is here: https://github.com/stulp/dmpbbo/tree/master/demo_robot and the explanation is here: https://github.com/stulp/dmpbbo/blob/master/tutorial/dmp_bbo_robot.md