Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document the executor #1006

Open
6 tasks
alecandido opened this issue Oct 11, 2024 · 0 comments
Open
6 tasks

Document the executor #1006

alecandido opened this issue Oct 11, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@alecandido
Copy link
Member

alecandido commented Oct 11, 2024

The Executor is now exposed to the user for scripts, and it is only documented in the section https://qibo.science/qibocal/stable/tutorials/advanced.html#how-to-use-qibocal-as-a-library
(other than the docstrings, which are not intended for end user - for sure not as the only reference).

#creare executor
executor = Executor.create(
platform=platform,
output=pathlib.Path("experiment_data")
)

executor.run_protocol(t1_signal, t1_params, ExecutionMode.ACQUIRE)
executor.run_protocol(t1_signal, t1_params, ExecutionMode.FIT)

and by the examples in the runcards/ folder
https://github.com/qiboteam/qibocal/blob/main/runcards/single_shot.py
https://github.com/qiboteam/qibocal/blob/main/runcards/rx_calibration.py

which are also a bit conflicting, since the docs present the direct .run_protocol() usage, which is not the favored interface for the scripts' user (the docs should be updated, as the automated .run_protocol() invocation was not available at the time the tutorial has been written).

  • update existing tutorial

A more in-depth guide about the Executor and its features is certainly needed, going through:

  • the basic executor instantiation
  • the possible alternatives (explicit vs implicit usage, i.e. qibocal.routines)
  • the available protocols to be invoked, and their interface
  • the further methods available (other than protocols)
  • a clarification about its role as an object, and compositions' example (passing an open executor to another Python function)
@alecandido alecandido added the documentation Improvements or additions to documentation label Oct 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

1 participant