dwavesystems / docs Goto Github PK

Request from Cathy, "Hey tools support, novice user here(!) Each QPU has a largest clique that can be embedded in the working graph -- is that clique pre-computed and available to me through ocean? I would like to avoid using a bunch of trial-and-error calls to MinorMiner to find the embedding."

Add to somewhere like https://docs.ocean.dwavesys.com/en/latest/examples/topology_samplers.html#topology-samplers an example like:

from dwave.system import DWaveSampler, FixedEmbeddingComposite
from dwave.embedding.chimera import find_clique_embedding

qpu = DWaveSampler(solver=dict(qpu=True))

embedding = find_clique_embedding(K, 16, target_edges=qpu.edgelist)

sampler = FixedEmbeddingComposite(qpu, embedding)

sampleset = sampler.sample_ising(h, J)
print(sampleset)

CC @arcondello

relevant text (re getting API token):
"....for Leap users..."

add link to Leap

These opinions come from my experience learning the Ocean SDK from the documentation directly and some code examples.

Sidebar:
I feel that there should be more distinction in the sidebar which links are part of the ocean documentation, and which is part of the more general dwave system documentation.
The "D-Wave" section (containing links for D-Wave, Leap, and D-Wave System Documentation) seems to be part of the ocean documentation. Maybe it should be forced to the bottom of the navbar or each entry should be indented to show that it is part of another section.

Tools:
I did not immediately correlate this section as the location for the documentation (even though it is clearly labelled at the Ocean docs starting page), and I think this was because I was immediately gravitated towards the "Getting Started" section which does not feature a link to the individual tools documentation. Perhaps this can be mitigated by linking the "Tools" main page in the "Getting Started" page. After viewing this page again, I now realize it is accessible via the "Ocean Software Stack" section, but might be worth having its own description section.

Edit:
I have just noticed that the "sub-pages" (tool specific documentation) has a more clear distinction in the navbar. Seems this may just be due to inconsistent style.
Example:

Compared with:

Moved to https://github.com/dwavesystems/dwave-ocean-sdk

@EDDahl points out that newer Python includes venv and pip, so with ending of life for Python 2 at the end of the year, also update installation in https://docs.ocean.dwavesys.com/en/latest/overview/install.html

'dimod'
'Ocean tools'
'BQM' ?
'shore' ?
'virtual graph tools' -- Tools that simplify the process of minor-embedding.
'flux biases' -- Offset values with which to calibrate a chain.

As the Ocean toolkit grows, you'll likely have a problem that has affected us in the Rosetta community: documentation for older protocols persists, and it can be difficult for a new user to pick out the best current practices. A page organized by tasks that a user might want to perform, indicating the best current way to accomplish the task, followed by a list of older ways that are clearly marked as older, would be very useful. (Note that I have not exhaustively explored the Ocean documentation. It is possible that this already exists.)

We've been getting feedback from beta testers about how difficult it is to go from running an example to crafting their own QUBO. They haven't found the help they need in the current Ocean documentation.

@fionahanington and I were wondering about turning @vgoliber 's QUBO training material into documentation. The training session is on the silo drive: transfer\Fiona\Zoom recordings

@randomir suggests the following edits to https://docs.ocean.dwavesys.com/en/latest/overview/dwavesys.html in #70

This SAPI endpoint link on https://docs.ocean.dwavesys.com/en/latest/overview/dwavesys.html#interacting-with-sapi doesn't lead anywhere and has caused some confusion for new users.

New users tend to copy paste the configuration in the Getting Started example (https://docs.ocean.dwavesys.com/en/latest/overview/dwavesys.html#configuring-a-d-wave-system-as-a-solver). Since Leap users don't have access to vfyc solvers they get errors when they ping the system. Removing the 'vfyc' option or adding an explanation about the option may reduce the number of users that have issues when they first connect to the system.

@spreinhardt 12:31 PM
Is there a diagram somewhere that shows how the different modules within Ocean are nested/layered on each other? And similarly for Classes, which ones are subclasses of others?

It would be good if https://docs.ocean.dwavesys.com/en/latest/overview/install.html#installing-ocean-tools, especially the installing python section for windows mentioned that the user should install 64 bit python.