Include calculated error in calibrator logs

[kozhukalov]

Description

Calibration log table is extended with errors calculated
during calibration and sorted so that best
techniques are on the top of the table.

Fixes #2014

---

License

• I license this contribution under the terms of the GNU GPL, version 3 and grant Unitary Fund the right to provide additional permissions as described in section 7 of the GNU GPL, version 3.

Before opening the PR, please ensure you have completed the following where appropriate.

• I added unit tests for new code.
• I used type hints in function signatures.
• I used Google-style docstrings for functions.
• I updated the documentation where relevant.
• Added myself / the copyright holder to the AUTHORS file

[github-actions]

Hello @kozhukalov, thank you for submitting a PR to Mitiq! We will respond as soon as possible, and if you have any questions in the meantime, you can ask us on the Unitary Fund Discord.

[codecov]

Codecov Report

All modified lines are covered by tests ✅

Comparison is base (c069a38) 98.30% compared to head (c29e644) 98.30%.

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2038   +/-   ##
=======================================
  Coverage   98.30%   98.30%           
=======================================
  Files          87       87           
  Lines        4118     4125    +7     
=======================================
+ Hits         4048     4055    +7     
  Misses         70       70           

Files	Coverage Δ
mitiq/calibration/calibrator.py	98.61% <100.00%> (+0.07%)	⬆️

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[natestemen]

Really nice work Vladimir! Thanks for adding this!

I think we should add the errors by default as part of the table instead of adding the additional log_errors option. IMO if someone is asking for logs, lets provide everything!

[kozhukalov]

Ok, I'll make it default.

The only concern here is backward compatibility. Some people probably try to parse the performance log with their automation tools and we can break their pipelines. However I am new in Mitiq. Not sure how important it is.

[kozhukalov]

I am not sure what is wrong with the docs/readthedocs.org:mitiq check. It says Read the Docs build failed! but the build looks successful. @natestemen can you please help me understand what I should fix to make it green?

[purva-thakre]

@kozhukalov This is a bug in RTD. When there are multiple PRs running checks at the same time, RTD fails to build the documentation in all of them.

I do not know a way to re-trigger this build besides making a dummy commit.

[kozhukalov]

@purva-thakre The issue is that even if this RTD job is green it the becomes red later when another PR runs RTD job. So I think it should not be voting.

[purva-thakre]

@kozhukalov Yes, I have noticed that the green check becomes red later. Possibly some bug in RTD.

Don't worry too much about the RTD build failure as long as you are not making changes to the documentation.

[natestemen]

Awesome work with this! Thanks for the nice simple upgrade.