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

Features/783 api relational #792

Merged
merged 5 commits into from Jun 14, 2021
Merged

Features/783 api relational #792

merged 5 commits into from Jun 14, 2021

Conversation

lenablind
Copy link
Collaborator

@lenablind lenablind commented Jun 9, 2021

Aliases for comparison functions in heat.core.relational

This PR is motivated by the request in #774.
It is simply an extension of the current API in the corresponding module.
The following aliases have been implemented:

Original Alias
gt greater
ge greater_equal
lt less
le less_equal
ne not_equal

Issue/s resolved: #783

Changes proposed:

  • Aliases for the above listed functions
  • Corresponding tests for the functions

Type of change

  • New feature (non-breaking change which adds functionality)

Due Diligence

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

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

no

@codecov
Copy link

codecov bot commented Jun 9, 2021

Codecov Report

Merging #792 (afd0506) into master (3338b9d) will increase coverage by 0.00%.
The diff coverage is 100.00%.

Impacted file tree graph

@@           Coverage Diff           @@
##           master     #792   +/-   ##
=======================================
  Coverage   95.28%   95.29%           
=======================================
  Files          64       64           
  Lines        8934     8944   +10     
=======================================
+ Hits         8513     8523   +10     
  Misses        421      421           
Flag Coverage Δ
gpu 94.42% <100.00%> (+<0.01%) ⬆️
unit 90.85% <100.00%> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
heat/core/relational.py 100.00% <100.00%> (ø)

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 3338b9d...afd0506. Read the comment docs.

@coquelin77
Copy link
Member

rerun tests

Copy link
Member

@coquelin77 coquelin77 left a comment

Choose a reason for hiding this comment

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

why not simply point to the existing functions? there is a bit of extra work going on here

i.e.

greater_equal = ge
greater_equal.__doc__ = ge.__doc__

@lenablind
Copy link
Collaborator Author

why not simply point to the existing functions? there is a bit of extra work going on here

i.e.

greater_equal = ge
greater_equal.__doc__ = ge.__doc__

You are right, that makes absolutely more sense indeed. Thanks for the feedback! I'll change it right away.

@lenablind lenablind merged commit e3ac1c1 into master Jun 14, 2021
@lenablind lenablind deleted the features/783-api-relational branch June 14, 2021 13:31
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.

Aliases to existing functions: greater, greater_equal, less, less_equal, not_equal
2 participants