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

docs: Introduce Responsible AI section on website (Interpretability + DataBalanceAnalysis) #1241

Merged
merged 25 commits into from Nov 6, 2021

Conversation

ms-kashyap
Copy link
Contributor

@ms-kashyap ms-kashyap commented Nov 4, 2021

I am making these changes for the "Next" section of the website. Did the following:

  • Renaming the "Model Interpretability" section on the website to "Responsible AI" for both Features and Examples
  • Additionally, moving Data Balance Analysis into this section
  • Generated "Interpretability - Explanation Dashboard" markdown from notebook which was added a couple days ago
  • Generated "DataBalanceAnalysis - Adult Census Income" markdown from notebook + pictures that it references

The "DataBalanceAnalysis - Adult Census Income" notebook in notebooks/ contains cell outputs (matplotlib figures), so I had to make some changes to notebookconvert.py to:

  • From the notebook, generate a markdown file with no spaces in the name
  • Generate the extra folder and files of cell outputs with no spaces in their names
  • Rename the markdown file to match original notebook name

Also note: In website/src/pages/index.js, I had to point to docs/next/features instead of docs/features because the folder structure changes are reflected in Next, not 0.9.1. I wonder if there is a better way for me to do this.

The Responsible AI section under Features and Examples will look like this:
image
image

@ms-kashyap ms-kashyap marked this pull request as draft November 4, 2021 03:15
@memoryz
Copy link
Contributor

memoryz commented Nov 4, 2021

Can we also do these two things:

  1. Move the Snow Leopard Detection notebook to Examples -> Responsible AI section.
  2. Rename Features -> Responsible AI -> "About" to "Model Interpretation on Spark"

@ms-kashyap ms-kashyap changed the title docs: Introduce Responsible AI section on website (ModelInterpretability + DataBalanceAnalysis) docs: Introduce Responsible AI section on website (Interpretability + DataBalanceAnalysis) Nov 4, 2021
@ms-kashyap ms-kashyap marked this pull request as ready for review November 4, 2021 18:40
@ms-kashyap
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@codecov-commenter
Copy link

codecov-commenter commented Nov 4, 2021

Codecov Report

Merging #1241 (3b3593b) into master (ba41290) will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1241   +/-   ##
=======================================
  Coverage   83.12%   83.12%           
=======================================
  Files         300      300           
  Lines       13699    13699           
  Branches      660      660           
=======================================
  Hits        11387    11387           
  Misses       2312     2312           

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 ba41290...3b3593b. Read the comment docs.

mhamilton723
mhamilton723 previously approved these changes Nov 4, 2021
website/notebookconvert.py Show resolved Hide resolved
website/notebookconvert.py Outdated Show resolved Hide resolved
website/src/plugins/examples/index.js Show resolved Hide resolved
@serena-ruan
Copy link
Contributor

Can we also do these two things:

  1. Move the Snow Leopard Detection notebook to Examples -> Responsible AI section.
  2. Rename Features -> Responsible AI -> "About" to "Model Interpretation on Spark"

Hi Jason, could we keep the Snow Leopard Detection in Features still? There should be one outstanding notebook examples inside each sub folders under features. Or do you prefer putting another one?

@serena-ruan
Copy link
Contributor

Can we also do these two things:

  1. Move the Snow Leopard Detection notebook to Examples -> Responsible AI section.
  2. Rename Features -> Responsible AI -> "About" to "Model Interpretation on Spark"

Hi Jason, could we keep the Snow Leopard Detection in Features still? There should be one outstanding notebook examples inside each sub folders under features. Or do you prefer putting another one?

@memoryz

@memoryz
Copy link
Contributor

memoryz commented Nov 5, 2021

Can we also do these two things:

  1. Move the Snow Leopard Detection notebook to Examples -> Responsible AI section.
  2. Rename Features -> Responsible AI -> "About" to "Model Interpretation on Spark"

Hi Jason, could we keep the Snow Leopard Detection in Features still? There should be one outstanding notebook examples inside each sub folders under features. Or do you prefer putting another one?

Hi @serena-ruan, the snow leopard detection notebook uses the deprecated API. If there should be one outstanding notebook example, can we replace it with "Interpretability - Image Explainers.ipynb" instead?

@serena-ruan
Copy link
Contributor

Can we also do these two things:

  1. Move the Snow Leopard Detection notebook to Examples -> Responsible AI section.
  2. Rename Features -> Responsible AI -> "About" to "Model Interpretation on Spark"

Hi Jason, could we keep the Snow Leopard Detection in Features still? There should be one outstanding notebook examples inside each sub folders under features. Or do you prefer putting another one?

Hi @serena-ruan, the snow leopard detection notebook uses the deprecated API. If there should be one outstanding notebook example, can we replace it with "Interpretability - Image Explainers.ipynb" instead?

Sure! Thanks for the comment. @ms-kashyap Kashyap could you pls change it?

…ad of inline, use Interpretability-Image Explainers as outstanding notebook in features/responsible_ai/
@ms-kashyap
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

…ity-Image Explainers as outstanding Responsible AI notebook
@ms-kashyap
Copy link
Contributor Author

/azp run

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@memoryz
Copy link
Contributor

memoryz commented Nov 5, 2021

Thank you @ms-kashyap

Copy link
Contributor

@serena-ruan serena-ruan 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 changes! Looks perfect!

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.

None yet

6 participants