Simplify running the vqe pipeline and recording the results

module:vqe (v1.0.0)
Share
License: BSD 3-clause (code) and CC BY-SA 4.0 (data)
Creation date: 2018-07-17
Source: GitHub
cID: 032630d041b4fd8a:6b82fa71240ce99c

Don't hesitate to get in touch if you encounter any issues or would like to discuss this community project!
Please report if this CK component works: 1 ▲ or fails: 0 ▲
Sign up to be notified when artifacts are shared or updated!

Description  

This is our attempt to share automation actions from scientific research projects as unified Python modules with a common CLI and Python API to help researchers and practitioners reuse best practices. Our on-going project is to make the onboarding process as simple as possible via this platform. Please check this CK white paper and don't hesitate to contact us if you have suggestions or feedback!
  • Automation framework: CK
  • Workflow: VQE quantum competition pipeline
  • Development repository: ck-quantum
  • Source: GitHub
  • How to get the stable version from this portal via the CK client:
    pip install cbench
    cb download module:vqe --version=1.0.0 --all
    ck help vqe
  • How to get the development version:
    pip install ck
    ck pull repo:ck-quantum
    ck help vqe
  • CK automation actions (CLI with the Python CK API and JSON IO):
    • ck cleanup vqe - Remove env and soft entries that make up deployed plugin(s) (API)
    • ck deploy vqe - Install the necessary plugin (optimizer or ansatz) and the corresponding environment for the 'run' method to work (helper function) (API)
    • ck deploy_ansatz vqe - Deploy one ansatz plugin (API)
    • ck deploy_optimizer vqe - Deploy one optimizer plugin (API)
    • ck list_deployables vqe - Get the list of all deployables of a template code-containing soft entry (helper function) (API)
    • ck list_experiments vqe - Returns a list of all VQE-relevant CK experiment entries (API)
    • ck list_registered_emails vqe - Get the list of emails of the users that have successfully recorded the quantum_coin_flip experiment (helper function) (API)
    • ck pick_an_experiment vqe - Select an experiment from the list (interactive helper function) (API)
    • ck plugin_path vqe - Get the path to the plugin's editable python file (API)
    • ck run vqe - Run several repetitions and record the results locally (API)
    • ck time_to_solution vqe - Calculate the Time-to-Solution metric for a given experiment (API)
    • ck upload vqe - Upload the best experimental results on the server for visualization and comparison (API)

Dependencies    

Style 1   Style 2  

Versions  

Files  

Comments  

Please log in to add your comments!
If you notice any inapropriate content that should not be here, please report us as soon as possible and we will try to remove it within 48 hours!