Skip to content

Commit de2b9e2

Browse files
committed
Simplify README examples
1 parent a537119 commit de2b9e2

1 file changed

Lines changed: 15 additions & 40 deletions

File tree

README.md

Lines changed: 15 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,16 @@ Discrete finite-state models are represented with variables over finite state
1818
spaces and factor tables, with iterative sum-product inference for marginals
1919
and min-sum inference for MAP estimates.
2020

21+
<br clear="left"/>
22+
2123
The Gaussian and discrete APIs share support for sequential, flooding, and
2224
residual schedules, damping, exact forward-backward inference on
2325
tree-structured graphs, dynamic graph updates, and inspection helpers for
2426
graphs, messages, marginals, and estimates.
2527

26-
<br clear="left"/>
27-
2828
## Installation
2929

30-
FactorGraph is registered as `FactorGraph.jl`. Install it from the Julia package
31-
manager:
30+
Install FactorGraph from the Julia package manager:
3231

3332
```julia-repl
3433
pkg> add FactorGraph
@@ -65,38 +64,14 @@ marginalMean(graph, inference, :x1)
6564
marginalCovariance(graph, inference, :x1)
6665
```
6766

68-
## Tree Inference
69-
70-
When the graph is tree-structured, pass a root variable to construct a
71-
`TreeFactorGraph` and run exact forward-backward belief propagation:
72-
73-
```julia
74-
tree = treeFactorGraph(graph; root = :x1)
75-
inference = moment(graph)
76-
77-
forwardBackward!(tree, inference)
78-
```
79-
80-
## Discrete Models
67+
## Features
8168

82-
```julia
83-
variables = [
84-
DiscreteVariable(:x1, 2; states = [:off, :on]),
85-
DiscreteVariable(:x2, 2; states = [:low, :high]),
86-
]
87-
88-
factors = [
89-
DiscreteFactor(:x1, [0.8, 0.2]; label = "prior_x1"),
90-
DiscreteFactor(:x1, :x2, [1.0 0.2; 0.1 0.9]; label = "link"),
91-
]
92-
93-
graph = factorGraph(variables, factors)
94-
inference = sumproduct(graph)
95-
96-
gbp!(graph, inference; iterations = 10)
97-
98-
marginalProbability(graph, inference, :x1, :on)
99-
```
69+
- Gaussian factor graphs with moment, canonical, and min-sum inference
70+
- Discrete finite-state factor graphs with sum-product and min-sum inference
71+
- Sequential, flooding, and residual message schedules
72+
- Exact forward-backward inference on tree-structured graphs
73+
- Dynamic graph updates with stale-inference checks
74+
- Freezing, damping, diagnostics, WLS validation, and graph visualization
10075

10176
## Documentation
10277

@@ -105,11 +80,11 @@ The full documentation is available at
10580

10681
It includes:
10782

108-
- Gaussian and discrete factor graph construction
109-
- Iterative sum-product and min-sum belief propagation
110-
- Forward-backward inference on tree-structured graphs
111-
- Dynamic graph updates and stale-inference checks
112-
- API references for types, graphs, inference, validation, and printing helpers
83+
- Gaussian and discrete model guides
84+
- Iterative and tree-structured inference
85+
- Domain examples and graph visualization
86+
- Dynamic graph updates and validation helpers
87+
- API references and release notes
11388

11489
## License
11590

0 commit comments

Comments
 (0)