Improve tutorials; update docs with new features

[janfb]

Description:

As part of our ongoing effort to ensure that our documentation is both user-friendly and current, we're seeking contributors, especially those new to SBI and our package, to review and potentially update our documentation. This task is an excellent opportunity for newcomers to familiarize themselves with SBI and contribute to the community.

The review should focus on several key areas of our documentation to ensure that it is accessible, straightforward, and useful for both new and existing users. Specifically, we are looking for feedback and improvements on the following:

• Readability of the README: Is the README document easy to understand? Does it effectively communicate what the package is about and how to get started?

• Clarity of Installation Instructions: Are the installation instructions clear and precise? Can a new user follow them without running into issues? Is the installation process smooth across different operating systems?

• Usability of the Getting Started Tutorial: Is the Getting Started tutorial easy to understand and follow? Does it serve as a helpful introduction to the package and its core functionalities?

• General Feedback on Other Tutorials: Beyond the Getting Started tutorial, we are interested in general feedback on our other tutorials. Are they informative? Do they cover the necessary topics effectively? Are there any areas of confusion or improvement? Do you miss some tutorials?

To contribute, please follow these steps:

1. Review the documentation sections mentioned above.
2. Open an issue with your feedback, categorizing it according to the checklist provided below.
3. If possible, propose changes or updates to address the issues identified.

Checklist:

• Readability of the README:
  • [x] #999
  • [x] Does it effectively communicate what the package is about and how to get started?
  • [x] Is the README up to date? Would you like to add something?
  • Clarity of Installation Instructions:
  • [x] Are the installation instructions clear and precise?
  • [x] Are the contribution guidelines and the setup for contributing clear?
  • Usability of the Getting Started Tutorial:
  • [x] Is the Getting Started tutorial easy to understand and follow?
  • [x] Does it serve as a helpful introduction to the package and its core functionalities?
  • General Feedback on Other Tutorials:
  • [ ] Are the other tutorials informative?
  • [ ] Do they cover the necessary topics effectively?
  • [ ] Are there any areas of confusion or improvement?
  • [ ] Is it complette? Do important features have an associated tutorial?

We appreciate your contributions to making SBI's documentation better for everyone. Thank you for your support!

[augustes]

Great that you labelled it good first issue - I'd be happy to do that!!

[alvorithm]

@augustes we created a lot of tutorial-like material (some of it hands on!) during the 2021 sbi workshop -- some of it might be helpful?

About the workshop (including links to participant feedback): https://mlcolab.org/thoughts-on-our-simulation-based-inference-workshop

The tutorials: https://github.com/mlcolab/sbi-workshop

[augustes]

great, that is good to know. I will check it out - it would be great to incorporate some if they are nonoverlapping. I'll keep this in mind next week. Thanks for the heads-up!

On Fri, 15 Mar 2024 at 16:49, Álvaro Tejero-Cantero < @.***> wrote:

@augustes https://github.com/augustes we created a lot of tutorial-like material (some of it hands on!) during the 2021 sbi workshop -- some of it might be helpful?

About the workshop (including links to participant feedback): https://mlcolab.org/thoughts-on-our-simulation-based-inference-workshop

The tutorials: https://github.com/mlcolab/sbi-workshop

— Reply to this email directly, view it on GitHub https://github.com/sbi-dev/sbi/issues/935#issuecomment-1999950135, or unsubscribe https://github.com/notifications/unsubscribe-auth/AF4JKDLDYYQWMQM4CTHNWGTYYMJ7ZAVCNFSM6AAAAABDGNSJ7SVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMYTSOJZHE2TAMJTGU . You are receiving this because you were mentioned.Message ID: @.***>

[augustes]

Readability of the README: Is the README document easy to understand? Does it effectively communicate what the package is about and how to get started?

Clarity of Installation Instructions: Are the installation instructions clear and precise? Can a new user follow them without running into issues? Is the installation process smooth across different operating systems?

Readability of the README:

• [x] Is the README document easy to understand?

• yes it's great until the point inference algorithms (previously you just mention posterior and then a lot of different methods such as MNLE are listed, later on) Without knowledge how these are linked this could be confusing for newcomers.

• I changed word tutorial to instructions as that can be very frustrating when one expects a tutorial and it is just loading different inference methods. It should be clear before that that there are other tutorials as an entry point

• I added a tutorial section before that directs one to tutorials because you both have an example and tutorial folder.

• [x] Does it effectively communicate what the package is about and how to get started?

• yes but see tutorial getting started comment above

• [x] Is the README up to date? Would you like to add something?

• broken link to miniconda (fixed in md)

• installation python version too old (fixed in md)

• add GPU CPU info (fixed in md)

• [x] Inference algorithms might need updating check depending on what we add in the hackerthon in case more inference algorithms will be supported

• [x] Support - might need to get updated soon

• [x] License - will need to be updated here once transition complete

[plcrodrigues]

Hi there, I would like to propose extending a bit more the guide for contributions for sbi. I thought about getting inspiration from the guides from sklearn and mne. However, I don't understand if this issue is closed or not and whether the contribution that I propose should be done here or elsewhere.

[janfb]

Yes, that's a good idea @plcrodrigues! This issue here is more a collection of many different issues. Please create a separate one for improving the contribution guidelines, or create PR with the motivation that just mentions this issue. Thanks 🙏

[augustes]

Regarding the tuorials we currently have a few open issues to make them more consistent. Once that is completeted, the website needs to be adjusted accordingly. The newest papers also need to get added to the website (current cut off 2022)

[janfb]

Many points in this issue have been solved. Here is a checklist for closing it before the release: These fixes should probably go into #1147

• [x] update papers, e.g., add flow matching and score matching once implemented. Is TSNPE and MNLE in there?
• [x] Execute all tutorials with the release-code and fix potential API changes, e.g., pairplot upper vs offdiag,
• [x] Add new methods to implemented methods tutorial

[janfb]

closed with #1232