Skip to content

Commit 423d418

Browse files
committed
Update README
1 parent 944bade commit 423d418

File tree

1 file changed

+23
-16
lines changed

1 file changed

+23
-16
lines changed

README.md

Lines changed: 23 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -7,11 +7,18 @@
77
[![Build Status](https://github.com/TensorBFS/TensorInference.jl/actions/workflows/CI.yml/badge.svg?branch=main)](https://github.com/TensorBFS/TensorInference.jl/actions/workflows/CI.yml?query=branch%3Amain)
88
[![Coverage](https://codecov.io/gh/TensorBFS/TensorInference.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/TensorBFS/TensorInference.jl)
99

10-
This package implements a tensor network based probabilistic modeling toolbox, which covers the probability inference functionalities in [this page](https://uaicompetition.github.io/uci-2022/competition-entry/tasks/):
11-
* PR: computing the partition function or probability of evidence,
12-
* MAR: computing the marginal probability distribution over all variables given evidence.
13-
* MAP: computing the most likely assignment to all variables given evidence.
14-
* MMAP: computing the most likely assignment to the query variables after marginalizing out the remaining variables.
10+
This package presents a tensor network-based probabilistic modeling toolbox for
11+
probabilistic inference. It features solutions for the [probability inference
12+
tasks](https://uaicompetition.github.io/uci-2022/competition-entry/tasks/) of
13+
the [UAI inference competitions](https://uaicompetition.github.io/uci-2022/),
14+
which include:
15+
16+
- **PR**: Computing the partition function or probability of evidence.
17+
- **MAR**: Computing the marginal probability distribution over all variables
18+
given evidence.
19+
- **MAP**: Computing the most likely assignment to all variables given evidence.
20+
- **MMAP**: Computing the most likely assignment to the query variables after
21+
marginalizing out the remaining variables.
1522

1623
## Installation
1724
<p>
@@ -21,29 +28,29 @@ This package implements a tensor network based probabilistic modeling toolbox, w
2128
Julia Language
2229
</a>
2330
&nbsp; package. To install <code>TensorInference</code>,
24-
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
31+
start Julia's <a href="https://docs.julialang.org/en/v1/manual/getting-started/">REPL</a> and press <kbd>]</kbd> key in the REPL to use the package mode, then type
2632
</p>
2733

2834
```julia
2935
pkg> add TensorInference
3036
```
3137

32-
To update, just type `up` in the package mode.
38+
To update, type `up` in the package mode.
3339

3440
## Examples
35-
Examples are in the [examples](examples) folder, which contains the following list of example problems
36-
- [asia network](examples/asia)
3741

42+
Check out the [examples](examples) directory to learn how to use the API of
43+
*TensorInference.jl*.
3844

3945
## Supporting and Citing
4046

41-
Much of the software in this ecosystem was developed as a part of an academic research project.
42-
If you would like to help support it, please star the repository.
43-
If you use our software as part of your research, teaching, or other activities, we would like to request you to cite our [work (TBA)]().
44-
The
45-
[CITATION.bib](CITATION.bib) file in the root of this repository lists the relevant papers.
47+
Much of the software in this ecosystem was developed as a part of an academic
48+
research project. If you would like to help support it, please star the
49+
repository. If you use our software as part of your research, teaching, or other
50+
activities, please cite our [work (TBA)](). The [CITATION.bib](CITATION.bib)
51+
file in the root of this repository lists the relevant papers.
4652

4753
## Questions and Contributions
4854

49-
Please Open an [issue](https://github.com/TensorBFS/TensorInference.jl/issues) if you encounter any problems, or have any feature request.
55+
Please open an [issue](https://github.com/TensorBFS/TensorInference.jl/issues)
56+
if you encounter any problems, or have any feature requests.

0 commit comments

Comments
 (0)