awslabs/fortuna

Documentation: Inconsistent outputs

thomaspinder opened this issue · 3 comments

Some docs have rendered output e.g., Sinusoidal regression, whereas others, such as MNIST Classification do not.

We should render the notebooks in a CI/CD loop. This would yield two benefits: 1) fully rendered and up-to-date notebooks, and 2) bug catching - if there's a change to the codebase that breaks a notebook, this workflow will catch it.

As a further consideration, letting the notebooks be .py files and converting them to notebooks with Jupytext would make the version control simpler.

If approved, I'd be happy to open a PR for this.

Yes good points, thanks. I agree that it's best to have all notebooks rendered. Feel free to go forward with this!

Thanks a lot.

About the conversion from .py to notebook, I've never done this but happy to check what your solution would be.

Great. I'll split this issue into two.