a few typos and formatting fixes

probcomp / gen-quickstart

Gen learning material as Jupyter notebooks

127 stars 50 forks source link

a few typos and formatting fixes #85

Closed postylem closed 2 years ago

postylem commented 2 years ago

Mostly small typos and formatting things as I was going through the notebooks.

Differences that might need to be discussed:

In the Data Driven notebook,
- I changed the coordinates of the obstacles in some examples so the result would be simpler looking.
- I changed the PlannerParams that are used as an example to be the same as those used below when they're used for the first exercise.

alex-lew commented 2 years ago

Thanks, @postylem! Does your Jupytext not automatically update the *.ipynb files too? If it does, can you commit them?

alex-lew commented 2 years ago

I changed the PlannerParams that are used as an example to be the same as those used below when they're used for the first exercise.

Note that later on, we say we will "reset" the PlannerParams to their original values (the higher number of refinements, 3500). I think this higher number is a good thing -- it makes the results more interpretable, because the planner plans 'straighter paths'. Can we change this back to the parameters we had? We could also change the starter code in the exercise to use the higher parameters, so that the inconsistency you noticed is resolved.

alex-lew commented 2 years ago

I changed the coordinates of the obstacles in some examples so the result would be simpler looking.

Can you say a little more about this? Simpler-looking in what way?

postylem commented 2 years ago

I just pushed a commit which

makes the choices of PlannerParams be more consistent in the Data Driven notebook (discussed with @alex-lew offline)
adds the .ipynb files.
fixes a couple other small things like adding titles to some plots and changing the title of the Particle filtering notebook from "Pset 3" -> "Tutorial"

alex-lew commented 2 years ago

Looks good to me!