.. currentmodule:: cuquantum.cutensornet

Python objects & constants
**************************

Objects
=======

.. autosummary::
   :toctree: generated/

   :template: dataclass.rst

   tensor_qualifiers_dtype
   contraction_path_dtype
   slice_info_pair_dtype
   slicing_config_dtype

Enums
=====

.. autosummary::
   :toctree: generated/

   NetworkAttribute
   ContractionAutotunePreferenceAttribute
   ContractionOptimizerConfigAttribute
   ContractionOptimizerInfoAttribute
   GraphAlgo
   MemoryModel
   OptimizerCost
   WorksizePref
   Memspace
   WorkspaceKind
   TensorSVDConfigAttribute
   TensorSVDInfoAttribute
   TensorSVDNormalization
   TensorSVDPartition
   TensorSVDAlgo
   GateSplitAlgo
   StatePurity
   BoundaryCondition
   StateAttribute
   MarginalAttribute
   SamplerAttribute
   AccessorAttribute
   ExpectationAttribute

Python functions
****************

Handle Management API
=====================

.. autosummary::
   :toctree: generated/

   create
   destroy

Network Descriptor API
======================

.. autosummary::
   :toctree: generated/

   create_network_descriptor
   destroy_network_descriptor
   get_output_tensor_details
   get_output_tensor_descriptor
   network_get_attribute
   network_set_attribute

Tensor Descriptor API
=====================

.. autosummary::
   :toctree: generated/

   create_tensor_descriptor
   destroy_tensor_descriptor
   get_tensor_details

Contraction Optimizer API
=========================

.. autosummary::
   :toctree: generated/

   create_contraction_optimizer_info
   create_contraction_optimizer_info_from_packed_data
   update_contraction_optimizer_info_from_packed_data
   destroy_contraction_optimizer_info
   contraction_optimizer_info_get_attribute_dtype
   contraction_optimizer_info_get_attribute
   contraction_optimizer_info_set_attribute
   contraction_optimizer_info_get_packed_size
   contraction_optimizer_info_pack_data
   create_contraction_optimizer_config
   destroy_contraction_optimizer_config
   contraction_optimizer_config_get_attribute_dtype
   contraction_optimizer_config_get_attribute
   contraction_optimizer_config_set_attribute
   contraction_optimize

Contraction Plan API
====================

.. autosummary::
   :toctree: generated/

   create_contraction_plan
   destroy_contraction_plan
   create_contraction_autotune_preference
   destroy_contraction_autotune_preference
   contraction_autotune_preference_get_attribute_dtype
   contraction_autotune_preference_get_attribute
   contraction_autotune_preference_set_attribute
   contraction_autotune

Workspace Management API
========================

.. autosummary::
   :toctree: generated/

   create_workspace_descriptor
   destroy_workspace_descriptor
   workspace_compute_sizes
   workspace_compute_contraction_sizes
   workspace_compute_qr_sizes
   workspace_compute_svd_sizes
   workspace_compute_gate_split_sizes
   workspace_get_size
   workspace_get_memory_size
   workspace_set
   workspace_set_memory
   workspace_get
   workspace_get_memory
   workspace_purge_cache

Memory Management API
=====================

.. autosummary::
   :toctree: generated/

   set_device_mem_handler
   get_device_mem_handler

Network Contraction API
=======================

.. autosummary::
   :toctree: generated/

   contraction
   contract_slices

Gradient Computation API
========================

.. autosummary::
   :toctree: generated/

   compute_gradients_backward

Slice Group API
===============

.. autosummary::
   :toctree: generated/

   create_slice_group_from_id_range
   create_slice_group_from_ids
   destroy_slice_group

Approximate Tensor Network Execution API
========================================

.. autosummary::
   :toctree: generated/

   tensor_qr
   tensor_svd
   gate_split

Tensor SVD Config API
=====================

.. autosummary::
   :toctree: generated/

   create_tensor_svd_config
   destroy_tensor_svd_config
   tensor_svd_config_get_attribute_dtype
   tensor_svd_config_get_attribute
   tensor_svd_config_set_attribute

Tensor SVD Info API
===================

.. autosummary::
   :toctree: generated/

   create_tensor_svd_info
   destroy_tensor_svd_info
   tensor_svd_info_get_attribute_dtype
   tensor_svd_info_get_attribute

Distributed Parallelization API
===============================

.. autosummary::
   :toctree: generated/

   distributed_reset_configuration
   distributed_get_num_ranks
   distributed_get_proc_rank
   distributed_synchronize
   get_mpi_comm_pointer

High-Level Tensor Network API
=============================

.. autosummary::
   :toctree: generated/

   create_state
   destroy_state
   state_apply_tensor
   state_update_tensor
   state_get_attribute_dtype
   state_configure
   state_prepare
   state_compute
   state_finalize_mps
   create_marginal
   destroy_marginal
   marginal_get_attribute_dtype
   marginal_configure
   marginal_prepare
   marginal_compute
   create_sampler
   destroy_sampler
   sampler_get_attribute_dtype
   sampler_configure
   sampler_prepare
   sampler_sample
   create_accessor
   destroy_accessor
   accessor_get_attribute_dtype
   accessor_configure
   accessor_prepare
   accessor_compute
   create_expectation
   destroy_expectation
   expectation_get_attribute_dtype
   expectation_configure
   expectation_prepare
   expectation_compute

Tensor Network Operator API
===========================

.. autosummary::
   :toctree: generated/

   create_network_operator
   network_operator_append_product
   destroy_network_operator

Versioning API
==============

.. autosummary::
   :toctree: generated/

   get_version
   get_cudart_version