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.

Sign up for GitHub

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

Jump to bottom

Update documentation for Job deprecation #577

Merged
merged 8 commits into from
Feb 10, 2020
Merged

Update documentation for Job deprecation #577

merged 8 commits into from
Feb 10, 2020

Conversation

uellue
Copy link
Member

@uellue uellue commented Feb 5, 2020

  • Update documentation and docstrings
  • Move Task from Job to UDF code base
  • Fix RawFFT that was broken from making UDF the default back-end
  • Improve RawFFT tests to catch such issues in the future
  • Drive-by change: Dask to >=2.2.0 and fix of parameter name

Contributor Checklist:

@uellue
Detailed description for Job API deprecation
aec71f1
@uellue
Change in argument name for distributed
47a4b66 
See dask/distributed#2900
@uellue
Port rawfft to UDF; add tests
64e4c15 
* Use UDF back-end and disable JOB back-end
* Test for actual FFT
@uellue
Deprecate Job API
88be79e 
* Trigger warning message when instantiating a Job
* Update documentation and docstrings
* Move Task from Job to UDF code base
* Detailed info in changelog
@uellue uellue mentioned this pull request Feb 5, 2020
Closed
13 tasks
@codecov
Copy link

codecov bot commented Feb 5, 2020 •
edited
Loading

Codecov Report

Merging #577 into master will decrease coverage by 14.73%.
The diff coverage is 96.55%.

Impacted file tree graph

@@             Coverage Diff             @@
##           master     #577       +/-   ##
===========================================
- Coverage   73.84%   59.11%   -14.74%     
===========================================
  Files          89      208      +119     
  Lines        6622     8357     +1735     
  Branches      827     1073      +246     
===========================================
+ Hits         4890     4940       +50     
- Misses       1534     3216     +1682     
- Partials      198      201        +3
Impacted Files Coverage Δ
src/libertem/udf/holography.py 91.83% <ø> (ø) ⬆️
src/libertem/udf/blobfinder/utils.py 34.09% <ø> (ø) ⬆️
src/libertem/web/connect.py 87.17% <ø> (ø) ⬆️
src/libertem/udf/crystallinity.py 87.87% <ø> (ø) ⬆️
src/libertem/udf/feature_vector_maker.py 80.55% <ø> (ø) ⬆️
src/libertem/analysis/masks.py 100% <ø> (ø) ⬆️
src/libertem/udf/FEM.py 100% <ø> (ø) ⬆️
src/libertem/analysis/raw.py 95.91% <ø> (ø) ⬆️
src/libertem/api.py 87.31% <100%> (+0.29%) ⬆️
src/libertem/job/masks.py 91.01% <100%> (+0.1%) ⬆️
... and 128 more

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 ba17400...76f07ea. Read the comment docs.

sk1p
sk1p requested changes Feb 6, 2020
View reviewed changes
Copy link
Member

@sk1p sk1p left a comment

Choose a reason for hiding this comment

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

Thanks for the PR! See some comments inline, especially important is a good user experience, which includes specific and actionable deprecation warnings, best via the default Python warnings facility.

test_requirements.txt Outdated Show resolved Hide resolved
src/libertem/job/raw.py Outdated Show resolved Hide resolved
src/libertem/job/base.py Outdated Show resolved Hide resolved
src/libertem/job/base.py Outdated Show resolved Hide resolved
src/libertem/api.py Outdated Show resolved Hide resolved
docs/source/changelog.rst Show resolved Hide resolved
docs/source/changelog.rst Outdated Show resolved Hide resolved
src/libertem/job/base.py Outdated Show resolved Hide resolved
@sk1p sk1p added this to the 0.4 milestone Feb 6, 2020
@uellue
Review @sk1p, thx! :-)
ddc9bd0 
* Link to classes and methods
* Deprecation info extended
* Use warnings module
* Tip on how to show DeprecationWarning in Jupyter etc
@uellue
Correct reference
771dd25
uellue added a commit to uellue/LiberTEM that referenced this pull request Feb 7, 2020
@uellue
Info on restructuring in changelog
981ae53 
Based on LiberTEM#577
@uellue uellue mentioned this pull request Feb 7, 2020
Merged
2 tasks
@sk1p
Copy link
Member

sk1p commented Feb 10, 2020

CI failure is because of intersphinx failing to fetch numpy inventory file. Docs should be fine, as docs-check ran successfully.

@sk1p
Copy link
Member

sk1p commented Feb 10, 2020

Looks good, thanks!

@sk1p sk1p merged commit 1c42a8c into LiberTEM:master Feb 10, 2020
uellue added a commit to uellue/LiberTEM that referenced this pull request Feb 11, 2020
@uellue
Info on restructuring in changelog
7f79bfb 
Based on LiberTEM#577
sk1p pushed a commit that referenced this pull request Feb 11, 2020
@uellue @sk1p
Info on restructuring in changelog
02176f7 
Based on #577
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sk1p sk1p sk1p approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
0.4
Development

Successfully merging this pull request may close these issues.
2 participants
@uellue @sk1p