Skip to content

Commit 2ea5c76

Browse files
committed
Update README
1 parent 6ac91fb commit 2ea5c76

File tree

1 file changed

+29
-31
lines changed

1 file changed

+29
-31
lines changed

README.md

Lines changed: 29 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -7,52 +7,50 @@
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 presents a tensor network-based probabilistic modeling toolbox for
11-
probabilistic inference. It features solutions for the [probability inference
10+
<p>
11+
TensorInference is an open source &nbsp;
12+
<a href="https://julialang.org">
13+
<img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em">
14+
Julia
15+
</a>
16+
&nbsp; package for probabilistic inference over discrete graphical models. It
17+
leverages tensor-based technology for efficiently solving various inference
18+
tasks.
19+
</p>
20+
21+
## Features
22+
23+
TensorInference supports finding solutions to the most common [probability
24+
inference
1225
tasks](https://uaicompetition.github.io/uci-2022/competition-entry/tasks/) of
1326
the [UAI inference competitions](https://uaicompetition.github.io/uci-2022/),
14-
which include:
27+
which include:
1528

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.
29+
- **PR**: The partition function or probability of evidence
30+
- **MAR**: The marginal probability distribution over all variables
31+
given evidence
32+
- **MAP**: The most likely assignment to all variables given evidence
33+
- **MMAP**: The most likely assignment to the query variables after
34+
marginalizing out the remaining variables
2235

2336
## Installation
2437

25-
<p>
26-
<code>TensorInference</code> is a &nbsp;
27-
<a href="https://julialang.org">
28-
<img src="https://raw.githubusercontent.com/JuliaLang/julia-logo-graphics/master/images/julia.ico" width="16em">
29-
Julia Language
30-
</a>
31-
&nbsp; package. To install it, start Julia's <a
32-
href="https://docs.julialang.org/en/v1/manual/getting-started/">REPL</a>,
33-
press the <kbd>]</kbd> key to start the <a
34-
href="https://docs.julialang.org/en/v1/stdlib/Pkg/">package mode</a>, and
35-
then type
36-
</p>
38+
Install TensorInference through the Julia package manager:
3739

3840
```julia
3941
pkg> add TensorInference
4042
```
4143

42-
To update, type `up` in the package mode.
43-
4444
## Examples
4545

46-
Check out the [examples](examples) directory to learn how to use the API of
47-
`TensorInference`.
46+
Usage examples can be found in the [examples](examples) folder, and for a
47+
comprehensive introduction to the package read the
48+
[documentation](https://TensorBFS.github.io/TensorInference.jl/stable/) .
4849

49-
## Supporting and Citing
50+
## Citing
5051

51-
Much of the software in this ecosystem was developed as a part of an academic
52-
research project. If you would like to help support it, please star the
53-
repository. If you use our software as part of your research, teaching, or other
54-
activities, please cite our [work (TBA)](). The [CITATION.bib](CITATION.bib)
55-
file in the root of this repository lists the relevant papers.
52+
If you use TensorInference for your own research, please consider citing the
53+
following publication: [TBA)]().
5654

5755
## Questions and Contributions
5856

0 commit comments

Comments
 (0)