Skip to content

Added/expanded performance tips - #8096

Merged
bsipocz merged 18 commits into
astropy:masterfrom
astrofrog:performance-tips
Nov 13, 2018
Merged

bsipocz merged 18 commits into
astropy:masterfrom
astrofrog:performance-tips

Conversation

@astrofrog

@astrofrog astrofrog commented Nov 9, 2018 •

Copy link
Copy Markdown
Member

Prior to this PR there weren't actually many performance tips, and I feel like the ones that were there were written as if to an expert audience. I think we should really aim to include tips that may seem like stating the obvious but that we can point general users to - for example, use SkyCoord with arrays, etc.

This PR is an attempt to populate some of the performance tips sections, and also re-writes the units one in a more user-friendly way since that is one of the most common ones. I've also commented out sections that are not populated right now since otherwise users will see a section that says 'this section includes tips' with nothing in them yet.

@adrn @eteq @StuartLittlefair @taldcroft @saimn @MSeifert04 @drdavella @crawfordsm @larrybradley @mhvk - you are all maintainers on sub-packages where I have added/expanded tips, so this is just to let you know in case you want to review/expand with other tips.

If you'd like to add more tips, you can just open a PR to my branch if you like (to avoid conflicts in master)

In the interest of time, I think we should just merge this once we are ready to do the RC.

@astropy-bot

astropy-bot Bot commented Nov 9, 2018 •

Copy link
Copy Markdown

Hi there @astrofrog 👋 - thanks for the pull request! I'm just a friendly 🤖 that checks for issues related to the changelog and making sure that this pull request is milestoned and labeled correctly. This is mainly intended for the maintainers, so if you are not a maintainer you can ignore this, and a maintainer will let you know if any action is required on your part 😃.

Everything looks good from my point of view! 👍

If there are any issues with this message, please report them here.

@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
@astropy astropy deleted a comment from astropy-bot Bot Nov 9, 2018
Comment thread docs/modeling/performance.inc.rst Resolved
@codecov

codecov Bot commented Nov 9, 2018 •

Copy link
Copy Markdown

Codecov Report

Merging #8096 into master will decrease coverage by <.01%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##           master    #8096      +/-   ##
==========================================
- Coverage   86.92%   86.92%   -0.01%     
==========================================
  Files         383      383              
  Lines       57821    57834      +13     
  Branches     1056     1056              
==========================================
+ Hits        50262    50271       +9     
- Misses       6945     6949       +4     
  Partials      614      614
Impacted Files Coverage Δ
astropy/stats/funcs.py 89.54% <0%> (-0.87%) ⬇️
astropy/nddata/nduncertainty.py 93.1% <0%> (-0.29%) ⬇️
astropy/wcs/src/wcslib_wrap.c 65.67% <0%> (ø) ⬆️
astropy/stats/bls/methods.py 100% <0%> (ø) ⬆️
astropy/convolution/kernels.py 97.38% <0%> (ø) ⬆️
astropy/stats/bls/bls.c 85.88% <0%> (+0.69%) ⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 3e57b96...8e7c4d7. Read the comment docs.

Comment thread docs/convolution/performance.inc.rst Resolved

@mhvk mhvk left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@astrofrog - thanks very much for taking this on! I checked coordinates (very clear) and units (one small comment).

Comment thread docs/units/performance.inc.rst Resolved
Comment thread docs/io/fits/performance.inc.rst Resolved
@bsipocz bsipocz added the zzz 💤 merge-when-ci-passes Do not use: We have auto-merge option now. label Nov 13, 2018

Here we provide some tips and tricks for how to optimize performance of code
using `astropy.constants`.
.. Performance Tips

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

shouldn't we just remove this file?

@bsipocz
bsipocz merged commit 7080202 into astropy:master Nov 13, 2018
@bsipocz

bsipocz commented Nov 13, 2018

Copy link
Copy Markdown
Member

I go ahead and merge this, but in a follow-up PR we may want to consider to remove the empty performance files rather than commenting out the generic content?

@bsipocz

bsipocz commented Nov 13, 2018 •

Copy link
Copy Markdown
Member

Thank you @astrofrog and @nden and @mwcraig!

bsipocz added a commit that referenced this pull request Nov 13, 2018
@astrofrog
astrofrog deleted the performance-tips branch November 14, 2018 15:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants