KEMBAR78
New Tutorial - Divisive Clustering by mawolf2023 · Pull Request #1990 · NVIDIA/cuda-quantum · GitHub
Skip to content

Conversation

@mawolf2023
Copy link
Contributor

Description

I am uploading a new Jupyter notebook tutorial based on this https://arxiv.org/abs/2402.01529 paper focusing on divisive clustering. The tutorial was jointly developed with one of the authors. I placed the notebook in the docs section with all of the other notebooks. This example has a couple of auxiliary files, I created a source folder for them and use wget to grab the files if someone uses the notebook. If anything is placed in the wrong spot or needs to be modified, please let me know.

@copy-pr-bot
Copy link

copy-pr-bot bot commented Jul 22, 2024

This pull request requires additional validation before any workflows can run on NVIDIA's runners.

Pull request vetters can view their responsibilities here.

Contributors can view more details about this message here.

@github-actions
Copy link

github-actions bot commented Jul 22, 2024

CLA Assistant Lite bot All Contributors have signed the CLA.

@bmhowe23
Copy link
Collaborator

bmhowe23 commented Jul 24, 2024

/ok to test

Command Bot: Processing...

@mawolf2023
Copy link
Contributor Author

I have read the Contributor License Agreement and I hereby accept the Terms.

@bmhowe23
Copy link
Collaborator

recheck

@bmhowe23
Copy link
Collaborator

bmhowe23 commented Jul 25, 2024

/ok to test

Command Bot: Processing...

@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jul 25, 2024
@mawolf2023
Copy link
Contributor Author

@bmhowe23 , Thanks so much for this. I just saw the preview and it looks like the LaTeX in the notebooks does not render. And I also noticed the divisive clustering function now shows up a bullet point in the tutorial page, but clicking on it does not open anything so I think we would want that hidden.

Copy link
Collaborator

@bmhowe23 bmhowe23 left a comment

Choose a reason for hiding this comment

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

The current set of commits pass the CI, but the new notebook has to be skipped during the regular per-PR validation since it requires GPUs to execute. In fact, it requires the nvidia-mgpu backend to really run it will rarely get exercised by the CI if we were to merge this PR right now. We should probably discuss what the best path forward is. The options that I can think of are:

  • Leave it as is right now and just know that the CI will not exercise the notebook on a regular basis
  • Remove the nvidia-mgpu dependency to make it run during Deployment (but still not during the per-PR CI)
  • Remove all nvidia target dependencies (somehow?) so that it runs with every PR.

@bmhowe23
Copy link
Collaborator

@bmhowe23 , Thanks so much for this. I just saw the preview and it looks like the LaTeX in the notebooks does not render.

Yeah, the LaTeX doesn't render in the GH docs preview for some reason...that's a known issue. The best way to review it is to run bash scripts/build_docs.sh locally and then view it locally on your machine.

And I also noticed the divisive clustering function now shows up a bullet point in the tutorial page, but clicking on it does not open anything so I think we would want that hidden.

That's strange, it works for me. Maybe we should sync up offline to make sure we're looking at the same thing.

@bmhowe23 bmhowe23 added the documentation Improvements or additions to documentation label Jul 25, 2024
@bmhowe23
Copy link
Collaborator

bmhowe23 commented Jul 25, 2024

/ok to test

Command Bot: Processing...

github-actions bot pushed a commit that referenced this pull request Jul 25, 2024
@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

bmhowe23 added 5 commits July 29, 2024 21:09
* Fix wget to write to specific subdirectory
* Add mpi4py back to requirements list because it isn't in the devdeps
  image
* Bump some package versions to be the same as other versions used by
  other notebooks in this same directory for consistency.
* Fix a misspelling
* Change python --> python3 for script invocations (for devdeps image)
* Check the number of GPUs before attempting the nvidia-mgpu target
@bmhowe23
Copy link
Collaborator

bmhowe23 commented Jul 29, 2024

/ok to test

Command Bot: Processing...

@github-actions
Copy link

CUDA Quantum Docs Bot: A preview of the documentation can be found here.

github-actions bot pushed a commit that referenced this pull request Jul 29, 2024
@bmhowe23
Copy link
Collaborator

bmhowe23 commented Aug 5, 2024

/ok to test

Command Bot: Processing...

Copy link
Collaborator

@bmhowe23 bmhowe23 left a comment

Choose a reason for hiding this comment

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

Thanks, Mark!

@bmhowe23 bmhowe23 enabled auto-merge (squash) August 5, 2024 22:54
@bmhowe23 bmhowe23 merged commit 9337b7c into NVIDIA:main Aug 6, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Aug 6, 2024
@bettinaheim bettinaheim added this to the release 0.9.0 milestone Nov 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants