docs: add readme intro to docs landing page #1272
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1272 +/- ##
===========================================
- Coverage 89.24% 78.28% -10.96%
===========================================
Files 119 119
Lines 8691 8698 +7
===========================================
- Hits 7756 6809 -947
- Misses 935 1889 +954
Flags with carried forward coverage won't be shown. Click here to find out more. |
michaeldeistler
approved these changes
Sep 9, 2024
README.md
Outdated
| @@ -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 a Bayesian approach: Given a | |||
There was a problem hiding this comment.
maybe even just using Bayesian inference? No strong opinions though.
janfb
force-pushed
the
refactor-landing-page
branch
from
4e9f71f to
84f1849
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
At the moment, the docs website landing page starts a bit abruptly directly with the code snippet.
I think it is nice to have the same short intro text that we use in the updated readme as well.
What do you think?
In the future it would be nice to show a plot there as well.