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

Minor update to dataset docs to lead users to quickstart and list_datasets #5484

Merged
merged 6 commits into from
Jun 20, 2024
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions doc/introduction/data.rst
Original file line number Diff line number Diff line change
Expand Up @@ -97,12 +97,12 @@ use them directly in a PennyLane circuits as follows:
>>> print(circuit())
-1.0791430411076344

Dataset Structure
-----------------
Viewing Available Datasets
--------------------------

You can call the
We can call the
:func:`~pennylane.data.list_datasets` function to get a snapshot of the currently available data.
This function returns a nested dictionary as we show below.
This function returns a nested dictionary as shown below.

>>> available_data = qml.data.list_datasets()
>>> available_data.keys()
Expand Down Expand Up @@ -152,6 +152,9 @@ We can then write this :class:`~pennylane.data.Dataset` to storage and read it a
>>> read_dataset.energies
array([-1.5, -0.5, 0.5, 1.5])

For more details on reading and writing custom datasets, including metadata, please
see the :mod:`~.data` subpackage documentation.
DSGuala marked this conversation as resolved.
Show resolved Hide resolved

:html:`<div class="summary-table">`

Quantum Datasets Functions and Classes
Expand Down
4 changes: 4 additions & 0 deletions doc/releases/changelog-dev.md
Original file line number Diff line number Diff line change
Expand Up @@ -301,6 +301,9 @@
* The computational basis convention used for `qml.measure` — 0 and 1 rather than ±1 — has been clarified in its docstring.
[(#5474)](https://github.com/PennyLaneAI/pennylane/pull/5474)

* The text in the `qml.data` module and datasets quickstart have been slightly modified to lead to the quickstart first and highlight `list_datasets`.
[(5484)](https://github.com/PennyLaneAI/pennylane/pull/5484)

<h3>Bug fixes 🐛</h3>

* The probabilities now sum to one using the `torch` interface with `default_dtype` set to `torch.float32`.
Expand Down Expand Up @@ -367,6 +370,7 @@ Astral Cai,
Isaac De Vlugt,
Amintor Dusko,
Pietropaolo Frisoni,
Diego Guala,
Soran Jahangiri,
Korbinian Kottmann,
Christina Lee,
Expand Down
2 changes: 1 addition & 1 deletion pennylane/data/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@

.. note::

For more details on using datasets, please see the
To start using datasets, please first see the
:doc:`quantum datasets quickstart guide </introduction/data>`.

Overview
Expand Down
Loading