entropicalabs / openqaoa

Multi-backend SDK for quantum optimisation
MIT License
116 stars 58 forks source link

Renaming certain files and classes #182

Open shahidee44 opened 1 year ago

shahidee44 commented 1 year ago

Prerequisites

Before raising this feature request, I have made sure:

Is your feature request related to a problem? Please describe.

Issues to be resolved:

  1. src/openqaoa-core/optimizers/qaoa_optimizer.py - (Renaming to something like vqa_optimizer.py since the functions in this module are not specific to QAOA.)
  2. src/openqaoa-core/optimizers/training_vqa.py - (training is more meant for ML. optimization_vqa is more accurate. optimization_loop is also proposed as a module name.)
  3. src/openqaoa-core/algorithms/baseworkflow.py - (Find a new name for the Workflow ABC. Workflow is a legacy name.)
  4. The object WorkflowProperties in src/openqaoa-core/algorithms/baseworkflow.py, is labelled as parameters in the asdict method of the workflow objects. A proposal was made to change the entry that contains information from this class from ['data']['input_parameters'] to ['data']['input_properties'].

Describe the solution you'd like

To discuss on what is a better naming scheme for the following files.

Additional context

Issue raised to resolve conversations in ongoing PR #170 that needs to be merged

Q-lds commented 1 year ago

@shahidee44 has this been done? You may also rename the issue with a more explicative name!