Skip to content

Conversation

vinayswamik
Copy link
Collaborator

@vinayswamik vinayswamik commented Sep 16, 2025

Motivation

This PR focuses on improving the qBraid-Algorithms library by addressing structural issues, enhancing documentation, and correcting functionality.

Summary

  • Restructured code for better organization and readability

    • Updated function names from load_program to generate_program and generate_subroutine to save_to_qasm for consistency across the documentation and implementation.
    • Adjusted example usages in the README and Jupyter notebooks to reflect the new function names.
    • Removed obsolete QASM files related to the algorithms to streamline the codebase.
  • Updated and clarified documentation

    • Enhanced documentation in various modules, including detailed descriptions for available algorithms.
    • Added formulation and algorithm steps to improve clarity and understanding.
    • Updated CSS for documentation styling and added custom styles for better presentation.
    • Included new features and key points in the overview section of the documentation.
  • Fixed functionality errors in existing implementations

Purpose

These changes aim to improve maintainability, usability, and overall consistency within the qBraid-Algorithms library.

Notes

Further changes and improvements will continue to be added to this PR.

@vinayswamik vinayswamik changed the title Update README.md Refactor: Restructure qBraid-Algorithms, update docs, and fix functionality Sep 16, 2025
@vinayswamik vinayswamik self-assigned this Sep 16, 2025
**Transformation**: The IQFT is the inverse of the QFT, transforming an :math:`n`-qubit
state from the Fourier basis back to the computational basis:
:math:`\\text{IQFT}|j\\rangle = \\frac{1}{\\sqrt{2^n}} \\sum_{k=0}^{2^n-1}
Copy link
Member

Choose a reason for hiding this comment

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

Can you double check this formulation?

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