Skip to content
This repository has been archived by the owner on Aug 11, 2024. It is now read-only.

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
GiggleLiu authored Apr 10, 2024
1 parent db458ae commit d837ce8
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ It transform a [`Yao`](https://github.com/QuantumBFS/Yao.jl) circuit to a genera

* `initial_state` and `final_state` are for specifying the initial state and final state.
If any of them is not specified, the function will return a tensor network with open legs.
* `optimizer` is for optimizing the contraction order of the tensor network. The default value is `TreeSA()`. Please check the README of [OMEinsumContractors.jl](https://github.com/TensorBFS/OMEinsumContractionOrders.jl) for more information.
* `optimizer` is for optimizing the YaoToEinsum.contraction order of the tensor network. The default value is `TreeSA()`. Please check the README of [OMEinsumYaoToEinsum.contractors.jl](https://github.com/TensorBFS/OMEinsumYaoToEinsum.contractionOrders.jl) for more information.

```julia
julia> import Yao, YaoToEinsum
Expand All @@ -39,7 +39,7 @@ Time complexity: 2^20.03816881914695
Space complexity: 2^20.0
Read-write complexity: 2^20.07564105083201

julia> reshape(contract(network), 1<<n, 1<<n) Yao.mat(circuit)
julia> reshape(YaoToEinsum.contract(network), 1<<n, 1<<n) Yao.mat(circuit)
true

# convert circuit sandwiched by zero states
Expand All @@ -51,10 +51,10 @@ Time complexity: 2^12.224001674198101
Space complexity: 2^5.0
Read-write complexity: 2^13.036173612553485

julia> contract(network)[] Yao.zero_state(n)' * (Yao.zero_state(n) |> circuit)
julia> YaoToEinsum.contract(network)[] Yao.zero_state(n)' * (Yao.zero_state(n) |> circuit)
true
```

## Contribute and Cite
If you have any questions or suggestions, please feel free to open an issue or pull request.
If you use this package in your work, please cite the relevant part of the papers included in [CITATION.bib](CITATION.bib).
If you use this package in your work, please cite the relevant part of the papers included in [CITATION.bib](CITATION.bib).

0 comments on commit d837ce8

Please sign in to comment.