Skip to content

Commit

Permalink
docs: add readme intro to docs landing page
Browse files Browse the repository at this point in the history
  • Loading branch information
janfb committed Sep 9, 2024
1 parent becc93c commit 84f1849
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 2 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@
both researchers and practitioners. Whether you need fine-grained control or an
easy-to-use interface, `sbi` has you covered.

With `sbi`, you can perform simulation-based inference (SBI) using a Bayesian approach:
Given a simulator that models a real-world process, SBI estimates the full posterior
With `sbi`, you can perform parameter inference using Bayesian inference: Given a
simulator that models a real-world process, SBI estimates the full posterior
distribution over the simulator’s parameters based on observed data. This distribution
indicates the most likely parameter values while additionally quantifying uncertainty
and revealing potential interactions between parameters.
Expand Down
10 changes: 10 additions & 0 deletions docs/docs/index.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,15 @@
# `sbi`: simulation-based inference toolkit

`sbi` is a Python package for simulation-based inference, designed to meet the needs of
both researchers and practitioners. Whether you need fine-grained control or an
easy-to-use interface, `sbi` has you covered.

With `sbi`, you can perform parameter inference using Bayesian inference: Given a
simulator that models a real-world process, SBI estimates the full posterior
distribution over the simulator’s parameters based on observed data. This distribution
indicates the most likely parameter values while additionally quantifying uncertainty
and revealing potential interactions between parameters.

`sbi` provides access to simulation-based inference methods via a user-friendly
interface:

Expand Down

0 comments on commit 84f1849

Please sign in to comment.