Skip to content

Commit 5cb542a

Browse files
minor edits to readme (#58)
1 parent b459e95 commit 5cb542a

File tree

2 files changed

+25
-20
lines changed

2 files changed

+25
-20
lines changed

CITATION.bib

+14-9
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,17 @@
1-
@misc{https://doi.org/10.48550/arxiv.2205.03718,
2-
doi = {10.48550/ARXIV.2205.03718},
3-
url = {https://arxiv.org/abs/2205.03718},
4-
author = {Liu, Jin-Guo and Gao, Xun and Cain, Madelyn and Lukin, Mikhail D. and Wang, Sheng-Tao},
5-
keywords = {Statistical Mechanics (cond-mat.stat-mech), FOS: Physical sciences, FOS: Physical sciences},
6-
title = {Computing solution space properties of combinatorial optimization problems via generic tensor networks},
7-
publisher = {arXiv},
8-
year = {2022},
9-
copyright = {Creative Commons Attribution 4.0 International}
1+
@ARTICLE{Liu2022Computing,
2+
author = {{Liu}, Jin-Guo and {Gao}, Xun and {Cain}, Madelyn and {Lukin}, Mikhail D. and {Wang}, Sheng-Tao},
3+
title = "{Computing solution space properties of combinatorial optimization problems via generic tensor networks}",
4+
journal = {arXiv e-prints},
5+
keywords = {Condensed Matter - Statistical Mechanics},
6+
year = 2022,
7+
month = may,
8+
eid = {arXiv:2205.03718},
9+
pages = {arXiv:2205.03718},
10+
archivePrefix = {arXiv},
11+
eprint = {2205.03718},
12+
primaryClass = {cond-mat.stat-mech},
13+
adsurl = {https://ui.adsabs.harvard.edu/abs/2022arXiv220503718L},
14+
adsnote = {Provided by the SAO/NASA Astrophysics Data System}
1015
}
1116
1217
@article{Ebadi_2022,

README.md

+11-11
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ The *solution space properties* include
1111
* The number of solutions at certain sizes,
1212
* The enumeration/sampling of solutions at certain sizes.
1313

14-
The solvable problems include [Independent set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/IndependentSet/), [Maximal independent set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/MaximalIS/), [Spin-glass problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SpinGlass/), [Cutting problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/MaxCut/), [Vertex matching problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Matching/), [Binary paint shop problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/PaintShop/), [Coloring problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Coloring/), [Dominating set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/DominatingSet/), [Set packing problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SetPacking/), [Satisfiability problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Satisfiability/) and [Set covering problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SetCovering/).
14+
The types of problems that can be solved using this package include [Independent set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/IndependentSet/), [Maximal independent set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/MaximalIS/), [Spin-glass problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SpinGlass/), [Cutting problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/MaxCut/), [Vertex matching problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Matching/), [Binary paint shop problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/PaintShop/), [Coloring problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Coloring/), [Dominating set problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/DominatingSet/), [Set packing problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SetPacking/), [Satisfiability problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/Satisfiability/) and [Set covering problem](https://queracomputing.github.io/GenericTensorNetworks.jl/dev/generated/SetCovering/).
1515

1616
## Installation
1717
<p>
@@ -22,7 +22,7 @@ GenericTensorNetworks is a &nbsp;
2222
</a>
2323
&nbsp; package. To install GenericTensorNetworks,
2424
please <a href="https://docs.julialang.org/en/v1/manual/getting-started/">open
25-
Julia's interactive session (known as REPL)</a> and press <kbd>]</kbd> key in the REPL to use the package mode, then type
25+
Julia's interactive session (known as REPL)</a> and press the <kbd>]</kbd> key in the REPL to use the package mode, and then type:
2626
</p>
2727

2828
```julia
@@ -31,11 +31,11 @@ pkg> add GenericTensorNetworks
3131

3232
To update, just type `up` in the package mode.
3333

34-
We recommend you to use **Julia version >= 1.7**, otherwise your program can suffer from significant (exponential in tensor dimension) overheads when permuting the dimensions of a large tensor.
35-
If you have to use an older version Julia, you can overwrite the `LinearAlgebra.permutedims!` by adding the following patch to your own project.
34+
We recommend that you use **Julia version >= 1.7**; otherwise, your program may suffer from significant (exponential in the tensor dimension) overheads when permuting the dimensions of a large tensor.
35+
If you have to use an older version of Julia, you can overwrite the `LinearAlgebra.permutedims!` by adding the following patch to your own project.
3636

3737
```julia
38-
# only required when your Julia version < 1.7
38+
# only required when your Julia version is < 1.7
3939
using TensorOperations, LinearAlgebra
4040
function LinearAlgebra.permutedims!(C::Array{T,N}, A::StridedArray{T,N}, perm) where {T,N}
4141
if isbitstype(T)
@@ -48,15 +48,15 @@ end
4848

4949
## Supporting and Citing
5050

51-
Much of the software in this ecosystem was developed as part of academic research.
52-
If you would like to help support it, please star the repository as such metrics may help us secure funding in the future.
53-
If you use our software as part of your research, teaching, or other activities, we would be grateful if you could cite our work.
51+
Much of the software in this ecosystem was developed as a part of an academic research project.
52+
If you would like to help support it, please star the repository.
53+
If you use our software as part of your research, teaching, or other activities, we would like to request you to cite our [work](https://arxiv.org/abs/2205.03718).
5454
The
5555
[CITATION.bib](https://github.com/QuEraComputing/GenericTensorNetworks.jl/blob/master/CITATION.bib) file in the root of this repository lists the relevant papers.
5656

5757
## Questions and Contributions
5858

5959
You can
60-
* Post a question on [Julia Discourse forum](https://discourse.julialang.org/), pin the package maintainer wih `@1115`.
61-
* Discuss in the `#graphs` channel of the [Julia Slack](https://julialang.org/community/), ping the package maintainer with `@JinGuo Liu`.
62-
* Open an [issue](https://github.com/QuEraComputing/GenericTensorNetworks.jl/issues) if you encounter any problems, or have any feature request.
60+
* Post a question on [Julia Discourse forum](https://discourse.julialang.org/) and ping the package maintainer with `@1115`.
61+
* Discuss in the `#graphs` channel of the [Julia Slack](https://julialang.org/community/) and ping the package maintainer with `@JinGuo Liu`.
62+
* Open an [issue](https://github.com/QuEraComputing/GenericTensorNetworks.jl/issues) if you encounter any problems, or have any feature request.

0 commit comments

Comments
 (0)