.. currentmodule:: cuquantum.bindings.cutensornet

###################################################
cuTensorNet (:mod:`cuquantum.bindings.cutensornet`)
###################################################

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

Objects
=======

.. autosummary::
   :toctree: generated/

   MPSEnvBounds

   :template: dataclass.rst

   tensor_qualifiers_dtype
   contraction_path_dtype
   slice_info_pair_dtype
   slicing_config_dtype
   mps_env_bounds_dtype

Enums
=====

.. autosummary::
   :toctree: generated/

   Status
   NetworkAttribute
   ContractionAutotunePreferenceAttribute
   ContractionOptimizerConfigAttribute
   ContractionOptimizerInfoAttribute
   GraphAlgo
   MemoryModel
   OptimizerCost
   SmartOption
   WorksizePref
   Memspace
   WorkspaceKind
   TensorSVDConfigAttribute
   TensorSVDInfoAttribute
   TensorSVDNormalization
   TensorSVDPartition
   TensorSVDAlgo
   GateSplitAlgo
   StatePurity
   BoundaryCondition
   StateAttribute
   StateMPOApplication
   StateMPSGaugeOption
   MarginalAttribute
   SamplerAttribute
   AccessorAttribute
   ExpectationAttribute
   StateProjectionMPSOrthoOption
   StateProjectionMPSAttribute

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_descriptor
   network_get_attribute
   network_set_attribute
   get_network_attribute_dtype
   create_network
   destroy_network
   network_append_tensor
   network_set_output_tensor
   network_set_optimizer_info
   network_prepare_contraction
   network_autotune_contraction
   create_network_autotune_preference
   network_autotune_preference_get_attribute
   network_autotune_preference_set_attribute
   destroy_network_autotune_preference
   network_set_input_tensor_memory
   network_set_output_tensor_memory
   network_set_gradient_tensor_memory
   network_set_adjoint_tensor_memory
   network_contract
   network_prepare_gradients_backward
   network_compute_gradients_backward

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
   get_contraction_optimizer_info_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
   get_contraction_optimizer_config_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
   get_contraction_autotune_preference_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_contraction_sizes
   workspace_compute_qr_sizes
   workspace_compute_svd_sizes
   workspace_compute_gate_split_sizes
   workspace_get_memory_size
   workspace_set_memory
   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/

   contract_slices

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
   get_tensor_svd_config_attribute_dtype
   tensor_svd_config_get_attribute
   tensor_svd_config_set_attribute
   tensor_svd_algo_params_get_dtype

Tensor SVD info API
===================

.. autosummary::
   :toctree: generated/

   create_tensor_svd_info
   destroy_tensor_svd_info
   get_tensor_svd_info_attribute_dtype
   tensor_svd_info_get_attribute
   tensor_svd_algo_status_get_dtype

Distributed parallelization API
===============================

.. autosummary::
   :toctree: generated/

   distributed_reset_configuration
   distributed_get_num_ranks
   distributed_get_proc_rank
   distributed_synchronize

Tensor network state API
========================

.. autosummary::
   :toctree: generated/

   create_state
   destroy_state
   state_apply_tensor
   state_apply_tensor_operator
   state_apply_controlled_tensor_operator
   state_apply_unitary_channel
   state_apply_general_channel
   state_apply_network_operator
   state_update_tensor
   state_update_tensor_operator
   get_state_attribute_dtype
   state_configure
   state_prepare
   state_get_info
   state_compute
   state_initialize_mps
   state_finalize_mps
   state_capture_mps
   get_output_state_details
   create_marginal
   destroy_marginal
   get_marginal_attribute_dtype
   marginal_configure
   marginal_prepare
   marginal_get_info
   marginal_compute
   create_sampler
   destroy_sampler
   get_sampler_attribute_dtype
   sampler_configure
   sampler_prepare
   sampler_get_info
   sampler_sample
   create_accessor
   destroy_accessor
   get_accessor_attribute_dtype
   accessor_configure
   accessor_prepare
   accessor_get_info
   accessor_compute
   create_expectation
   destroy_expectation
   get_expectation_attribute_dtype
   expectation_configure
   expectation_prepare
   expectation_get_info
   expectation_compute

State projection MPS API
=========================

.. autosummary::
   :toctree: generated/

   create_state_projection_mps
   get_state_projection_mps_attribute_dtype
   state_projection_mps_configure
   state_projection_mps_prepare
   state_projection_mps_compute_tensor_env
   state_projection_mps_get_tensor_info
   state_projection_mps_extract_tensor
   state_projection_mps_insert_tensor
   destroy_state_projection_mps

Tensor network operator API
===========================

.. autosummary::
   :toctree: generated/

   create_network_operator
   network_operator_append_product
   network_operator_append_mpo
   destroy_network_operator

Error management API
====================

.. autosummary::
   :toctree: generated/

   get_error_string

Logger API
==========

.. autosummary::
   :toctree: generated/

   logger_set_callback_data
   logger_open_file
   logger_set_level
   logger_set_mask
   logger_force_disable
   logger_set_file

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

.. autosummary::
   :toctree: generated/

   get_version
   get_cudart_version