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

Added experimental annotation to fixes #22564 #22565

Merged
merged 2 commits into from
Aug 4, 2022

Conversation

ryanthompson591
Copy link
Contributor

@ryanthompson591 ryanthompson591 commented Aug 2, 2022

Adds experimental annotation to SklearnModelHandlerPandas and PytorchModelHandlerKeyedTensor.

New PTransforms that are experimental should be marked with an experimental annotation.
https://beam.apache.org/contribute/ptransform-style-guide/#compatibility

Though these are not PTransforms the annotation can generate warnings in logs.

fixes #22564

Thank you for your contribution! Follow this checklist to help us incorporate your contribution quickly and easily:

  • Choose reviewer(s) and mention them in a comment (R: @username).
  • Mention the appropriate issue in your description (for example: addresses #123), if applicable. This will automatically add a link to the pull request in the issue. If you would like the issue to automatically close on merging the pull request, comment fixes #<ISSUE NUMBER> instead.
  • Update CHANGES.md with noteworthy changes.
  • If this contribution is large, please file an Apache Individual Contributor License Agreement.

See the Contributor Guide for more tips on how to make review process smoother.

To check the build health, please visit https://github.com/apache/beam/blob/master/.test-infra/BUILD_STATUS.md

GitHub Actions Tests Status (on master branch)

Build python source distribution and wheels
Python tests
Java tests
Go tests

See CI.md for more information about GitHub Actions CI.

@github-actions github-actions bot added the python label Aug 2, 2022
@ryanthompson591
Copy link
Contributor Author

R: @yeandy @tvalentyn

@github-actions
Copy link
Contributor

github-actions bot commented Aug 2, 2022

Stopping reviewer notifications for this pull request: review requested by someone other than the bot, ceding control

@codecov
Copy link

codecov bot commented Aug 2, 2022

Codecov Report

Merging #22565 (c45dd84) into master (48513ad) will increase coverage by 0.04%.
The diff coverage is 50.00%.

@@            Coverage Diff             @@
##           master   #22565      +/-   ##
==========================================
+ Coverage   74.18%   74.22%   +0.04%     
==========================================
  Files         706      707       +1     
  Lines       93229    93299      +70     
==========================================
+ Hits        69159    69253      +94     
+ Misses      22802    22778      -24     
  Partials     1268     1268              
Flag Coverage Δ
python 83.60% <50.00%> (+0.05%) ⬆️

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

Impacted Files Coverage Δ
...thon/apache_beam/ml/inference/pytorch_inference.py 0.00% <0.00%> (ø)
...thon/apache_beam/ml/inference/sklearn_inference.py 95.45% <100.00%> (+0.21%) ⬆️
sdks/python/apache_beam/utils/interactive_utils.py 95.12% <0.00%> (-2.44%) ⬇️
...hon/apache_beam/runners/direct/test_stream_impl.py 93.28% <0.00%> (-0.75%) ⬇️
...eam/runners/portability/fn_api_runner/execution.py 92.44% <0.00%> (-0.65%) ⬇️
...eam/runners/interactive/interactive_environment.py 91.71% <0.00%> (-0.31%) ⬇️
sdks/python/apache_beam/io/fileio.py 95.98% <0.00%> (-0.28%) ⬇️
sdks/python/apache_beam/io/filesystem.py 88.67% <0.00%> (-0.09%) ⬇️
sdks/python/apache_beam/io/aws/s3io.py 84.42% <0.00%> (ø)
sdks/python/apache_beam/io/gcp/gcsio.py 92.26% <0.00%> (ø)
... and 5 more

📣 Codecov can now indicate which changes are the most critical in Pull Requests. Learn more

Copy link
Contributor

@yeandy yeandy left a comment

Choose a reason for hiding this comment

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

Can you remind me the behavior of this tag?

Do we need to remove this note from the docstring?

    **NOTE:** This API and its implementation are under development and
    do not provide backward compatibility guarantees.

@ryanthompson591 ryanthompson591 changed the title [22564] added experimental annotation to apis Added experimental annotation to fixes #22564 Aug 3, 2022
@ryanthompson591
Copy link
Contributor Author

@yeandy
This prints a message to the warning logs and doesn't modify doc strings.

@ryanthompson591
Copy link
Contributor Author

@tvalentyn I just tested out doc generation. Good thing because there was an odd doc generation behavior. To get around it, I had to set all, which I think is something we should do anyhow.

The experimental annotation doesn't do anything with doc generation at this point, I don't think we need to add todo's or anything, because when/if someone does make a change, they will need to make modifications themselves at that piont.

@tvalentyn
Copy link
Contributor

I had to set all,

I am not sure what you are referring to.

@ryanthompson591
Copy link
Contributor Author

Run Python PreCommit

@tvalentyn
Copy link
Contributor

Could you please check the failing test and file an issues if there is none filed at s.apache.org/beam-flakes ?

Thanks.

@tvalentyn tvalentyn merged commit c8d92b0 into apache:master Aug 4, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Task]: Add @experimental annotation to experimental ModelHandlers
3 participants