-
-
Notifications
You must be signed in to change notification settings - Fork 14
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
[DOC] Add Quantile forest examples #147
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #147 +/- ##
=======================================
Coverage 89.66% 89.66%
=======================================
Files 41 41
Lines 3367 3367
=======================================
Hits 3019 3019
Misses 348 348 ☔ View full report in Codecov by Sentry. |
The 4 rendered artifacts: https://output.circle-artifacts.com/output/job/5db6e8d1-7cbe-4795-80d5-bbe5ab46dde6/artifacts/0/dev/use.html @SUKI-O perhaps we can put this into its own section? I.e. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great start and very encouraging that the simulations look very similar to those in quantile-forests
.
Can you try to break up each example to make them easier to read?
For example, see the following example: https://output.circle-artifacts.com/output/job/5db6e8d1-7cbe-4795-80d5-bbe5ab46dde6/artifacts/0/dev/auto_examples/outlier_detection/plot_extended_isolation_forest.html#sphx-glr-auto-examples-outlier-detection-plot-extended-isolation-forest-py
In addition, perhaps we can be more explicit about what each example should show. What is the take-away message? E.g. in the right-skewed simulation, is it that QORF is better than standard ORF? What does better mean?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good after removing the print statements that @adam2392 referenced
I don't see the examples rendered now so there's probably an error in your change. You can leverage the development guide to build the docs locally for yourself to peruse. |
You are probably missing a section header which is rendered from the README files inside each subsection |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know the examples are copied "as-is" from quantile-forests, but I think their documentation is not as comprehensive as I would've liked.
The examples could use a bit more explanation. Otherwise, someone reading these have no idea how to interpret the results, or the figures. WDYT @SUKI-O @sampan501 @PSSF23 ?
Co-authored-by: Adam Li <adam2392@gmail.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the only thing missing is a few comments about what exactly you are plotting and how to interpret the plots and we should be good to go
examples/quantile_predictions/plot_quantile_regression_intervals_with_RF.py
Show resolved
Hide resolved
examples/quantile_predictions/plot_quantile_vs_standard_oblique_forest.py
Show resolved
Hide resolved
examples/quantile_predictions/plot_quantile_vs_standard_oblique_forest.py
Outdated
Show resolved
Hide resolved
examples/quantile_predictions/plot_quantile_interpolation_with_RF.py
Outdated
Show resolved
Hide resolved
examples/quantile_predictions/plot_quantile_interpolation_with_RF.py
Outdated
Show resolved
Hide resolved
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Few minor changes and then LGTM.
Generally, it's useful to render the docs locally to see if there's any formatting issues.
…e_forest.py Co-authored-by: Adam Li <adam2392@gmail.com>
…_RF.py Co-authored-by: Adam Li <adam2392@gmail.com>
…_RF.py Co-authored-by: Adam Li <adam2392@gmail.com>
Fixes #87
Changes proposed in this pull request:
Before submitting
section of the
CONTRIBUTING
docs.Writing docstrings section of the
CONTRIBUTING
docs.After submitting