Typo in documentation for adaptive.learner.learner2D.uniform_loss(ip)

[basnijholt]

(original issue on GitLab)

opened by Adriaan (@AdriaanRol) at 2018-12-05T12:44:28.826Z

In the example for adaptive.learner.learner2D.uniform_loss(ip) the loss_per_triangle variable is set to uniform_sampling_2d, a variable that is undefined in the example snippet. I would expect this to be set to learner2D.uniform_loss combined with the appropriate import statement as is done in the example above it.

https://adaptive.readthedocs.io/en/latest/reference/adaptive.learner.learner2D.html#adaptive.Learner2D

[basnijholt]

originally posted by Bas Nijholt (@basnijholt) at 2018-12-05T12:47:38.087Z on GitLab

@AdriaanRol thanks for reporting this! I've fixed it in c0012a9.

[basnijholt]

originally posted by Adriaan (@AdriaanRol) at 2018-12-05T12:52:00.034Z on GitLab

Thanks for the quick fix.

@basnijholt , a related issue is in the binder.

The uniform sampling strategy is a common case to benchmark against, so the 1D and 2D versions are included in adaptive as adaptive.learner.learner1D.uniform_sampling and adaptive.learner.learner2D.uniform_sampling.

It refers to adaptive.learner.learner2D.uniform_sampling which does not exist. I would suggest updating the binder example to use the right variable names.

[basnijholt]

originally posted by Bas Nijholt (@basnijholt) at 2018-12-05T12:58:18.125Z on GitLab

Yes, that is because since we've had the documentation, the docs and the learner.ipynb have been diverging.

I am (with @jbweston) working on a way to generate the notebook (like the learner.ipynb) from the documentation's tutorial.

That will solve those problems.