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 warning in transit tuto on SequenceParallel API #140

Open
lgrcia opened this issue Oct 11, 2023 · 3 comments
Open

Add warning in transit tuto on SequenceParallel API #140

lgrcia opened this issue Oct 11, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation

Comments

@lgrcia
Copy link
Owner

lgrcia commented Oct 11, 2023

At the end of https://prose.readthedocs.io/en/latest/ipynb/casestudies/transit.html#multiprocessing-alternative , put a warning about the data_blocks like:

If not passed as data_blocks (second attribute of SequenceParallel), a block will not retain attributes. Any blocks whose attributes must be accessed (like GetFluxes or SelectiveStack) must be in the data_blocks list.

@lgrcia
Copy link
Owner Author

lgrcia commented Oct 11, 2023

@mathtimm do you think that sentence helps? Just as to make the info pop out (everyone miss that)

@lgrcia lgrcia added the documentation Improvements or additions to documentation label Oct 11, 2023
@lgrcia
Copy link
Owner Author

lgrcia commented Oct 11, 2023

Also add how to acces the fluxes in the data_blocks with .data[i] so that user know the difference with Sequence. There should be a link to this last section in the SequenceParallel docstrings (because it is more illustrative)

@mathtimm
Copy link
Collaborator

mathtimm commented Oct 11, 2023

@mathtimm do you think that sentence helps? Just as to make the info pop out (everyone miss that)

Yes, definitely, and it would be nice to also show in the tutorial how to access it, just like you said: fluxes: Fluxes = faster_photometry.data[-1].fluxes

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants