Check scripts do not check tutorials, but should

[mhucka]

Describe the issue

None of the check scripts in the checks/ subdirectory test the tutorials. We should add a script, and also run it as part of check/all. As a starting point, we could look at Cirq's check/nbformat.

What version of this software are you using?

1.7.x

How can the issue be reproduced?

No response

[rosspeili]

Hey @mhucka would like to pick this up. Could you explain a bit more what do you suggest?

[mhucka]

@rosspeili Thanks for your interest in doing this.

The current situation is that none of the format-checking and linting scripts in the check/ subdirectory process the .ipynb notebook files in this repository. It would be good if we added a script to do that, in analogy to scripts like check/pylint.

The documentation tools used in this project are those of TensorFlow's docs system (https://github.com/tensorflow/docs/blob/master/tools/tensorflow_docs/tools/README.md), which contains a format checker and a linter. As a starting point for a script to run the TF docs tools, one could adapt Cirq's check script (https://github.com/quantumlib/Cirq/blob/main/check/nbformat).

Once a script that checks the docs is working, it could also be acced to check/all. The latter simply calls other scripts to do the heavily lifting, so it should be pretty easy to update.

[rosspeili]

Allow me to dive into this tomorrow morning, and I shall ping when a PR is issued. 🙏

[rosspeili]

@mhucka let me know how this looks. I took some initiative in uncertain situations, but explaining my reasoning in the PR. Please let me know if I should follow a different approach on any of the alleviations.