Improvement of Documentation how to use pypi package
nquetschlich opened this issue · comments
Right now, from some benchmarks (ground state, estimated state and shor) only certain instances can be chosen using the get_one_benchmark methods. This needs clear documentation on the readme.
- Documentation which benchmarks need specific values for the benchmark_instance_name parameter
- Documentation which benchmark_instance_name refers to which instance
- Documentation that for the other non scalable benchmarks the circuit_size parameter can be used while it does not correspond to the resulting qubit number
- Documentation that the v-chain cases (grover, qwalk)
- Documentation for the remaining cases
solved in #93