Skip to content
This repository was archived by the owner on Jan 12, 2024. It is now read-only.

Conversation

@cesarzc
Copy link
Contributor

@cesarzc cesarzc commented Apr 15, 2021

Since new interfaces will be added shortly, moving all these related source files to its own folder will help keep everything organized.

@cesarzc cesarzc requested a review from bamarsha April 15, 2021 03:07
@swernli
Copy link
Collaborator

swernli commented Apr 15, 2021

I mentioned this in #627 (comment), but realized the discussion is probably better had here. "Machines" is such a generic name for a folder, that I worry it could be confusing for folks not already familiar with our object hierarchy what to expect to find there. I haven't been able to come up with any more descriptive names, so maybe we need something in a readme that clarifies what this folder and the term "Machine" are describing?

For me, it's a bit of a disconnect to call these machines, since that isn't usually a word I associate with the infrastructure for submitting something to a service, but I'm at a loss to come up with an alternative. As I've often joked, English feels insufficiently descriptive for our needs ;)

@cesarzc cesarzc requested a review from swernli April 15, 2021 16:48
@cesarzc
Copy link
Contributor Author

cesarzc commented Apr 15, 2021

I mentioned this in #627 (comment), but realized the discussion is probably better had here. "Machines" is such a generic name for a folder, that I worry it could be confusing for folks not already familiar with our object hierarchy what to expect to find there. I haven't been able to come up with any more descriptive names, so maybe we need something in a readme that clarifies what this folder and the term "Machine" are describing?

For me, it's a bit of a disconnect to call these machines, since that isn't usually a word I associate with the infrastructure for submitting something to a service, but I'm at a loss to come up with an alternative. As I've often joked, English feels insufficiently descriptive for our needs ;)

Yes, I couldn't come up with a good name for the folder yesterday when I was doing this. Maybe RemoteExecution would be a better name for it?

@bamarsha
Copy link
Contributor

Maybe an *Executor suffix? IQuantumExecutor, IQirExecutor, etc. (Although technically they're executed by the Azure service itself, but the interfaces can schedule execution.)

@swernli
Copy link
Collaborator

swernli commented Apr 15, 2021

These classes submit jobs to Azure, but noun form "submitter" is such an awkward word. In a sense, these classes are what allows the program to act as a client of the Azure service, so is there any formulation of "client" that might work here?

@cesarzc
Copy link
Contributor Author

cesarzc commented Apr 15, 2021

I prefer either Submitter or Executor, the former doesn't sound that awkward to me, than Client because it is a very overloaded term.

@cesarzc
Copy link
Contributor Author

cesarzc commented Apr 15, 2021

@SamarSha, @swernli renamed the folder to Submitters but didn't rename the interfaces since they are public.

@bamarsha
Copy link
Contributor

Do we always want to keep the *Machine suffix, or transition to a *Submitter suffix in the future?

@cesarzc
Copy link
Contributor Author

cesarzc commented Apr 15, 2021

Personally, I think it would be great for us to transition to the *Submitter suffix in the future.

@bamarsha
Copy link
Contributor

Should new interfaces use the existing *Machine suffix for consistency, or the new *Submitter suffix?

@cesarzc
Copy link
Contributor Author

cesarzc commented Apr 16, 2021

I think the new interfaces should use the *Submitter suffix but I would like hear what is your preference @SamarSha and @swernli

@bamarsha
Copy link
Contributor

I like Submitter more than Machine, since it's more descriptive, so it makes sense to use that for new interfaces. The downside is that it's inconsistent with the existing interface names, but if we plan to eventually transition to the new names (and deprecate the old ones) that problem will go away.

@cesarzc cesarzc merged commit 4eb6171 into main Apr 16, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants