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

Move Shor proofs to a separate repository #43

Open
khieta opened this issue Jul 8, 2022 · 4 comments
Open

Move Shor proofs to a separate repository #43

khieta opened this issue Jul 8, 2022 · 4 comments
Assignees
Labels
documentation Improve organization or documentation

Comments

@khieta
Copy link
Member

khieta commented Jul 8, 2022

It would be cleaner to have the Shor proof (currently in examples/shor) in a separate repository. It is the largest application of SQIR, aside from VOQC, and it has different dependencies from the rest of SQIR (euler and coq-interval). We should also update the Shor proofs to use the modular multiplier defined in VQO instead of the old ModMult.v and RCIR.v files.

My proposal: make a new repository called SQIR-shor that contains the current content of examples/shor. This repository will need to link the SQIR, VQO, and euler repositories as submodules. It might take some effort to get the build working.

Open to opinions.

@rnrand
Copy link
Member

rnrand commented Jul 8, 2022

VOQC is by far the largest SQIR application, and I'd personally say that it makes even more sense to have as its own repo. On the other hand, there are far larger repositories than SQIR (or even SQIR+VQO+QuantumLib or everything in INQWIRE), and I'm not convinced that the proliferation of small dependent libraries makes anyone's life easier. All things equal, I'd just leave things as they are.

(And installing packages like Interval seem like far less overhead than it once was.)

That said, if @PicksPeng wants to split off and maintain Shor as a separate library, I wouldn't object too much. I would recommend keeping it in INQWIRE and under an MIT license, though. (I can create the new repo if needed.)

@khieta
Copy link
Member Author

khieta commented Jul 8, 2022

Like I said, I'm open to other opinions.

The main issue is that if we update the Shor proofs to use the VQO oracles (which we should!) then we would need to move VQO back inside of SQIR, which I'd prefer not to do because it will make SQIR larger and harder to maintain. Aesthetically, I prefer more smaller repos over one large repo.

@rnrand
Copy link
Member

rnrand commented Jul 8, 2022

I was just thinking, maybe make VQO and Shor top level in the SQIR repo?

Maintaining Shor will be tricky anyway, given its dependencies.

@khieta khieta added the documentation Improve organization or documentation label Jul 8, 2022
@PicksPeng
Copy link
Collaborator

I'm open to this idea. I don't think the additional organizing work is very worthwhile for the time consumption. I love the idea of using the VQO oracles, but I'm not very familiar with the VQO codebase so maybe @liyili2 can take a look at this part. I think the current codebase is well-organized compared to many other famous projects and is small enough to maintain.

caldwellb added a commit that referenced this issue May 9, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improve organization or documentation
Projects
None yet
Development

No branches or pull requests

4 participants