DOC add type annotations to responsibleai package #1214

romanlutz · 2022-02-10T03:05:10Z

Description

Adding type annotations to the responsibleai package wherever there was anything Optional. Would we want these for the required args as well? Also fixing a few smaller formatting inconsistencies and typos in the process.

Areas changed

npm packages changed:

Python packages changed:

raiwidgets
responsibleai
erroranalysis
rai_core_flask

Tests

No new tests required.
New tests for the added feature are part of this PR.
I validated the changes manually.

Screenshots (if appropriate):

Documentation:

My change requires a change to the documentation.
I have updated the documentation accordingly.

codecov-commenter · 2022-02-10T03:06:16Z

Codecov Report

Merging #1214 (29a6886) into main (18d38dd) will increase coverage by 0.07%.
The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #1214      +/-   ##
==========================================
+ Coverage   67.12%   67.19%   +0.07%     
==========================================
  Files          91       91              
  Lines        4383     4393      +10     
==========================================
+ Hits         2942     2952      +10     
  Misses       1441     1441

Flag	Coverage Δ
unittests	`67.19% <100.00%> (+0.07%)`	⬆️

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

Impacted Files	Coverage Δ
...i/responsibleai/managers/counterfactual_manager.py	`94.19% <100.00%> (+0.03%)`	⬆️
...i/responsibleai/managers/error_analysis_manager.py	`89.88% <100.00%> (+0.11%)`	⬆️
...ibleai/responsibleai/managers/explainer_manager.py	`68.75% <100.00%> (+0.32%)`	⬆️
...leai/responsibleai/modelanalysis/model_analysis.py	`94.33% <100.00%> (+0.33%)`	⬆️
...sibleai/responsibleai/rai_insights/rai_insights.py	`77.87% <100.00%> (+0.06%)`	⬆️

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 18d38dd...29a6886. Read the comment docs.

responsibleai/responsibleai/managers/counterfactual_manager.py

responsibleai/responsibleai/managers/error_analysis_manager.py

responsibleai/responsibleai/managers/explainer_manager.py

responsibleai/responsibleai/modelanalysis/model_analysis.py

responsibleai/responsibleai/rai_insights/rai_insights.py

romanlutz · 2022-02-10T03:30:35Z

@gaugup if I'm understanding correctly you mean I should add type annotations for every arg, not just the optional ones. Is that correct?

github-actions · 2022-02-10T04:05:21Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-10T04:23:30Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

gaugup · 2022-02-10T04:46:36Z

@gaugup if I'm understanding correctly you mean I should add type annotations for every arg, not just the optional ones. Is that correct?

Type hints are for static checking of the code paths. So a variable being optional or not doesn't matter. We haven't enabled mypy in our builds otherwise you would see these unannotated function variables getting flagged.

romanlutz · 2022-02-10T13:20:31Z

@gaugup if I'm understanding correctly you mean I should add type annotations for every arg, not just the optional ones. Is that correct?

Type hints are for static checking of the code paths. So a variable being optional or not doesn't matter. We haven't enabled mypy in our builds otherwise you would see these unannotated function variables getting flagged.

@gaugup Is that a yes? :-)

…olbox into romanlutz/optional_api_docs

imatiach-msft · 2022-02-10T14:21:49Z

oh, yes, you can add type hints to all parameters, certainly not just the optionals ones. So it's a yes.

github-actions · 2022-02-10T14:50:46Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-10T14:52:19Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-10T14:57:32Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

…olbox into romanlutz/optional_api_docs

github-actions · 2022-02-10T21:29:42Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-10T22:50:41Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-11T01:05:25Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

github-actions · 2022-02-11T05:01:01Z

https://responsibleai.blob.core.windows.net/pullrequest/microsoft/responsible-ai-toolbox/romanlutz/optional_api_docs/dashboard/index.html

* add type annotations * fix imports * import ordering fix * more type annotations * add Any annotation for model

romanlutz added 2 commits February 9, 2022 21:58

add type annotations

5e25732

fix imports

6297434

romanlutz added the documentation Improvements or additions to documentation label Feb 10, 2022

romanlutz requested a review from riedgar-ms February 10, 2022 03:05

romanlutz requested review from gaugup, imatiach-msft, xuke444 and kicha0 as code owners February 10, 2022 03:05

romanlutz mentioned this pull request Feb 10, 2022

RFC add metadata_columns to RAIInsights #1207

Closed

18 tasks

imatiach-msft approved these changes Feb 10, 2022

View reviewed changes

gaugup requested changes Feb 10, 2022

View reviewed changes

import ordering fix

c5c8a0f

romanlutz added 3 commits February 10, 2022 09:00

more type annotations

ad6c21f

add Any annotation for model

a3e0fc2

Merge branch 'main' of https://github.com/microsoft/responsible-ai-to…

90e6022

…olbox into romanlutz/optional_api_docs

Merge branch 'main' of https://github.com/microsoft/responsible-ai-to…

2c41e91

…olbox into romanlutz/optional_api_docs

Merge branch 'main' into romanlutz/optional_api_docs

47a992c

Merge branch 'main' into romanlutz/optional_api_docs

7b8a6ae

gaugup approved these changes Feb 11, 2022

View reviewed changes

Merge branch 'main' into romanlutz/optional_api_docs

29a6886

romanlutz enabled auto-merge (squash) February 11, 2022 04:06

romanlutz merged commit 742cf99 into main Feb 11, 2022

romanlutz deleted the romanlutz/optional_api_docs branch February 11, 2022 05:20

gaugup pushed a commit that referenced this pull request Feb 27, 2022

DOC add type annotations to responsibleai package (#1214)

b0f024c

* add type annotations * fix imports * import ordering fix * more type annotations * add Any annotation for model

imatiach-msft mentioned this pull request Apr 19, 2022

release raiwidgets and responsibleai v0.18.0 #1360

Merged

19 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

DOC add type annotations to responsibleai package #1214

DOC add type annotations to responsibleai package #1214

romanlutz commented Feb 10, 2022

codecov-commenter commented Feb 10, 2022 •

edited

Loading

romanlutz commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

gaugup commented Feb 10, 2022

romanlutz commented Feb 10, 2022 •

edited

Loading

imatiach-msft commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 11, 2022

github-actions bot commented Feb 11, 2022

DOC add type annotations to responsibleai package #1214

DOC add type annotations to responsibleai package #1214

Conversation

romanlutz commented Feb 10, 2022

Description

Areas changed

Tests

Screenshots (if appropriate):

Documentation:

codecov-commenter commented Feb 10, 2022 • edited Loading

Codecov Report

romanlutz commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

gaugup commented Feb 10, 2022

romanlutz commented Feb 10, 2022 • edited Loading

imatiach-msft commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 10, 2022

github-actions bot commented Feb 11, 2022

github-actions bot commented Feb 11, 2022

codecov-commenter commented Feb 10, 2022 •

edited

Loading

romanlutz commented Feb 10, 2022 •

edited

Loading