Merge the demo branch into master #319
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| sf.api | ||
| ====== | ||
|
|
||
| .. currentmodule:: strawberryfields.api | ||
|
|
||
| .. warning:: | ||
|
|
||
| Unless you are a Strawberry Fields developer, you likely do not need | ||
| to use these classes directly. | ||
|
|
||
| .. automodapi:: strawberryfields.api | ||
| :no-heading: | ||
| :no-inheritance-diagram: | ||
| :include-all-objects: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,133 @@ | ||
| sf.cli | ||
| ====== | ||
|
|
||
| .. currentmodule:: strawberryfields.cli | ||
|
|
||
| The Strawberry Fields command line program ``sf`` provides several utilities | ||
| including: | ||
|
|
||
| * ``sf configure [--token] [--local]``: configure the connection to the cloud platform | ||
|
|
||
| * ``sf run input [--output FILE]``: submit and execute quantum programs from the command line | ||
|
|
||
| * ``sf --ping``: verify your connection to the Xanadu cloud platform | ||
|
|
||
|
|
||
|
|
||
| Configure | ||
| --------- | ||
|
|
||
| Using the ``sf configure`` command to create a configuration file on Linux: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ sf configure --token MYAUTH | ||
|
There was a problem hiding this comment. Mentioned elsewhere, but users might not know what "MYAUTH" is |
||
| $ cat ~/.config/strawberryfields/config.toml | ||
| [api] | ||
| authentication_token = "MYAUTH" | ||
|
There was a problem hiding this comment. See my question elsewhere about how best to indicate output of terminal in a code block |
||
| hostname = "platform.strawberryfields.ai" | ||
| use_ssl = true | ||
| port = 443 | ||
|
|
||
| Using the ``sf configure`` command to create a configuration file on Windows: | ||
|
|
||
| .. code-block:: ps1con | ||
|
|
||
| C:\> sf configure --token MYAUTH | ||
| C:\> cat C:\Users\USERNAME\AppData\Local\Xanadu\strawberryfields\config.toml | ||
|
Comment on lines
+34
to
+37
There was a problem hiding this comment. Thanks, this looks pretty! :) There was a problem hiding this comment. Note, I couldn't get this to work! The powershell prompt is actually PS C:\> sf configure --token MYAUTHbut Sphinx gives a warning when I include the PS :( Also, the syntax highlighting doesn't seem to work either. There was a problem hiding this comment. I'll give this a look from the simple command line of Windows and then maybe we could omit There was a problem hiding this comment. Works fine with the standard command line as well! (Was using the Anaconda Prompt) There was a problem hiding this comment. Should the There was a problem hiding this comment. Is there any particular reason why powershell is chosen as the "default" windows shell? Although I like powershell, I'm not sure if it's actually the default/most commonly used shell in Windows, but I might be wrong about that (it seems like Windows 10 set powershell as default a few years ago, but I'm not sure that's still the case since cmd is still very prevalent and powershell works quite a bit different from e.g. bash). There was a problem hiding this comment. Also, There was a problem hiding this comment. Good points - let's change to |
||
| [api] | ||
| authentication_token = "MYAUTH" | ||
| hostname = "platform.strawberryfields.ai" | ||
| use_ssl = true | ||
| port = 443 | ||
|
|
||
| **Flags:** | ||
|
|
||
| * ``--token``: the authentication token to use | ||
|
|
||
| * ``--local``: whether or not to create the configuration file locally in the current directory | ||
|
|
||
|
|
||
| If not provided, the configuration file will be saved in the user's configuration directory. | ||
|
|
||
| Configuration wizard | ||
| ~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| For more advanced configuration options, the configuration wizard can be used. | ||
|
|
||
| Here we show how the interactive wizard can be used to configure each API | ||
| option. Once done, we have a look at the newly created configuration file. | ||
|
|
||
| Example run in a Linux-based operating system: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ sf configure | ||
| Please enter the authentication token to use when connecting: [] MYAUTH | ||
| Please enter the hostname of the server to connect to: [platform.strawberryfields.ai] MYHOST | ||
| Should the client attempt to connect over SSL? [y] N | ||
| Please enter the port number to connect with: [443] 12345 | ||
|
|
||
| $cat ~/.config/strawberryfields/config.toml | ||
| [api] | ||
| authentication_token = "MYAUTH" | ||
| hostname = "MYHOST" | ||
| use_ssl = false | ||
| port = "12345" | ||
|
|
||
| The same example run on a Windows operating system: | ||
|
|
||
| .. code-block:: ps1con | ||
|
|
||
|
|
||
| C:\> sf configure | ||
|
|
||
| Please enter the authentication token to use when connecting: [] MYAUTH | ||
| Please enter the hostname of the server to connect to: [platform.strawberryfields.ai] MYHOST | ||
| Should the client attempt to connect over SSL? [y] N | ||
| Please enter the port number to connect with: [443] 12345 | ||
|
|
||
| C:\> cat C:\Users\USERNAME\AppData\Local\Xanadu\strawberryfields\config.toml | ||
|
|
||
| [api] | ||
| authentication_token = "MYAUTH" | ||
| hostname = "MYHOST" | ||
| use_ssl = false | ||
| port = "12345" | ||
|
|
||
| Testing your connection | ||
| ----------------------- | ||
|
|
||
| To test that your account credentials correctly authenticate against the cloud platform, the ``ping`` flag can be used: | ||
|
|
||
| .. code-block:: bash | ||
|
|
||
| $ sf --ping | ||
| You have successfully authenticated to the platform! | ||
|
|
||
| Submitting jobs | ||
| --------------- | ||
|
|
||
| To execute a Blackbird ``.xbb`` file from the command line, the ``sf run`` command | ||
| line program can be used: | ||
|
|
||
| .. code-block:: console | ||
|
|
||
| sf run test.xbb --output out.txt | ||
|
|
||
| After executing the above command, the result will be stored in ``out.txt`` | ||
| in the current working directory. | ||
| You can also omit the ``--output`` parameter to print the result to the screen. | ||
|
|
||
| Functions | ||
| --------- | ||
|
Comment on lines
+122
to
+123
There was a problem hiding this comment. I don't know why, but I get a There was a problem hiding this comment. Also noticed a few other errors upon making the docs, e.g., There was a problem hiding this comment. Weird 🤔 Works fine for me |
||
|
|
||
| .. warning:: | ||
|
|
||
| Unless you are a Strawberry Fields developer, you likely do not need | ||
| to access the functions in this module directly. | ||
|
|
||
| .. automodapi:: strawberryfields.cli | ||
| :no-heading: | ||
| :no-inheritance-diagram: | ||
| :skip: store_account, create_config, load, RemoteEngine, Connection, ConfigurationError | ||
|
There was a problem hiding this comment. A lot of duplicate content shared between this file and There was a problem hiding this comment. Agree, I would like to address this with an overhaul of config.rst, cli.rst, and remote.rst |
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| sf.configuration | ||
| ================ | ||
|
|
||
| .. currentmodule:: strawberryfields.configuration | ||
|
|
||
| .. warning:: | ||
|
|
||
| Unless you are a Strawberry Fields developer, you likely do not need | ||
| to access this module directly. | ||
|
|
||
| See the :doc:`/introduction/configuration` page for more information on | ||
| configuring Strawberry Fields. | ||
|
|
||
| .. automodapi:: strawberryfields.configuration | ||
| :no-heading: | ||
| :skip: user_config_dir | ||
| :no-inheritance-diagram: |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| Release notes | ||
| ------------- | ||
|
|
||
| This page contains the release notes for Strawberry Fields. | ||
|
|
||
| .. mdinclude:: ../../.github/CHANGELOG.md |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
(Edit1: Got my answer later 😄
Edit2: but then got confused again 😅 )
Will support for TF 1 be discontinued completely?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep! The TF1.3 backend was too outdated (current release is 1.17 I think), and no longer works well with Python 3.7+. To keep TF 1.X support, we would need to upgrade the TF1.3 backend to TF1.17, which is not worth it.