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

Update README positioning for researchers #6411

Merged
merged 49 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
49 commits
Select commit Hold shift + click to select a range
fbaa4bd
Update README.md
justinpickering Oct 17, 2024
d115949
Update keyfeatures
justinpickering Oct 17, 2024
dbe9ec7
Update README.md
justinpickering Oct 17, 2024
938c569
update key features copy
justinpickering Oct 17, 2024
88eae76
Update Demos section
justinpickering Oct 17, 2024
8cdd1c6
add research applications section, remove videos
justinpickering Oct 17, 2024
ce79c92
update research applications section
justinpickering Oct 18, 2024
439ff4a
update Getting started section
justinpickering Oct 18, 2024
60ed710
Update README.md
justinpickering Oct 18, 2024
b999c3a
add devices page link
justinpickering Oct 18, 2024
72ff2a9
Update README.md
justinpickering Oct 18, 2024
5184377
Update README.md
justinpickering Oct 18, 2024
989302d
revert back to previous Compilation key features description
justinpickering Oct 18, 2024
98673ef
update discussion forum copy
justinpickering Oct 21, 2024
4b6f93c
update copy (developer hub -> Development guide)
justinpickering Oct 21, 2024
1265b99
Merge branch 'master' into readme-update
justinpickering Oct 29, 2024
5334ceb
update Docker support copy [sc-76898]
justinpickering Oct 30, 2024
768ebd5
Update README.md
justinpickering Oct 30, 2024
c33e591
reverse order of QML and QAlgo section
justinpickering Oct 30, 2024
bec6408
Update README.md
justinpickering Oct 30, 2024
f24b93b
Update README.md
justinpickering Oct 30, 2024
6c74606
Update README.md
justinpickering Oct 30, 2024
7ec92d2
Update README.md
justinpickering Oct 30, 2024
6840362
typo fix
justinpickering Oct 30, 2024
3ff33fc
Update README.md
justinpickering Nov 6, 2024
57fc703
Update README.md
justinpickering Nov 6, 2024
f9e724f
Update README.md
justinpickering Nov 6, 2024
c9fe797
Update README.md
justinpickering Nov 6, 2024
53d29a1
Add files via upload
justinpickering Nov 6, 2024
22c0117
update image link for preview
justinpickering Nov 6, 2024
6e75929
Add files via upload
justinpickering Nov 6, 2024
ab6eacf
Add files via upload
justinpickering Nov 6, 2024
77bfe29
Update README.md
justinpickering Nov 6, 2024
fda5eef
Add files via upload
justinpickering Nov 6, 2024
b71cc2f
update 'getting started' image
justinpickering Nov 6, 2024
8d5a964
update getting started image width
justinpickering Nov 6, 2024
f1e9873
point image preview back to master
justinpickering Nov 6, 2024
fc14b20
Merge branch 'master' into readme-update
justinpickering Nov 6, 2024
d06334a
Merge branch 'master' into readme-update
justinpickering Nov 7, 2024
0118a18
Update README.md
justinpickering Nov 7, 2024
8eae8ba
Update README.md
justinpickering Nov 7, 2024
4617682
Add files via upload
justinpickering Nov 7, 2024
7a424cf
Update README.md
justinpickering Nov 7, 2024
e309c16
Update README.md
justinpickering Nov 7, 2024
b9dd095
Update README.md
justinpickering Nov 7, 2024
43f3a2d
revert PL image
justinpickering Nov 8, 2024
31ee87a
Add files via upload
justinpickering Nov 8, 2024
7e433d2
Merge branch 'master' into readme-update
justinpickering Nov 8, 2024
4c00410
Merge branch 'master' into readme-update
albi3ro Nov 8, 2024
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
80 changes: 41 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
</p>

<p align="center">
<strong>Train a quantum computer the same way as a neural network.</strong>
The definitive open-source framework for quantum programming. Built by researchers, for research.
<img src="https://raw.githubusercontent.com/PennyLaneAI/pennylane/master/doc/_static/header.png#gh-light-mode-only" width="700px">
justinpickering marked this conversation as resolved.
Show resolved Hide resolved
<!--
Use a relative import for the dark mode image. When loading on PyPI, this
Expand All @@ -47,23 +47,23 @@

<img src="https://raw.githubusercontent.com/PennyLaneAI/pennylane/master/doc/_static/code.png" width="400px" align="right">

- *Machine learning on quantum hardware*. Connect to quantum hardware using **PyTorch**, **TensorFlow**, **JAX**, **Keras**, or **NumPy**. Build rich and flexible hybrid quantum-classical models.
- <strong>*Program quantum computers*</strong>. Build quantum circuits with a wide range of state preparations, gates, and measurements. Run on [high-performance simulators](https://pennylane.ai/performance/) or [various hardware devices](https://pennylane.ai/plugins/), with advanced features like mid-circuit measurements and error mitigation.

- *Just in time compilation*. Experimental support for just-in-time
- <strong>*Master quantum algorithms*</strong>. From NISQ to fault-tolerant quantum computing, unlock algorithms for research and application. Analyze performance, visualize circuits, and access tools for [quantum chemistry](https://docs.pennylane.ai/en/stable/introduction/chemistry.html) and [algorithm development](https://pennylane.ai/search/?contentType=DEMO&categories=algorithms&sort=publication_date).

- <strong>*Machine learning with quantum hardware and simulators*</strong>. Integrate with **PyTorch**, **TensorFlow**, **JAX**, **Keras**, or **NumPy** to define and train hybrid models using quantum-aware optimizers and hardware-compatible gradients for advanced research tasks. [Quantum machine learning quickstart](https://docs.pennylane.ai/en/stable/introduction/interfaces.html).


- <strong>*Quantum datasets*</strong>. Access high-quality, pre-simulated datasets to decrease time-to-research and accelerate algorithm development. [Browse the datasets](https://pennylane.ai/datasets/) or contribute your own data.


- <strong>*Compilation and performance*</strong>. Experimental support for just-in-time
compilation. Compile your entire hybrid workflow, with support for
advanced features such as adaptive circuits, real-time measurement
feedback, and unbounded loops. See
[Catalyst](https://github.com/pennylaneai/catalyst) for more details.

- *Device-independent*. Run the same quantum circuit on different quantum backends. Install
[plugins](https://pennylane.ai/plugins.html) to access even more devices, including **Strawberry
Fields**, **Amazon Braket**, **IBM Q**, **Google Cirq**, **Rigetti Forest**, **Qulacs**, **Pasqal**, **Honeywell**, and more.

- *Follow the gradient*. Hardware-friendly **automatic differentiation** of quantum circuits.

- *Batteries included*. Built-in tools for **quantum machine learning**, **optimization**, and
**quantum chemistry**. Rapidly prototype using built-in quantum simulators with
backpropagation support.
For more details and additional features, please see the [PennyLane website](https://pennylane.ai/features/).

## Installation

Expand All @@ -76,52 +76,55 @@ python -m pip install pennylane

## Docker support

**Docker** support exists for building using **CPU** and **GPU** (Nvidia CUDA
11.1+) images. [See a more detailed description
here](https://pennylane.readthedocs.io/en/stable/development/guide/installation.html#docker).
Docker images are found on the [PennyLane Docker Hub page](https://hub.docker.com/u/pennylaneai), where there is also a detailed description about PennyLane Docker support. [See description here](https://docs.pennylane.ai/projects/lightning/en/stable/dev/docker.html) for more information.

## Getting started

For an introduction to quantum machine learning, guides and resources are available on
PennyLane's [quantum machine learning hub](https://pennylane.ai/qml/):
Get up and running quickly with PennyLane by following our [quickstart guide](https://docs.pennylane.ai/en/stable/introduction/pennylane.html), designed to introduce key features and help you start building quantum circuits right away.

Whether you're exploring quantum machine learning (QML), quantum computing, or quantum chemistry, PennyLane offers a wide range of tools and resources to support your research:

<img src="./doc/_static/readme/research.png" align="right" width="350px">

<img src="https://raw.githubusercontent.com/PennyLaneAI/pennylane/master/doc/_static/readme/gpu_to_qpu.png" align="right" width="400px">
### Key Resources:

* [Research-oriented Demos](https://pennylane.ai/qml/demonstrations.html)
* [Learn Quantum Programming](https://pennylane.ai/qml/) with the [Codebook](https://pennylane.ai/codebook/) and [Coding Challenges](https://pennylane.ai/challenges/)
* [Frequently Asked Questions](https://pennylane.ai/faq.html)
* [Glossary](https://pennylane.ai/qml/glossary.html)
* [Videos](https://pennylane.ai/qml/videos.html)

* [What is quantum machine learning?](https://pennylane.ai/qml/whatisqml)
* [QML tutorials and demos](https://pennylane.ai/qml/demonstrations)
* [Frequently asked questions](https://pennylane.ai/faq)
* [Key concepts of QML](https://pennylane.ai/qml/glossary)
* [QML videos](https://pennylane.ai/qml/videos)

You can also check out our [documentation](https://pennylane.readthedocs.io) for [quickstart
guides](https://pennylane.readthedocs.io/en/stable/introduction/pennylane.html) to using PennyLane,
and detailed developer guides on [how to write your
own](https://pennylane.readthedocs.io/en/stable/development/plugins.html) PennyLane-compatible
quantum device.

## Tutorials and demonstrations
## Demos

Take a deeper dive into quantum machine learning by exploring cutting-edge algorithms on our [demonstrations
page](https://pennylane.ai/qml/demonstrations).
Take a deeper dive into quantum computing by exploring cutting-edge algorithms using PennyLane and quantum hardware. [Explore PennyLane demos](https://pennylane.ai/qml/demonstrations.html).

<a href="https://pennylane.ai/qml/demonstrations">
<img src="https://raw.githubusercontent.com/PennyLaneAI/pennylane/master/doc/_static/readme/demos.png" width="900px">
<img src="./doc/_static/readme/demos.png" width="900px">
</a>

All demonstrations are fully executable, and can be downloaded as Jupyter notebooks and Python
scripts.

If you would like to contribute your own demo, see our [demo submission
guide](https://pennylane.ai/qml/demos_submission).

## Videos
## Research Applications

PennyLane is at the forefront of research in quantum computing, quantum machine learning, and quantum chemistry. Explore how PennyLane is used for research in the following publications:

- **Quantum Computing**: [Fast quantum circuit cutting with randomized measurements](https://quantum-journal.org/papers/q-2023-03-02-934/)

- **Quantum Machine Learning**: [Better than classical? The subtle art of benchmarking quantum machine learning models](https://arxiv.org/abs/2403.07059)

- **Quantum Chemistry**: [Accelerating Quantum Computations of Chemistry Through Regularized Compressed Double Factorization](https://quantum-journal.org/papers/q-2024-06-13-1371/)

Impactful research drives PennyLane. Let us know what features you need for your research on [GitHub](https://github.com/PennyLaneAI/pennylane/issues/new?assignees=&labels=enhancement+%3Asparkles%3A&projects=&template=feature_request.yml) or on our [website](https://pennylane.ai/research).

Seeing is believing! Check out [our videos](https://pennylane.ai/qml/videos) to learn about
PennyLane, quantum computing concepts, and more.

<a href="https://pennylane.ai/qml/videos">
<img src="https://raw.githubusercontent.com/PennyLaneAI/pennylane/master/doc/_static/readme/videos.png" width="900px">
</a>

## Contributing to PennyLane

Expand All @@ -136,7 +139,7 @@ projects or applications built on PennyLane.

See our [contributions
page](https://github.com/PennyLaneAI/pennylane/blob/master/.github/CONTRIBUTING.md) and our
[developer hub](https://pennylane.readthedocs.io/en/stable/development/guide.html) for more
[Development guide](https://pennylane.readthedocs.io/en/stable/development/guide.html) for more
details.

## Support
Expand All @@ -146,8 +149,7 @@ details.

If you are having issues, please let us know by posting the issue on our GitHub issue tracker.

We also have a [PennyLane discussion forum](https://discuss.pennylane.ai)—come join the community
and chat with the PennyLane team.
Join the [PennyLane Discussion Forum](https://discuss.pennylane.ai/) to connect with the quantum community, get support, and engage directly with our team. It’s the perfect place to share ideas, ask questions, and collaborate with fellow researchers and developers!
justinpickering marked this conversation as resolved.
Show resolved Hide resolved

Note that we are committed to providing a friendly, safe, and welcoming environment for all.
Please read and respect the [Code of Conduct](.github/CODE_OF_CONDUCT.md).
Expand Down
Binary file modified doc/_static/readme/demos.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/readme/getting-started.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/readme/pl-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_static/readme/research.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.