search

unitaryfund / mitiq

Mitiq is an open source toolkit for implementing error mitigation techniques on most current intermediate-scale quantum computers.
https://mitiq.readthedocs.io
GNU General Public License v3.0
360 stars 158 forks source link

Observable class missing methods in API-doc #2524

Open natestemen opened 3 days ago

natestemen commented 3 days ago

Currently, the only method of Observable which is displaying in our API-doc is matrix. Not sure why this is, but the class has many other handy methods which should also be displayed!

Links

natestemen commented 2 days ago

So the reason the many other methods are not appearing in the API-doc is that they are not documented! To close this issue we should document the following methods.

  1. measure_in
  2. The arguments of matrix should be flushed out using the Args: ... pattern.
  3. expectation
  4. partition
  5. from_pauli_string_collections