tobac icon indicating copy to clipboard operation
tobac copied to clipboard

Added more documentation for dealing with big datasets

Open freemansw1 opened this issue 1 year ago • 3 comments

Added more details to our documentation around dealing with big datasets, including a new example notebook of running feature detection in parallel.

With @RBhupi from tobathon February 2024

  • [x] Have you followed our guidelines in CONTRIBUTING.md?
  • [x] Have you self-reviewed your code and corrected any misspellings?
  • [x] Have you written documentation that is easy to understand?
  • [x] Have you written descriptive commit messages?
  • [ ] Have you added NumPy docstrings for newly added functions?
  • [ ] Have you formatted your code using black?
  • [ ] If you have introduced a new functionality, have you added adequate unit tests?
  • [x] Have all tests passed in your local clone?
  • [x] If you have introduced a new functionality, have you added an example notebook?
  • [x] Have you kept your pull request small and limited so that it is easy to review?
  • [x] Have the newest changes from this branch been merged?

freemansw1 avatar Feb 16 '24 22:02 freemansw1

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 60.91%. Comparing base (57612ec) to head (e85c446). Report is 18 commits behind head on RC_v1.5.x.

Additional details and impacted files
@@            Coverage Diff             @@
##           RC_v1.5.x     #408   +/-   ##
==========================================
  Coverage      60.91%   60.91%           
==========================================
  Files             23       23           
  Lines           3541     3541           
==========================================
  Hits            2157     2157           
  Misses          1384     1384           
Flag Coverage Δ
unittests 60.91% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Feb 16 '24 22:02 codecov[bot]

Linting results by Pylint:

Your code has been rated at 8.70/10 (previous run: 8.70/10, +0.00) The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.5.x branch. A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.

github-actions[bot] avatar Feb 16 '24 22:02 github-actions[bot]

I'm ready for a review!

freemansw1 avatar May 09 '24 21:05 freemansw1

Ok, @fsenf, I believe I've addressed your comments and I am now ready for a re-review.

freemansw1 avatar Jul 24 '24 13:07 freemansw1