-
Notifications
You must be signed in to change notification settings - Fork 61
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
documentation update #435
documentation update #435
Conversation
Codecov Report
@@ Coverage Diff @@
## warnings #435 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 83 83
Lines 11867 11867
==========================================
Hits 11867 11867
Flags with carried forward coverage won't be shown. Click here to find out more. Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for the update, looks good to me. The only thing is that this documentation assumes that qibotf is the default backend and qibojit as experiment that should be enabled using qibo.set_backend
. This will not be true after we merge #436 as qibojit will become the default backend. Shall we update the docs for this?
doc/source/installation.rst
Outdated
|
||
* :ref:`installing-qibotf` (*recommended*): an efficient simulation backend for CPU, GPU and multi-GPU based on TensorFlow custom operators. Install this package if you need to simulate quantum circuits with large number of qubits or complex quantum algorithms which may benefit from computing parallelism. | ||
* :ref:`installing-qibojit` (*experimental*): an efficient simulation backend for CPU, GPU and multi-GPU based on just-in-time (JIT) compiled custom operators. Install this package if you need to simulate quantum circuits with large number of qubits or complex quantum algorithms which may benefit from computing parallelism. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
qibojit does not support multi-GPU currently so we should probably remove the multi-GPU from this line and put it back once we enable this feature.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@stavros11 thanks, I have fixed this issue and resorted the backend priority.
It also looks good to me. However I would like to make one quick request as we are working on the documentation here already. When one searches in the documentation for "Adiabatic evolution" or "Quantum Fourier Transform" the first thing that pops up is the benchmarks, but they are not labelled as benchmarks so it's easy to get confused and enter in the wrong documentation part. I would add "benchmark" to the parts of the documentation that are benchmarks. |
@igres26 thanks for pointing this out. I have introduced some changes that should help clarifying that is benchmark from what is not. Most likely we should remove the benchmark section soon in the future, given that the code is evolving quickly. |
This PR updates the documentation for the following points: