Skip to content

Commit

Permalink
Add provider note (#990)
Browse files Browse the repository at this point in the history
  • Loading branch information
caleb-johnson authored Oct 2, 2023
1 parent 29a7d2a commit 45aede9
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 10 deletions.
10 changes: 9 additions & 1 deletion docs/getting_started/basic/01_running_program.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,14 @@
"import os"
]
},
{
"cell_type": "markdown",
"id": "7ac24f62-8487-47fb-9805-66f2192953d4",
"metadata": {},
"source": [
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
"cell_type": "code",
"execution_count": 2,
Expand Down Expand Up @@ -273,7 +281,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
9 changes: 8 additions & 1 deletion docs/getting_started/basic/02_arguments_and_results.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,13 @@
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
"cell_type": "code",
"execution_count": 3,
Expand Down Expand Up @@ -205,7 +212,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.13"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
9 changes: 8 additions & 1 deletion docs/getting_started/basic/03_dependencies.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -80,6 +80,13 @@
")"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
"cell_type": "code",
"execution_count": 2,
Expand Down Expand Up @@ -188,7 +195,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.13"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
9 changes: 8 additions & 1 deletion docs/getting_started/basic/04_distributed_workloads.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,13 @@
"Essentially, this program reads the circuits from the program arguments, executes the `distributed_sample` function on each circuit in parallel, collects the results from the function executions, and saves the results."
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
"cell_type": "code",
"execution_count": 1,
Expand Down Expand Up @@ -220,7 +227,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.13"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
6 changes: 4 additions & 2 deletions docs/getting_started/basic/05_retrieving_past_results.ipynb
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,9 @@
"id": "37322958-a029-46bb-bc46-82b7ded329b5",
"metadata": {},
"source": [
"First, create [Provider](https://qiskit-extensions.github.io/quantum-serverless/stubs/quantum_serverless.core.Provider.html#quantum_serverless.core.Provider) and [QuantumServerless](https://qiskit-extensions.github.io/quantum-serverless/stubs/quantum_serverless.QuantumServerless.html#quantum_serverless.QuantumServerless) instances."
"First, create [Provider](https://qiskit-extensions.github.io/quantum-serverless/stubs/quantum_serverless.core.Provider.html#quantum_serverless.core.Provider) and [QuantumServerless](https://qiskit-extensions.github.io/quantum-serverless/stubs/quantum_serverless.QuantumServerless.html#quantum_serverless.QuantumServerless) instances.\n",
"\n",
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
Expand Down Expand Up @@ -238,7 +240,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.13"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,9 @@
"> Limitations:\n",
"> - only `tar` files are supported\n",
"> - `tar` file should be saved in `/data` directory during your program execution to be visible by `.files()` method call\n",
"> - only `/data` directory is supported, `/data/other_folder` will not be visible"
"> - only `/data` directory is supported, `/data/other_folder` will not be visible\n",
"\n",
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
Expand Down Expand Up @@ -186,7 +188,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,8 @@
"> 1. functions decorated with distribute_program, can only accept named arguments for now. E.g do not use `my_program(argument1)`, instead specify name of the argument `my_program(argument1=argument1)`\n",
"> 2. function return will run `quantum_serverless.save_result` function under the hood, which means return values must be json serializable values in form of dictionary (with values as all Python native types, like strings, lists, dicts, `numpy` arrays, `QuantumCircuit`, `Operator`, etc.)\n",
"> 3. when using local folder/modules user must specify `working_dir` as `./` (current folder), which will be archiving and sending content of entire folder for remote execution. Make sure that folder does not have large files. \n",
"\n"
"\n",
"> ⚠ This provider is set up with default credentials to a test cluster intended to run on your machine. For information on setting up infrastructure on your local machine, check out the guide on [local infrastructure setup](https://qiskit-extensions.github.io/quantum-serverless/deployment/local.html)."
]
},
{
Expand Down Expand Up @@ -293,7 +294,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.9.16"
"version": "3.10.13"
}
},
"nbformat": 4,
Expand Down

0 comments on commit 45aede9

Please sign in to comment.