Skip to content
This repository has been archived by the owner on Jun 12, 2023. It is now read-only.

Documentation for Randomized Benchmarking #345

Merged
merged 15 commits into from
Mar 10, 2020
Merged

Documentation for Randomized Benchmarking #345

merged 15 commits into from
Mar 10, 2020

Conversation

ShellyGarion
Copy link
Contributor

@ShellyGarion ShellyGarion commented Feb 12, 2020 •
edited
Loading

Summary

Documentation for Randomized Benchmarking

Details and comments

@ajavadia ajavadia added the documentation Something is not clear or error in description label Feb 14, 2020
@ShellyGarion
Copy link
Contributor Author

I mainly handled the function randomized_benchmarking_seq.
Since the code contains 9 classes (4 for fitters, 5 for groups) and ~200 functions, I was only able to make minor syntax improvements in the other parts of the RB code.

@ShellyGarion ShellyGarion changed the title [WIP] Documentation for Randomized Benchmarking Documentation for Randomized Benchmarking Feb 17, 2020
yaelbh
yaelbh suggested changes Feb 20, 2020
View reviewed changes
Copy link
Contributor

@yaelbh yaelbh left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

.

@chriseclectic chriseclectic added this to the Ignis 0.3 milestone Feb 26, 2020
This was referenced Feb 27, 2020
Merged
Closed
@ShellyGarion ShellyGarion requested a review from yaelbh March 1, 2020 08:06
yaelbh
yaelbh previously approved these changes Mar 1, 2020
View reviewed changes
chriseclectic
chriseclectic reviewed Mar 3, 2020
View reviewed changes
qiskit/ignis/verification/randomized_benchmarking/circuits.py Outdated
length_multiplier: An array that scales each RB sequence by
the multiplier.

For example:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Having these code examples in the args documentation makes it very difficult to read.

I think all these kind of detailed descriptions and examples should be included in the general function documentation and the Args: and Returns: documentation should just be a shorter deescription.

Args:
    arg: short description or arg.

Returns:
    short description of return.

Copy link
Contributor Author

@ShellyGarion ShellyGarion Mar 4, 2020 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

OK, I moved most of the examples to the Example section at the end of the doc.
I only left a few small examples inside the args.
I followed the documentation of:
https://qiskit.org/documentation/_modules/qiskit/circuit/quantumcircuit.html#QuantumCircuit

@chriseclectic chriseclectic merged commit 38dd6f9 into qiskit-community:master Mar 10, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Reviewers

@chriseclectic chriseclectic chriseclectic approved these changes

@yaelbh yaelbh yaelbh left review comments

@yehuda-naveh yehuda-naveh Awaiting requested review from yehuda-naveh

Assignees
No one assigned
Labels
documentation Something is not clear or error in description
Projects
None yet
Milestone
Ignis 0.3
Development

Successfully merging this pull request may close these issues.
4 participants
@ShellyGarion @chriseclectic @yaelbh @ajavadia