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.

Sign up for GitHub

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

Jump to bottom

Docs: structure + updates #980

Merged
merged 13 commits into from
Oct 3, 2023
Merged

Docs: structure + updates #980

merged 13 commits into from
Oct 3, 2023

Conversation

IceKhan13
Copy link
Member

@IceKhan13 IceKhan13 commented Sep 27, 2023 •
edited
Loading

Summary

Documentation updates

Details and comments

TODOs based on user feedback:

  • About Quantum Serverless
  • Installation
  • Preinstallation
    • pip install quantum-serverless in your local environment
    • If you want to deploy on your own infrastructure, link out to deployment info
  • Getting Started
    • Running a program remotely. this only shows how to create program, save results, use jupyter widget to visualize job status, placeholder for credentials “token=…”, “host=…” for remote infrastructure, “warning” that everything in your working directory is shipped out remotely
    • Running your program (reorder examples to the following:)
    • Passing input arguments to your program
    • Using python packages with programs
    • Parallel workflows in programs
    • Retrieving results from old programs
  • Example programs
    • VQE
      • link to the source program file from the notebook
    • QAOA
      • link to the source program file from the notebook
      • this is missing the final Sampler call to get the optimal solution. See this example.
  • Migration guides
    • Converting from Qiskit Runtime programs
  • Deployment

@IceKhan13 IceKhan13 added the documentation Improvements or additions to documentation label Sep 27, 2023
@IceKhan13 IceKhan13 added this to the 0.7 milestone Sep 27, 2023
@IceKhan13 IceKhan13 marked this pull request as ready for review September 28, 2023 20:58
@IceKhan13
Copy link
Member Author

Whaaaa?! 🤔

Error response from daemon: Get "https://registry-1.docker.io/v2/": net/http: request canceled (Client.Timeout exceeded while awaiting headers)

@psschwei
Copy link
Collaborator

that happens very infrequently (usually a network flake or flicker)... I just reran the test and I'd assume this time should be fine (:crossed_fingers: )

@psschwei
Copy link
Collaborator

psschwei commented Sep 28, 2023 •
edited
Loading

hmm... Just had it fail pulling r4 locally, but then succeeded the next time...

$ docker pull bitnami/keycloak:20.0.5-debian-11-r4
20.0.5-debian-11-r4: Pulling from bitnami/keycloak
Get "https://registry-1.docker.io/v2/bitnami/keycloak/manifests/sha256:3cd9558d458d583e0c3b22918f5b194d75d2d89c2091d68b06e6d74ec4a5bda9": EOF

$ docker pull bitnami/keycloak:20.0.5-debian-11-r4
20.0.5-debian-11-r4: Pulling from bitnami/keycloak
Digest: sha256:f0b821c44296b2461331cce1b0abbbff9c284bb6a037b8ccde8bbea4fe23ec3f
Status: Downloaded newer image for bitnami/keycloak:20.0.5-debian-11-r4
docker.io/bitnami/keycloak:20.0.5-debian-11-r4

hopefully it stops flaking soon...

@psschwei
Copy link
Collaborator

psschwei commented Sep 28, 2023 •
edited
Loading

btw, this images is ooooooold (20.0.5-debian-11-r4 was last pushed 7 months ago...)

22.0.3-debian-11-r14 is the most recent tag... maybe we should bump the tag in the compose / helm files?

@caleb-johnson
Copy link
Collaborator

caleb-johnson commented Sep 28, 2023 •
edited
Loading

I'm looking through the built docs as I'm reviewing, and I think I feel strongly that the Running section should be merged into Getting Started. Getting Started can just be the collection of these simple notebooks that feature some basic, fundamental feature of Serverless.

I find the term Running to be vague, and I think merging this leans up things for the better.

Still going through everything, but thought this deserved its own note.

@IceKhan13
Copy link
Member Author

hm , looks like docker registry is not feeling well today 😷

Ok, I will let it sleep tonight and check tomorrow morning :)

@IceKhan13
Copy link
Member Author

I'm looking through the built docs as I'm reviewing, and I think I feel strongly that the Running section should be merged into Getting Started. Getting Started can just be the collection of these simple notebooks that feature some basic, fundamental feature of Serverless.

@caleb-johnson let me know if I need to merge those sections. I have no strong feeling about it. It was just in a feedback doc

@psschwei
Copy link
Collaborator

seems dockerhub is back to playing nice again 😃

@caleb-johnson
Copy link
Collaborator

I'm looking through the built docs as I'm reviewing, and I think I feel strongly that the Running section should be merged into Getting Started. Getting Started can just be the collection of these simple notebooks that feature some basic, fundamental feature of Serverless.

I find the term Running to be vague, and I think merging this leans up things for the better.

Still going through everything, but thought this deserved its own note.

@jenglick , any thoughts on merging these 2 sections?

@caleb-johnson
Copy link
Collaborator

@IceKhan13 , do we have a Quantum Serverless logo? It'd be nice to have something for the thumbnails in our docs. The "NO THUMBNAIL" is just too ugly :P

@IceKhan13
Copy link
Member Author

@caleb-johnson good point :)
I will draw something on a weekend. Turn on my inner designer 😆

@jenglick
Copy link
Collaborator

I'm looking through the built docs as I'm reviewing, and I think I feel strongly that the Running section should be merged into Getting Started. Getting Started can just be the collection of these simple notebooks that feature some basic, fundamental feature of Serverless.
I find the term Running to be vague, and I think merging this leans up things for the better.
Still going through everything, but thought this deserved its own note.

@jenglick , any thoughts on merging these 2 sections?

agreed!

@caleb-johnson
Upstream/docs/update/notebook cleanup (#985)
8f08da6 
* Update one notebook and remove OpenBLAS messages

* Clean up rest of notebooks and BLAS warnings
@caleb-johnson
Remove running directory from docs (#986)
019922a 
* Remove running directory from docs

* Remove reference to deleted directory in docs index file

* Move experimental tutorials to getting_started

* sphinx
@IceKhan13
Copy link
Member Author

IceKhan13 commented Oct 2, 2023 •
edited
Loading

@caleb-johnson your PR #986 merged. Let me know if we can merge this?

@caleb-johnson
Copy link
Collaborator

caleb-johnson commented Oct 2, 2023 •
edited
Loading

@caleb-johnson your PR #986 merged. Let me know if we can merge this?

I'm going to submit 1-2 more PRs to address @jenglick feedback, and then I'll be good :)

@caleb-johnson
Rearrange directories and update Sphinx pages (#987)
909a0d3 
* Rearrange directories and update Sphinx pages

* Update Dockerfile-notebook

* Update README.md
@caleb-johnson
Update Dockerfile-notebook
d069874
@caleb-johnson
Copy link
Collaborator

caleb-johnson commented Oct 2, 2023 •
edited
Loading

@IceKhan13 , any idea why serverless/getting_started/experimental/experimental_running_programs_using_decorators.ipynb cannot find the module serverless/getting_started/experimental/source_files/circuit_utils.py in the CI? I created a couple of subdirectories in the getting_started directory in the jupyter environment, but this import breaks now

This works for me locally. The only thing I can think is that maybe it is looking in some other source_files directory?

@caleb-johnson
Loose ends (#991)
70a886f 
* Add comment about simpler interface in migration guide

* redundant session specification

* Update migration_from_qiskit_runtime_programs.ipynb
@IceKhan13 IceKhan13 merged commit 54c95a4 into main Oct 3, 2023
6 checks passed
@IceKhan13 IceKhan13 deleted the docs/update branch October 3, 2023 13:56
@caleb-johnson caleb-johnson mentioned this pull request Oct 3, 2023
Merged
@psschwei psschwei mentioned this pull request Oct 3, 2023
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@caleb-johnson caleb-johnson caleb-johnson left review comments

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.7
Development

Successfully merging this pull request may close these issues.
4 participants
@IceKhan13 @psschwei @caleb-johnson @jenglick