Skip to content

Conversation

@isaacdevlugt
Copy link
Contributor

@isaacdevlugt isaacdevlugt commented Nov 27, 2025

Context:

  • Some parts of the xDSL API can start to be more exposed, which requires documentation
  • Our transforms API documentation is scattered all over the place. We want a singular source of truth that hosts applicable transforms no matter where they live under the hood.

Description of the Change:

This PR will aim to do two things:

  • Ensure that applicable functions in the unified compiler work are properly documented in PennyLane (there will be an adjacent PR opened in Catalyst as well)
  • Create (or revamp) a documentation page that will host every optimization transform available in our stack (including Catalyst). "Optimization transforms" are transforms that make the circuit more efficient given constraints, but doesn’t change the user output.

Benefits: 🤑

Possible Drawbacks: 🤷

Related SC Epic: https://app.shortcut.com/xanaduai/epic/92676

@github-actions
Copy link
Contributor

Hello. You may have forgotten to update the changelog!
Please edit doc/releases/changelog-dev.md with:

  • A one-to-two sentence description of the change. You may include a small working example for new features.
  • A link back to this PR.
  • Your name (or GitHub username) in the contributors section.

@isaacdevlugt isaacdevlugt changed the title initial Unified Compiler documentation Nov 27, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants