Skip to content

Commit dbcd06b

Browse files
authored
docs: add readme intro to docs landing page (#1272)
1 parent b0b5671 commit dbcd06b

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,8 @@
1414
both researchers and practitioners. Whether you need fine-grained control or an
1515
easy-to-use interface, `sbi` has you covered.
1616

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

docs/docs/index.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,15 @@
11
# `sbi`: simulation-based inference toolkit
22

3+
`sbi` is a Python package for simulation-based inference, designed to meet the needs of
4+
both researchers and practitioners. Whether you need fine-grained control or an
5+
easy-to-use interface, `sbi` has you covered.
6+
7+
With `sbi`, you can perform parameter inference using Bayesian inference: Given a
8+
simulator that models a real-world process, SBI estimates the full posterior
9+
distribution over the simulator’s parameters based on observed data. This distribution
10+
indicates the most likely parameter values while additionally quantifying uncertainty
11+
and revealing potential interactions between parameters.
12+
313
`sbi` provides access to simulation-based inference methods via a user-friendly
414
interface:
515

0 commit comments

Comments
 (0)