Skip to content

Adding entry points for desired functions#2481

Merged
isaacdevlugt merged 25 commits intomainfrom
entry-points
Mar 13, 2026
Merged

Adding entry points for desired functions#2481
isaacdevlugt merged 25 commits intomainfrom
entry-points

Conversation

@isaacdevlugt
Copy link
Copy Markdown
Contributor

@isaacdevlugt isaacdevlugt commented Feb 12, 2026

Context: This PR will add entry points in Catalyst for functionality that is implemented in Catalyst only, making it so that the user can access these functions from PennyLane instead.

Description of the Change: Adds entry points to several functions

Benefits: Scalable docs

Possible Drawbacks:

Related: PennyLaneAI/pennylane#9020

sc-113789

Comment thread setup.py Outdated
@isaacdevlugt
Copy link
Copy Markdown
Contributor Author

NB: docstrings in the passes module need to be updated to what is currently in pennylane.transforms:latest

@isaacdevlugt
Copy link
Copy Markdown
Contributor Author

Sorry I should have opened this as a draft 😬. Whoops!

@isaacdevlugt isaacdevlugt added do-not-merge docs Pull requests that update the docs labels Feb 12, 2026
@isaacdevlugt isaacdevlugt changed the title Adding entry points for desired functions [Do not merge] Adding entry points for desired functions Feb 12, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 20, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 96.89%. Comparing base (7e41efe) to head (f0cc2e4).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2481      +/-   ##
==========================================
- Coverage   96.89%   96.89%   -0.01%     
==========================================
  Files         155      155              
  Lines       16922    16917       -5     
  Branches     1616     1616              
==========================================
- Hits        16397    16392       -5     
  Misses        390      390              
  Partials      135      135              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Comment thread frontend/catalyst/passes/builtin_passes.py Outdated
Comment thread setup.py Outdated
Comment thread setup.py
Comment thread frontend/catalyst/passes/builtin_passes.py Outdated
@isaacdevlugt isaacdevlugt changed the title [Do not merge] Adding entry points for desired functions Adding entry points for desired functions Feb 27, 2026
Comment thread frontend/catalyst/python_interface/inspection/draw.py
Comment thread frontend/catalyst/passes/builtin_passes.py Outdated
@isaacdevlugt isaacdevlugt requested a review from dime10 March 4, 2026 15:59
Comment thread frontend/catalyst/passes/builtin_passes.py Outdated
Comment thread setup.py
**Context:** The base branch allows for compilation passes (like
`disentangle_cnot` and `disentangle_swap`) in Catalyst to be callable
from PennyLane.

**Description of the Change:** Entry points for `disentangle_cnot`,
`disentangle_swap`, docs updates to `disentangle_cnot` and
`disentangle_swap`, and change the names of `disentangle_cnot` and
`disentangle_swap` to use all lower-case kebab style.

**Benefits:**

**Possible Drawbacks:**

**Related GitHub PR:**
PennyLaneAI/pennylane#9133
@isaacdevlugt
Copy link
Copy Markdown
Contributor Author

The code examples need to be updated to use the specs changes (level ordering + tabular output) ‼️

@isaacdevlugt isaacdevlugt requested a review from dime10 March 13, 2026 18:09
Comment thread frontend/catalyst/passes/builtin_passes.py Outdated
Copy link
Copy Markdown
Contributor

@andrijapau andrijapau left a comment

Choose a reason for hiding this comment

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

Thanks for walking me through the changes and demoing the feature @isaacdevlugt 🎉

Looks good to me. :letsgo:

Comment thread frontend/catalyst/passes/pass_api.py
@isaacdevlugt isaacdevlugt merged commit 9371826 into main Mar 13, 2026
38 checks passed
@isaacdevlugt isaacdevlugt deleted the entry-points branch March 13, 2026 20:46
github-merge-queue Bot pushed a commit to PennyLaneAI/pennylane that referenced this pull request Apr 10, 2026
**Context:** We have functions that live in all sorts of namespaces, and
their documentation lives in different places. We need to have a better
one-stop-shop for consulting our documentation for these functions
(particularly, transforms). Additionally, there are many features in the
Catalyst frontend that need to be exposed to the PL frontend while
making sure that there is one source of truth for documenting these
functions that renders both on Catalyst's and PL's documentation pages.

**Description of the Change:**

- Entry-point infra in PennyLane for several Catalyst passes and
`draw_graph` (related:
PennyLaneAI/catalyst#2481)
- Removal of all source code in PennyLane pertaining to passes that are
only defined by an empty (or nearly empty) `setup_inputs` function and
then a `pass_name` (e.g., PBC passes and `disentangle_cnot/swap`)
- Added `Usage with qjit` sections in some functions that must have
separate documentation in PennyLane and Catalyst (e.g.,
`cancel_inverses`)
- Added section to development guide
- Docs-related GitHub workflows now install the nightly Catalyst build
on TestPyPi

**Benefits:** Better documentation standards and single source of truth

**Possible Drawbacks:**

**Related GitHub Issues:**
[sc-113798](https://app.shortcut.com/xanaduai/story/113798/infrastructure-for-entry-points-coming-from-catalyst)

---------

Co-authored-by: andrijapau <andrija.paurevic@xanadu.ai>
Co-authored-by: Andrija Paurevic <46359773+andrijapau@users.noreply.github.com>
Co-authored-by: Gabriela Sánchez Díaz <gsdiaz21@gmail.com>
Co-authored-by: Diego <67476785+DSGuala@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do-not-merge docs Pull requests that update the docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants