Apply autosummary template to embedding and utilities

JoelPasvolsky · JoelPasvolsky · commit 4f1fca037edc · 2025-07-24T11:21:03.000-07:00
diff --git a/docs/embedding.rst b/docs/embedding.rst
@@ -65,76 +65,57 @@ Minor-embedding in :term:`Zephyr`-structured target graphs.
 Utilities
 =========
 
+The following **modules** provide functions for embedding and chains; for
+example, functions such as :func:`~dwave.embedding.transforms.embed_bqm`,
+:func:`~dwave.embedding.utils.chain_break_frequency` and
+:func:`~dwave.embedding.chain_strength.uniform_torque_compensation`.
 
 .. autosummary::
+   :recursive:
    :toctree: generated/
+   :template: autosummary_module_functions.rst
 
-   embed_bqm
-   embed_ising
-   embed_qubo
-   unembed_sampleset
+   chain_breaks
+   chain_strength
+   transforms
+   utils
 
-Diagnostics
-===========
-
-.. autosummary::
-   :toctree: generated/
-
-   chain_break_frequency
-   diagnose_embedding
-   is_valid_embedding
-   verify_embedding
-
-Chain Strength
-==============
+Classes
+-------
 
-.. automodule:: dwave.embedding.chain_strength
-.. currentmodule:: dwave.embedding
+The following classes are provided.
 
 .. autosummary::
-   :toctree: generated/
-
-   chain_strength.uniform_torque_compensation
-   chain_strength.scaled
-
-Chain-Break Resolution
-======================
-
-.. automodule:: dwave.embedding.chain_breaks
-.. currentmodule:: dwave.embedding
-
-Generators
-----------
+    :recursive:
+    :nosignatures:
+    :toctree: generated
+    :template: autosummary_class.rst
 
-.. autosummary::
-   :toctree: generated/
+    EmbeddedStructure
+    ~chain_breaks.MinimizeEnergy
 
-   chain_breaks.discard
-   chain_breaks.majority_vote
-   chain_breaks.weighted_random
+Diagnostic Functions
+--------------------
 
-Callable Objects
-----------------
+These diagnostics functions are also provided.
 
 .. autosummary::
    :toctree: generated/
 
-   chain_breaks.MinimizeEnergy
+   chain_break_frequency
+   diagnose_embedding
+   is_valid_embedding
+   verify_embedding
 
 Exceptions
 ==========
 
 .. autosummary::
    :toctree: generated/
 
-   exceptions.EmbeddingError
-   exceptions.MissingChainError
    exceptions.ChainOverlapError
    exceptions.DisconnectedChainError
+   exceptions.EmbeddingError
    exceptions.InvalidNodeError
-   exceptions.MissingEdgeError
-
-Classes
-=======
-
-.. autoclass:: EmbeddedStructure
+   exceptions.MissingChainError
+   exceptions.MissingEdgeError
diff --git a/docs/utilities.rst b/docs/utilities.rst
@@ -4,39 +4,16 @@
 Utilities
 =========
 
-.. automodule:: dwave.system.utilities
-
 .. currentmodule:: dwave.system
 
 .. autosummary::
+   :recursive:
    :toctree: generated/
+   :template: autosummary_module_functions.rst
 
-   ~utilities.anneal_schedule_with_offset
-   ~utilities.common_working_graph
-   ~coupling_groups.coupling_groups
-   ~utilities.energy_scales_custom_schedule
-
-Temperature and Unit-Conversion Utilities
------------------------------------------
-
-.. automodule:: dwave.system.temperatures
-
-.. currentmodule:: dwave.system.temperatures
-
-.. autosummary::
-   :toctree: generated/
-
-   background_susceptibility_bqm
-   background_susceptibility_ising
-   effective_field
-   fast_effective_temperature
-   fluxbias_to_h
-   freezeout_effective_temperature
-   h_to_fluxbias
-   Ip_in_units_of_B
-   maximum_pseudolikelihood
-   maximum_pseudolikelihood_temperature
-
+   coupling_groups
+   utilities
+   temperatures
 
 .. [Chat2007]
     Chatterjee, Sourav.
diff --git a/dwave/embedding/chain_breaks.py b/dwave/embedding/chain_breaks.py
@@ -12,7 +12,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-"""Unembedding samples with broken chains."""
+"""Provides functions that unembed samples with broken chains."""
 
 from collections.abc import Callable
 from heapq import heapify, heappop
diff --git a/dwave/embedding/transforms.py b/dwave/embedding/transforms.py
@@ -11,6 +11,7 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
+"""Provides utility functions for minor embedding and unembedding."""
 
 import collections.abc as abc
 import itertools
diff --git a/dwave/embedding/utils.py b/dwave/embedding/utils.py
@@ -11,6 +11,7 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
+"""Provides utility functions related to minor embedding and chains."""
 
 import dimod
 import numpy as np
diff --git a/dwave/system/coupling_groups.py b/dwave/system/coupling_groups.py
@@ -11,6 +11,7 @@
 #    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
+"""Provides functions related to the ``per_group_coupling_range`` property."""
 
 import dwave_networkx as dnx
 
diff --git a/dwave/system/temperatures.py b/dwave/system/temperatures.py
@@ -12,7 +12,9 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-r"""Some notes on the parameter-estimation methods provided below:
+r"""Provides temperature estimation and flux-bias offset utility functions.
+
+Some notes on the parameter-estimation methods provided below:
 
 -   :func:`fluxbias_to_h` and :func:`h_to_fluxbias`
 
diff --git a/dwave/system/utilities.py b/dwave/system/utilities.py
@@ -12,7 +12,7 @@
 #    See the License for the specific language governing permissions and
 #    limitations under the License.
 
-"""Utility functions."""
+"""Provides general utility functions."""
 
 import os
 import json
