search

tensorflow / quantum

An open-source Python framework for hybrid quantum-classical machine learning.
https://www.tensorflow.org/quantum
Apache License 2.0
1.81k stars 581 forks source link

More documentation problems #619

Open lockwo opened 3 years ago

lockwo commented 3 years ago

While there are still problems with the rendering of the new math ops (see https://github.com/tensorflow/quantum/issues/594), I found what I think is another documentation problem on the tfq website. The descriptions for the attributes of tfq.datasets.spin_system.SpinSystemInfo (https://www.tensorflow.org/quantum/api_docs/python/tfq/datasets/spin_system/SpinSystemInfo) are all missing. This is the only place on the tfq website where the little description boxes have labels but no descriptions (see the attached picture to if this explanation is not clear). image Additionally, since the attribute descriptions exist in the code (see https://github.com/tensorflow/quantum/blob/v0.5.1/tensorflow_quantum/datasets/spin_system.py#L25) I assume this is a bug.

lockwo commented 3 years ago

I just noticed something else too. The tfi_chain page looks as it should image However, the attribute information for the xxz_chain is in code block style instead of attribute style image

I would be happy to make a PR to fix these (and the previous issue) if you have any information on how the website is built from the code and how to test is locally.

lockwo commented 2 years ago

Update: the SpinSystemInfo page changed, but is still wrong, now it just says A namedtuple alias for field number 0 for each attribute