search

loco-3d / crocoddyl

Crocoddyl is an optimal control library for robot control under contact sequence. Its solver is based on various efficient Differential Dynamic Programming (DDP)-like algorithms
BSD 3-Clause "New" or "Revised" License
845 stars 173 forks source link

clean examples and jupyter documentation #88

Closed wxmerkt closed 4 years ago

wxmerkt commented 4 years ago

In GitLab by @proyan on Feb 4, 2019, 13:13

This includes the loco3d example

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 5, 2019, 23:57

I took a first action in the following PR: !90

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 6, 2019, 15:37

mentioned in merge request !90

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 6, 2019, 15:38

changed the description

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 7, 2019, 16:16

I proposed the following actions:

  1. Review the text in each Jupyter notebook.
  2. Move all notebooks to example/ (instead of examples/notebooks)
  3. Add a number to each notebook so users can go through a defined sequence.
  4. Rename the notebooks with a more descriptive name, e.g loco3d -> bipedal_walking
  5. Improve the visualization for the cartpole and unicycle problems (maybe based on gepetto-viewer?)
  6. Put the solution of each notebook in NOTEBOOKNAME_sol.py files

@nmansard any feedback regarding this tentative modifications?

wxmerkt commented 4 years ago

In GitLab by @nmansard on Feb 7, 2019, 17:15

  1. I would prefer to keep the notebook folder
  2. Not sure this is useful.

I think we should also make a test file for checking both the .ipynb and the *_sol.py files. Could you do that?

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 7, 2019, 17:48

Thanks for the feedback. Yes, I could.

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 12, 2019, 23:21

mentioned in merge request !100

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 12, 2019, 23:25

In the PR !100 I worked a many of the discussed points.

It remains two main tasks:

Additionally I proposed to write a README file which guides the user through all the Jupyter notebooks.

wxmerkt commented 4 years ago

In GitLab by @nmansard on Feb 18, 2019, 13:18

I believe example/talos_arm is not working. Could you check?

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 18, 2019, 13:59

It was a wrong construction of the CallbackDisplay due to a change in its API. I found this issue in other examples and notebooks. I pushed a commit to the devel branch that quickly fix them.

wxmerkt commented 4 years ago

In GitLab by @cmastalli on Feb 18, 2019, 15:47

I have to review new examples (jump, salto) and added the same policy for them.

@nmansard and @proyan if you include another example please do as follows:

wxmerkt commented 4 years ago

In GitLab by @nmansard on Feb 21, 2019, 17:15

This is done. I close it.

wxmerkt commented 4 years ago

In GitLab by @nmansard on Feb 21, 2019, 17:15

closed