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

Add a new page for Examples Gallery #627

Merged
merged 10 commits into from
Jan 26, 2025

Conversation

rohanbabbar04
Copy link
Contributor

@rohanbabbar04 rohanbabbar04 commented Jan 11, 2025

Closes #520

Description

  • Moved distributions to distributions/gallery and distributions/img.
  • Set Up Examples Gallery with a basic/test example of Maximum Entropy.

Checklist

  • Code style is correct (follows ruff and black guidelines)
  • New features are properly documented (with an example if appropriate)

@rohanbabbar04 rohanbabbar04 marked this pull request as draft January 11, 2025 14:11
@rohanbabbar04
Copy link
Contributor Author

rohanbabbar04 commented Jan 25, 2025

@aloctavodia, I think we should move the examples in the Direct Elicitation and Predictive Elicitation files into the Examples Gallery, as they are functions in PreliZ. So we can completely remove the Examples tab.
For tutorials, we can set them up in the same way as we have done with the Examples.

What do you suggest?

@rohanbabbar04 rohanbabbar04 marked this pull request as ready for review January 25, 2025 09:09
@aloctavodia
Copy link
Contributor

aloctavodia commented Jan 25, 2025

I agree to remove the "example" tab in favour of the "example gallery". I suggest the following organization:

Currently, we have the following examples:

Working with distributions
Direct elicitation in 1D
Direct elicitation in ND
Predictive Elicitation
Global settings

We can divide them into 3 categories, each category will have one or more "cards" for separate examples

Direct elicitation --> Direct elicitation in 1D, Direct elicitation in ND
Predictive elicitation --> Predictive Elicitation. For the moment is ok to have a single card, but better to split it into two, and I have a third card/example I could add.
Not-sure-the-name --> Working with distributions, Global settings

In the future, we could add other categories like "Tutorial".

What do you think about adding an "external examples" Category. There we could list the following resources

@codecov-commenter
Copy link

codecov-commenter commented Jan 25, 2025

Codecov Report

Attention: Patch coverage is 0% with 1 line in your changes missing coverage. Please review.

Project coverage is 74.25%. Comparing base (f25da81) to head (b2bc01a).
Report is 93 commits behind head on main.

Files with missing lines Patch % Lines
preliz/internal/plot_helper.py 0.00% 1 Missing ⚠️

❗ There is a different number of reports uploaded between BASE (f25da81) and HEAD (b2bc01a). Click for more details.

HEAD has 1 upload less than BASE
Flag BASE (f25da81) HEAD (b2bc01a)
3 2
Additional details and impacted files
@@            Coverage Diff             @@
##             main     #627      +/-   ##
==========================================
- Coverage   82.23%   74.25%   -7.98%     
==========================================
  Files         101      105       +4     
  Lines        8020     8709     +689     
==========================================
- Hits         6595     6467     -128     
- Misses       1425     2242     +817     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@rohanbabbar04
Copy link
Contributor Author

rohanbabbar04 commented Jan 25, 2025

Changes implemented post our comments:

  1. Have removed the Examples sections, in favor of Examples Gallery.
  2. Shifting the already present Examples into the gallery , currently having three categories.(like we discussed in the last comment).
  3. Would need some advice/suggestions on the image displayed on the cards 😅.
  4. Have shifted all the distributions to the distributions folder, and all examples inside the examples folder.

Regarding the external examples, I will open a new PR once the initial gallery is setup...

@aloctavodia
Copy link
Contributor

This is great. I can replace the card images in a separated PR if you want. If we are going to display distributions, probably thicker lines would work better.

@rohanbabbar04
Copy link
Contributor Author

This is great. I can replace the card images in a separated PR if you want. If we are going to display distributions, probably thicker lines would work better.

Great!!
If all looks good, this is ready to be merged.

@aloctavodia aloctavodia merged commit 02aebd9 into arviz-devs:main Jan 26, 2025
3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Example gallery
3 participants