Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README.md #181

Merged
merged 4 commits into from
Jan 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@
|:-------------------------------------------------------------------------:|:------------------------------------------------------:|:---------------------------------------:|
| [![][docs-stable-img]][docs-stable-url] [![][docs-dev-img]][docs-dev-url] | [![CI][ci-img]][ci-url] [![Aqua][aqua-img]][aqua-url] | [![CodeCov][codecov-img]][codecov-url] |

[ci-img]: https://github.com/biaslab/ExponentialFamily.jl/actions/workflows/CI.yml/badge.svg?branch=main
[ci-url]: https://github.com/biaslab/ExponentialFamily.jl/actions
[ci-img]: https://github.com/reactivebayes/ExponentialFamily.jl/actions/workflows/CI.yml/badge.svg?branch=main
[ci-url]: https://github.com/reactivebayes/ExponentialFamily.jl/actions

[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-dev-url]: https://biaslab.github.io/ExponentialFamily.jl/dev
[docs-dev-url]: https://reactivebayes.github.io/ExponentialFamily.jl/dev

[codecov-img]: https://codecov.io/gh/biaslab/ExponentialFamily.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/biaslab/ExponentialFamily.jl?branch=main
[codecov-img]: https://codecov.io/gh/reactivebayes/ExponentialFamily.jl/branch/main/graph/badge.svg
[codecov-url]: https://codecov.io/gh/reactivebayes/ExponentialFamily.jl?branch=main

[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
[docs-stable-url]: https://biaslab.github.io/ExponentialFamily.jl/stable
[docs-stable-url]: https://reactivebayes.github.io/ExponentialFamily.jl/stable

[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
[aqua-url]: https://github.com/JuliaTesting/Aqua.jl
Expand All @@ -32,7 +32,7 @@ ExponentialFamily.jl is a Julia package that extends the functionality of Distri

- **Fisher Information**: ExponentialFamily.jl also offers computation of the [Fisher Information (FI)](https://en.wikipedia.org/wiki/Fisher_information) for various distributions. FI is a crucial quantity in statistical inference, providing insights into the sensitivity of a model's parameters to changes in the data. Essentially FI is the hessian of logpartition with respect to vectorized natural parameters. FI allows users to gain a deeper understanding of the behavior and performance of their probabilistic models.

Read more about the package in the [documentation](https://biaslab.github.io/ExponentialFamily.jl/stable/).
Read more about the package in the [documentation](https://reactivebayes.github.io/ExponentialFamily.jl/stable/).

## Installation
ExponentialFamily.jl can be installed through the Julia package manager. In the Julia REPL, type `]` to enter the package manager mode and run:
Expand All @@ -42,4 +42,4 @@ pkg> add ExponentialFamily

# License

[MIT License](LICENSE) Copyright (c) 2023-2024 BIASlab
[MIT License](LICENSE) Copyright (c) 2023-2024 BIASlab, 2024-present ReactiveBayes
4 changes: 2 additions & 2 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,6 @@ makedocs(

if get(ENV, "CI", nothing) == "true"
deploydocs(
repo = "github.com/biaslab/ExponentialFamily.jl.git"
repo = "github.com/ReactiveBayes/ExponentialFamily.jl.git"
)
end
end
4 changes: 2 additions & 2 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ prod(PreserveTypeProd(ExponentialFamilyDistribution), prior, likelihood)

Note that the result does not correspond to the `Laplace` distribution and returns a generic univariate `ExponentialFamilyDistribution`.
This approach ensures consistency and compatibility, especially when dealing with a wide range of probability distributions.
Refer to the [`BayesBase`](https://github.com/biaslab/BayesBase.jl) for the documentation about available product strategies.
Refer to the [`BayesBase`](https://github.com/ReactiveBayes/BayesBase.jl) for the documentation about available product strategies.

## Computing various useful attributes of an exponential family member

Expand Down Expand Up @@ -130,4 +130,4 @@ fisherinformation_of_gamma_in_natural_space(gamma_parameters_in_natural_space)

## Approximating attributes

Refer to the [`ExpectationApproximations.jl`](https://github.com/biaslab/ExpectationApproximations.jl) package for approximating various attributes of the members of the exponential family.
Refer to the [`ExpectationApproximations.jl`](https://github.com/ReactiveBayes/ExpectationApproximations.jl) package for approximating various attributes of the members of the exponential family.
2 changes: 1 addition & 1 deletion test/distributions/gamma_family/gamma_shape_rate_tests.jl
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ end
@test pdf(dist3, 1.0) ≈ 0.5413411329464508
@test logpdf(dist3, 1.0) ≈ -0.6137056388801094

# see https://github.com/biaslab/ReactiveMP.jl/issues/314
# see https://github.com/ReactiveBayes/ReactiveMP.jl/issues/314
dist = GammaShapeRate(257.37489915581654, 3.0)
@test pdf(dist, 86.2027941354432) == 0.07400338986721687
end
Expand Down
Loading