Add by_band kwarg to batch, allow each lightcurve band to be processed independently
#327
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
|
Check out this pull request on See visual diffs & provide feedback on Jupyter Notebooks. Powered by ReviewNB |
dougbrn
changed the title
by_band kwarg to batch, allow each lightcurve band to be processed independently
dougbrn
force-pushed
the
batch_per_band_attempt2
branch
from
9ba8df0 to
0efba3d
Compare
Codecov ReportAttention:
Additional details and impacted files@@ Coverage Diff @@
## main #327 +/- ##
==========================================
+ Coverage 94.56% 94.61% +0.04%
==========================================
Files 24 24
Lines 1510 1540 +30
==========================================
+ Hits 1428 1457 +29
- Misses 82 83 +1 ☔ View full report in Codecov by Sentry. |
hombit
reviewed
Dec 19, 2023
wilsonbb
reviewed
Dec 19, 2023
hombit
reviewed
Dec 20, 2023
src/tape/ensemble.py
Outdated
| @@ -1032,20 +1032,26 @@ def batch(self, func, *args, meta=None, use_map=True, compute=True, on=None, lab | |||
| the results. Overridden by TAPE for TAPE and `light-curve` | |||
| functions. If none, attempts to coerce the result to a | |||
| pandas.Series. | |||
| by_band: `boolean` | |||
There was a problem hiding this comment.
Could you please add here a sentence about output column names?
There was a problem hiding this comment.
I rewrote the sentence that tried to explain how the columns affected, let me know if that adds any clarity
hombit
reviewed
Dec 20, 2023
wilsonbb
approved these changes
Dec 20, 2023
hombit
approved these changes
Dec 20, 2023
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.
Resolves #317
Resolves #241
A bit of scope creep on this PR, the main purpose is to address #317, giving more support to users looking to apply a function to each band within a lightcurve within the batch interface. This is done by adding the
by_bandkwarg toEnsemble.batch, which makes sure that the band column is part of the groupby and also modifies the output to return an output column for each band. As a result, this also standardizes the output of batch to always return an EnsembleFrame object (even when this keyword is not used), where as previously in some cases it would return a series.I decided to go ahead with addressing #241 as part of this as well, removing the
computekwarg withinEnsemble.batch, I opted not to replace it with persist, as I believe that batch should just return a lazy object that users can chain into a compute or persist command as they see fit.I also went ahead and added a batch showcase tutorial as part of this PR, in that I tried to outline how this change actually is used, and also tried to be transparent about some issues regarding dataframe outputs.