Skip to content
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

Merged
merged 7 commits into from
Jul 4, 2021
Merged

documentation update #435

merged 7 commits into from
Jul 4, 2021

Conversation

scarrazza
Copy link
Member

This PR updates the documentation for the following points:

  • applications are now sorted by topic and algorithms.
  • installation instructions include qibojit and qiboicarusq.

@scarrazza scarrazza requested review from stavros11 and igres26 July 3, 2021 21:49
@codecov
Copy link

codecov bot commented Jul 3, 2021

Codecov Report

Merging #435 (f39a6e9) into warnings (d88a3b3) will not change coverage.
The diff coverage is n/a.

❗ Current head f39a6e9 differs from pull request most recent head 6ff50dc. Consider uploading reports for the commit 6ff50dc to get more accurate results
Impacted file tree graph

@@            Coverage Diff             @@
##           warnings      #435   +/-   ##
==========================================
  Coverage    100.00%   100.00%           
==========================================
  Files            83        83           
  Lines         11867     11867           
==========================================
  Hits          11867     11867           
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.


Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update d88a3b3...6ff50dc. Read the comment docs.

Copy link
Member

@stavros11 stavros11 left a 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?


* :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.
Copy link
Member

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.

Copy link
Member Author

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.

@igres26
Copy link
Contributor

igres26 commented Jul 4, 2021

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.

@scarrazza scarrazza changed the base branch from qibojit to warnings July 4, 2021 14:27
@scarrazza
Copy link
Member Author

@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.

@scarrazza scarrazza merged commit 8c5fe1b into warnings Jul 4, 2021
@scarrazza scarrazza deleted the docup branch July 10, 2021 17:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants