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

Client + docs: rename Program #1057

Merged
merged 4 commits into from
Oct 27, 2023
Merged

Conversation

IceKhan13
Copy link
Member

Summary

Client + docs: rename Program

@IceKhan13 IceKhan13 force-pushed the chore/rename-program-to-pattern branch from f545d87 to fc28254 Compare October 27, 2023 17:58
@IceKhan13 IceKhan13 closed this Oct 27, 2023
@IceKhan13 IceKhan13 force-pushed the chore/rename-program-to-pattern branch from fc28254 to 4011d6a Compare October 27, 2023 19:09
@IceKhan13 IceKhan13 deleted the chore/rename-program-to-pattern branch October 27, 2023 19:11
@IceKhan13 IceKhan13 restored the chore/rename-program-to-pattern branch October 27, 2023 19:14
@IceKhan13 IceKhan13 reopened this Oct 27, 2023
@IceKhan13 IceKhan13 marked this pull request as ready for review October 27, 2023 20:30
@IceKhan13 IceKhan13 added the documentation Improvements or additions to documentation label Oct 27, 2023
Copy link
Collaborator

@psschwei psschwei left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should this also get tagged as a feature branch? there's a new class being added / an old one being deprecated, so technically ... (?)

"job"
]
},
{
"cell_type": "code",
"execution_count": 7,
"execution_count": null,
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

do you want to execute this cell? (think there might also one other in this notebook that wasn't executed...)

Copy link
Member

@Tansito Tansito left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I left a couple of comments and I found a couple of references in the documentation that maybe we can review but I would merge it and do next week another pass, what do you think, @IceKhan13 ?


# create program
program = Program(
program = QiskitPattern(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we rename variable program to pattern too?

pattern = QiskitPattern(

@@ -166,11 +168,13 @@ def run(self, program: Program, arguments: Optional[Dict[str, Any]] = None):
)
return Job(job_id=job_id, job_client=self)

def upload(self, program: Program):
def upload(self, program: QiskitPattern):
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This can a breaking change so it's a bit tricky but should we call it pattern?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can you overload functions in python? (i.e. have one that takes a program and mark it deprecated and another that takes a pattern)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

good question!

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

seems like answer is no (though there are a few workarounds if you search around on the topic...)

@IceKhan13
Copy link
Member Author

Should this also get tagged as a feature branch? there's a new class being added / an old one being deprecated, so technically ... (?)

This is more of a docs change + name alias. It does not change any functionality

@IceKhan13
Copy link
Member Author

We will follow with updates in next PR :)

@IceKhan13 IceKhan13 merged commit e60d0ee into main Oct 27, 2023
6 checks passed
@IceKhan13 IceKhan13 deleted the chore/rename-program-to-pattern branch October 27, 2023 21:15
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

Successfully merging this pull request may close these issues.

3 participants