mitiq icon indicating copy to clipboard operation
mitiq copied to clipboard

Improve calibration user guide page

Open natestemen opened this issue 2 years ago • 2 comments

We have "Calibration" as part of the core concepts page in our our documentation, but the page could be filled in further to add more details and motivation.

natestemen avatar Jan 26 '23 22:01 natestemen

Hey @nathanshammah! Is there anything I can do for this? Just let me know, happy to contribute however would be helpful (or not at all if you've got it covered)

nickdgardner avatar Apr 17 '23 20:04 nickdgardner

I propose to update the Docs with more information about the functions and classes that have been added. One way to include them is with autosummary, as done here for ZNE's Factories in the User Guide. Example of the autosummary code:

.. autosummary:: :nosignatures:

~mitiq.zne.inference.LinearFactory ~mitiq.zne.inference.RichardsonFactory ~mitiq.zne.inference.PolyFactory ~mitiq.zne.inference.ExpFactory ~mitiq.zne.inference.PolyExpFactory ~mitiq.zne.inference.AdaExpFactory It could be nice to also add more details about the Settings options and the log=True option.

I also propose to include a link to the tutorial, once it gets added.

Misty-W avatar Apr 28 '23 16:04 Misty-W