|
7 | 7 | | [![iif-ci-stb][iif-ci-stb-img]][iif-ci-stb-url] <br> [![version][iif-ver-img]][iif-rel-url] | [![iif-ci-dev-img]][iif-ci-dev-url] <br> [![iif-commits-url]][contributors-url] <br> [![issues-time]][issues-url] | [![doi-img]][doi-url] <br> [![iif-cov-img]][iif-cov-url] <br> [![issues-open]][issues-url] | [![cjl-slack-badge]][cjl-slack] <br> [![caesar-docs]][cjl-docs-url] <br> [![dfg-docs]][dfg-docs-url] | |
8 | 8 |
|
9 | 9 |
|
10 | | -[iif-deps-img]: https://juliahub.com/docs/IncrementalInference/deps.svg |
11 | | -[iif-deps-jlh]: https://juliahub.com/ui/Packages/IncrementalInference/NrVw2??page=2 |
12 | | -[doi-img]: https://zenodo.org/badge/DOI/10.5281/zenodo.5146221.svg |
13 | | -[doi-url]: https://doi.org/10.5281/zenodo.5146221 |
| 10 | +Optimization routines for incremental non-parametric and parametric solutions based on factor graphs and the Bayes (Junction) tree implemented in the [Julia language][jlorg-url]. |
14 | 11 |
|
15 | | -<!-- replicated in Caesar.jl README --> |
16 | | -[iif-ci-dev-img]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml/badge.svg |
17 | | -[iif-ci-dev-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml |
18 | | -[iif-ci-stb-img]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml/badge.svg?branch=release%2Fv0.26 |
19 | | -[iif-ci-stb-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml |
20 | | -[iif-ver-img]: https://juliahub.com/docs/IncrementalInference/version.svg |
21 | | -[iif-rel-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/releases |
22 | | -[iif-milestones]: https://github.com/JuliaRobotics/IncrementalInference.jl/milestones |
23 | | -[iif-cov-img]: https://codecov.io/github/JuliaRobotics/IncrementalInference.jl/coverage.svg?branch=master |
24 | | -[iif-cov-url]: https://codecov.io/github/JuliaRobotics/IncrementalInference.jl?branch=master |
25 | | - |
26 | | -[iif-commits-url]: https://img.shields.io/github/commit-activity/y/JuliaRobotics/IncrementalInference.jl.svg?color=dark-green |
27 | | -[contributors-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/graphs/contributors |
28 | | -[issues-time]: https://isitmaintained.com/badge/resolution/JuliaRobotics/IncrementalInference.jl.svg |
29 | | -[issues-open]: https://isitmaintained.com/badge/open/JuliaRobotics/IncrementalInference.jl.svg |
30 | | -[issues-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/issues |
31 | | - |
32 | | -[caesar-docs]: https://img.shields.io/badge/CaesarDocs-latest-blue.svg |
33 | | -[cjl-docs-url]: http://juliarobotics.github.io/Caesar.jl/latest/ |
34 | | -[dfg-docs]: https://img.shields.io/badge/DFGDocs-latest-blue.svg |
35 | | -[dfg-docs-url]: https://juliarobotics.org/DistributedFactorGraphs.jl/latest/ |
36 | | - |
37 | | -[cjl-slack-badge]: https://img.shields.io/badge/Caesarjl-Slack-green.svg?style=popout |
38 | | -[cjl-slack]: https://join.slack.com/t/caesarjl/shared_invite/zt-ucs06bwg-y2tEbddwX1vR18MASnOLsw |
39 | | - |
40 | | -Optimization routines for incremental non-parametric and parametric solutions based on factor graphs and the Bayes (Junction) tree implemented in the [Julia language](http://www.julialang.org/) (and [JuliaPro](http://www.juliacomputing.com)). |
41 | | - |
42 | | - |
43 | | -Introduction |
44 | | -============ |
| 12 | +# Introduction |
45 | 13 |
|
46 | 14 | This package implements a few different non-Gaussian factor graph inference algorithms, primarily |
47 | | -- Multi-Modal iSAM (MM-iSAM) ([see references](http://www.juliarobotics.org/Caesar.jl/latest/refs/literature/)) which does hybrid non-parametric and parametric inference/state-estimation over large factor graphs. |
| 15 | +- Multi-Modal iSAM (MM-iSAM) ([see references][cjl-docs-refs]) which does hybrid non-parametric and parametric inference/state-estimation over large factor graphs. |
48 | 16 | - Batch Parametric (akin to conventional "non-linear least squares"), |
49 | 17 | - Max-mixtures parametric, |
50 | 18 | - Other multiparametric and non-Gaussian algorithms are in the works and will be announced in due course. |
51 | 19 |
|
52 | 20 | Fundamentally, inference is performed via the Bayes (junction) tree where Chapman-Kolmogorov transit integral solutions are based on marginal-joint belief estimation (a sum-product / belief-propagation approximation algorithm). Many benefits such as clique recycling are also available. See the common Caesar.jl documenation for more details. [![caesar-docs]][cjl-docs-url] |
53 | 21 |
|
54 | | -This package forms a cardinal piece of the [Caesar.jl](https://github.com/JuliaRobotics/Caesar.jl) robotics toolkit, including 3D visualization and database interaction, which can serve as a base station for a robotic platform. A standalone Robot Motion Estimate ([RoME.jl](https://github.com/JuliaRobotics/RoME.jl)) package extends the available variables, factors, and utilities for use in robotic navigation. [![iif-deps-img]][iif-deps-jlh] |
| 22 | +This package forms a cardinal piece of the [Caesar.jl][cjl-url] robotics toolkit, including 3D visualization and database interaction, which can serve as a base station for a robotic platform. A standalone Robot Motion Estimate ([RoME.jl][rjl-url]) package extends the available variables, factors, and utilities for use in robotic navigation. [![iif-deps-img]][iif-deps-jlh] |
55 | 23 |
|
56 | 24 | Note, that IncrementalInference.jl **does not** have to be used with RoME.jl / Caesar.jl -- IncrementalInference.jl only implements the algebraic inference operations against mathematical abstractions such as Manifolds.jl. |
57 | 25 |
|
58 | | -Furthermore, please contact info@navability.io for more formal support on this package, [NavAbility.io](https://www.navability.io). |
| 26 | +Furthermore, please contact info@wherewhen.ai for more formal support on this package, [NavAbility(TM) by WhereWhen.ai Technologies Inc.][wwai-url]. |
59 | 27 |
|
60 | | -Installation |
61 | | ------------- |
| 28 | +# Examples |
| 29 | + |
| 30 | +See the common Caesar.jl documenation for more details [![caesar-docs]][cjl-docs-url]. Further examples can be found in the examples and test folders. |
| 31 | + |
| 32 | +## Installation |
62 | 33 |
|
63 | 34 | Install the package from inside Julia |
64 | 35 | ```julia |
65 | | -(v1.6) pkg> add IncrementalInference |
| 36 | +pkg> add IncrementalInference |
66 | 37 | ``` |
67 | 38 |
|
| 39 | +# Cite and Contributors |
| 40 | + |
| 41 | +We are grateful for many, many contributions within the Julia package ecosystem -- see the [`Project.toml`](https://github.com/JuliaRobotics/Caesar.jl/blob/master/Project.toml) files for a far reaching list of upstream packages and contributions. |
| 42 | + |
| 43 | +Consider citing our work using the common reference at [Caesar.jl Citation with IncrementalInference.jl DOI](https://github.com/JuliaRobotics/Caesar.jl#contributors) |
| 44 | + |
| 45 | +## Get Involved, and Code of Conduct |
| 46 | + |
| 47 | +This project adheres to the [JuliaRobotics code of conduct](https://github.com/JuliaRobotics/administration/blob/master/code_of_conduct.md), and we invite contributions or comments from the community. Use the slack channel, Julia Discourse, or Github issues to get in touch. |
| 48 | + |
| 49 | +# References |
| 50 | + |
| 51 | +See [references of interest here][cjl-docs-refs] |
| 52 | + |
| 53 | +## Legacy |
| 54 | + |
68 | 55 | Pre-install the following packages system wide packages[, and easily draw factor graph and Bayes tree]: |
69 | 56 | ```bash |
70 | 57 | sudo apt-get install hdf5-tools |
71 | 58 | sudo apt-get install graphviz xdot # optional |
72 | 59 | ``` |
73 | 60 |
|
74 | | -Examples |
75 | | -======== |
76 | 61 |
|
77 | | -See the common Caesar.jl documenation for more details [![caesar-docs]][cjl-docs-url]. Further examples can be found in the examples and test folders. |
| 62 | +[iif-deps-img]: https://juliahub.com/docs/IncrementalInference/deps.svg |
| 63 | +[iif-deps-jlh]: https://juliahub.com/ui/Packages/IncrementalInference/NrVw2??page=2 |
| 64 | +[doi-img]: https://zenodo.org/badge/DOI/10.5281/zenodo.5146221.svg |
| 65 | +[doi-url]: https://doi.org/10.5281/zenodo.5146221 |
78 | 66 |
|
79 | | -Cite and Contributors |
80 | | -===================== |
| 67 | +[dfg-docs]: https://img.shields.io/badge/DFGDocs-latest-blue.svg |
| 68 | +[dfg-docs-url]: https://juliarobotics.org/DistributedFactorGraphs.jl/latest/ |
81 | 69 |
|
82 | | -We are grateful for many, many contributions within the Julia package ecosystem -- see the [`Project.toml`](https://github.com/JuliaRobotics/Caesar.jl/blob/master/Project.toml) files for a far reaching list of upstream packages and contributions. |
| 70 | +<!-- replicated in Caesar.jl README --> |
| 71 | +[iif-ci-dev-img]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml/badge.svg |
| 72 | +[iif-ci-dev-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml |
| 73 | +[iif-ci-stb-img]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml/badge.svg?branch=release%2Fv0.26 |
| 74 | +[iif-ci-stb-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/actions/workflows/ci.yml |
| 75 | +[iif-ver-img]: https://juliahub.com/docs/IncrementalInference/version.svg |
| 76 | +[iif-rel-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/releases |
| 77 | +[iif-milestones]: https://github.com/JuliaRobotics/IncrementalInference.jl/milestones |
| 78 | +[iif-cov-img]: https://codecov.io/github/JuliaRobotics/IncrementalInference.jl/coverage.svg?branch=master |
| 79 | +[iif-cov-url]: https://codecov.io/github/JuliaRobotics/IncrementalInference.jl?branch=master |
83 | 80 |
|
84 | | -Consider citing our work using the common reference at [Caesar.jl Citation with IncrementalInference.jl DOI](https://github.com/JuliaRobotics/Caesar.jl#contributors) |
| 81 | +[iif-commits-url]: https://img.shields.io/github/commit-activity/y/JuliaRobotics/IncrementalInference.jl.svg?color=dark-green |
| 82 | +[contributors-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/graphs/contributors |
| 83 | +[issues-time]: https://isitmaintained.com/badge/resolution/JuliaRobotics/IncrementalInference.jl.svg |
| 84 | +[issues-open]: https://isitmaintained.com/badge/open/JuliaRobotics/IncrementalInference.jl.svg |
| 85 | +[issues-url]: https://github.com/JuliaRobotics/IncrementalInference.jl/issues |
85 | 86 |
|
86 | | -Get Involved, and Code of Conduct |
87 | | ---------------------------------- |
| 87 | +[rjl-url]: https://github.com/JuliaRobotics/RoME.jl |
88 | 88 |
|
89 | | -This project adheres to the [JuliaRobotics code of conduct](https://github.com/JuliaRobotics/administration/blob/master/code_of_conduct.md), and we invite contributions or comments from the community. Use the slack channel, Julia Discourse, or Github issues to get in touch. |
| 89 | +[cjl-url]: https://github.com/JuliaRobotics/Caesar.jl |
| 90 | +[caesar-docs]: https://img.shields.io/badge/CaesarDocs-latest-blue.svg |
| 91 | +[cjl-docs-url]: http://juliarobotics.github.io/Caesar.jl/latest/ |
| 92 | +[cjl-docs-refs]: http://www.juliarobotics.org/Caesar.jl/latest/refs/literature/ |
90 | 93 |
|
91 | | -References |
92 | | -========== |
| 94 | +[cjl-slack-badge]: https://img.shields.io/badge/Caesarjl-Slack-green.svg?style=popout |
| 95 | +[cjl-slack]: https://join.slack.com/t/caesarjl/shared_invite/zt-ucs06bwg-y2tEbddwX1vR18MASnOLsw |
93 | 96 |
|
94 | | -See [references of interest here](http://www.juliarobotics.org/Caesar.jl/latest/refs/literature/) |
| 97 | +[jlorg-url]: http://www.julialang.org/ |
| 98 | +[wwai-url]: https://www.wherewhen.ai |
0 commit comments