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

Adding new documentation for the local mode to run the AI-powered transpiler passes #2273

Open
wants to merge 21 commits into
base: main
Choose a base branch
from

Conversation

cbjuan
Copy link
Member

@cbjuan cbjuan commented Nov 8, 2024

Fixes #2257

To be merged by 13 Nov 2024

@qiskit-bot
Copy link
Contributor

One or more of the following people are relevant to this code:

@cbjuan cbjuan requested review from beckykd and jyu00 and removed request for beckykd November 8, 2024 17:56
Copy link
Collaborator

@beckykd beckykd left a comment

Choose a reason for hiding this comment

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

LGTM! Just some editorial suggestions!

docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
coupling_map=fez_coupling_map,
ai_optimization_level=3,
optimization_level=3,
ai_layout_mode=optimize,
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is optimize supposed to be a string literal or a variable? If the latter, it's not defined. Also, can I set local_mode here?

Copy link
Member Author

Choose a reason for hiding this comment

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

Good catch, thanks. Fixed in ee25720

ai_su2_transpiled_circuit = ai_transpiler_pass_manager.run(su2_circuit),
```

The following options are used:
Copy link
Collaborator

Choose a reason for hiding this comment

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

Does this mean these are the options used in the code example, or these options are available? Also should link to API reference.

Copy link
Member Author

@cbjuan cbjuan Nov 12, 2024

Choose a reason for hiding this comment

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

Added the link to the API reference in aa8575f


The following options are used:
* `coupling_map` - Specifies which coupling map to use for the transpilation.
* `ai_optimization_level` - Specifies the level of optimization (1-3) to use for the AI components of the PassManager.
Copy link
Collaborator

Choose a reason for hiding this comment

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

Is ai_optimization_level also a new option for TranspilerService?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, it's only available for this passmanager

docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
* `optimization_level` - Specifies the optimization to use for the Qiskit heuristic algorithms.
* `ai_layout_mode` - Specifies how the AI routing part of the PassManager handles the layout.

Refer to the #AI-routing-pass section to review the configuration options for this parameter.
Copy link
Collaborator

Choose a reason for hiding this comment

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

What parameter?

Copy link
Member Author

Choose a reason for hiding this comment

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

It has a line break that shouldn't be there. Fixed in aa8575f

Copy link
Collaborator

@jyu00 jyu00 left a comment

Choose a reason for hiding this comment

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

Some minor comments but overall looks good. I'd feel better if @beckykd can review the suggestions I gave though 😅

docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
docs/guides/ai-transpiler-passes.mdx Outdated Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: No status
Development

Successfully merging this pull request may close these issues.

Update the documentation about the AI-powered transpiler passes to include information about the local mode
5 participants