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

504 docstring formatting #757

Merged
merged 256 commits into from
Apr 20, 2021
Merged

504 docstring formatting #757

merged 256 commits into from
Apr 20, 2021

Conversation

coquelin77
Copy link
Member

Description

New docstrings with custom formatting! major changes to almost every function. Special shoutout to @Cdebus for the organization and heavy lifting for these changes!

Issue/s resolved: #504

Changes proposed:

  • new docstring format
  • new docstring rendering
  • bugfix in sort

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Documentation update

Due Diligence

  • All split configurations tested
  • Multiple dtypes tested in relevant functions
  • Documentation updated
  • Updated changelog.md under the title "Pending Additions"

Does this change modify the behaviour of other functions? If so, which?

no

Charlie Debus and others added 30 commits May 28, 2020 10:35
@codecov
Copy link

codecov bot commented Apr 12, 2021

Codecov Report

Merging #757 (e1569a4) into master (7fa1607) will decrease coverage by 0.65%.
The diff coverage is 95.83%.

Impacted file tree graph

@@            Coverage Diff             @@
##           master     #757      +/-   ##
==========================================
- Coverage   95.87%   95.21%   -0.66%     
==========================================
  Files          64       64              
  Lines        8630     8717      +87     
==========================================
+ Hits         8274     8300      +26     
- Misses        356      417      +61     
Flag Coverage Δ
gpu 94.34% <95.83%> (-0.19%) ⬇️
unit 90.68% <95.46%> (+0.18%) ⬆️

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

Impacted Files Coverage Δ
heat/__init__.py 100.00% <ø> (ø)
heat/cluster/__init__.py 100.00% <ø> (ø)
heat/core/__init__.py 100.00% <ø> (ø)
heat/core/dndarray.py 96.02% <ø> (-0.47%) ⬇️
heat/core/linalg/__init__.py 100.00% <ø> (ø)
heat/core/types.py 96.00% <ø> (-0.36%) ⬇️
heat/core/version.py 87.50% <ø> (+1.78%) ⬆️
heat/graph/__init__.py 100.00% <ø> (ø)
heat/graph/laplacian.py 95.91% <ø> (+0.26%) ⬆️
heat/naive_bayes/__init__.py 100.00% <ø> (ø)
... and 78 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 7fa1607...e1569a4. Read the comment docs.

@coquelin77
Copy link
Member Author

rerun tests

@coquelin77 coquelin77 requested a review from Cdebus April 19, 2021 09:01
setup.py Outdated
@@ -40,8 +39,9 @@
"torchvision>=0.5.0",
Copy link
Collaborator

@mtar mtar Apr 19, 2021

Choose a reason for hiding this comment

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

outdated dependencies?

Copy link
Member Author

Choose a reason for hiding this comment

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

i think that torch would supersede this anyway, but it can be updated as well

Copy link
Member Author

Choose a reason for hiding this comment

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

i updated it to match the requirements of torch 1.7

Copy link
Collaborator

Choose a reason for hiding this comment

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

I mean all listed requirements. Many of them are not working with python3.7+. Only the last line came up here.

Copy link
Member Author

Choose a reason for hiding this comment

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

which ones dont work with 3.7?

Copy link
Collaborator

@mtar mtar Apr 19, 2021

Choose a reason for hiding this comment

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

numpy scipy mpi4py pillow; I had problems using the lowest version when I tried them on python 3.8

Copy link
Member Author

Choose a reason for hiding this comment

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

your package manager should take care of which is the best implementation which fits these requirements for your python version

Copy link
Contributor

@Cdebus Cdebus left a comment

Choose a reason for hiding this comment

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

I checked the rendering, looks good. We are ready for production

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

Successfully merging this pull request may close these issues.

documentation formatting
9 participants