CQCL / pytket-cutensornet

cuTensorNet Python API extensions for pytket quantum SDK

Apache License 2.0

11 stars 1 forks source link

[docs] API example for structured_state for upcoming release v0.6.0 #94

Closed PabloAndresCQ closed 5 months ago

PabloAndresCQ commented 6 months ago

Description

Updated examples/mps_tutorial.ipynb [view]
Added a new examples/ttn_tutorial.ipynb [view]

Checklist

[x] I have run the tests on a machine with GPUs.
[x] I have performed a self-review of my code.
[x] I have commented hard-to-understand parts of my code.
[ ] I have made corresponding changes to the public API documentation.
[ ] I have added tests that prove my fix is effective or that my feature works.
[ ] I have updated the changelog with any user-facing changes.

PabloAndresCQ commented 6 months ago

Have you checked if everything is working?

I've checked the notebooks run fine on my personal laptop, which has NVIDIA GPUs.

Maybe it would be good to add the python only version from the notebooks as well?

Do you mean a version of the notebook without the result cells?

Are you doing any CI checks for them?

Our CI is very limited: since it's not setup on a computer with GPUs, CI does not run any automatic tests. This is far from ideal, and I'm hoping to get access to a cloud node with GPUs at some point in the future via AWS, or to set it up on a desktop the QEC team has given me access to. I'll work on this whenever some more people join the dev team.

cqc-melf commented 6 months ago

One of the problem with the ipynb files is that it is very difficult to compare them with older versions, we have solved this in the pytket examples in the way that we have the python version of the notebooks in the repo as well and check that they both match on the CI. We do this with:

    # Check that notebook is generated from script:
    p2j -o -t ${name}-gen.ipynb python/${name}.py
    cmp ${name}.ipynb ${name}-gen.ipynb
    rm ${name}-gen.ipynb

See https://github.com/CQCL/pytket-docs/blob/main/examples/check-examples#L19

If you think this would be helpful here as well, I am happy to add this here to the PR if you want to :)

Not having a GPU on the CI is something we should try to solve maybe at a later point in time, I was not aware that is still missing...

PabloAndresCQ commented 6 months ago

Ah! That sounds nice indeed. I think it'd be a good addition to this PR, thanks! :)

cqc-melf commented 6 months ago

@PabloAndresCQ I have added that now, feel free to take a look :)